Class Identity.Builder

  • Enclosing class:
    Identity

    public static class Identity.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • principalName

        public Identity.Builder principalName​(String principalName)
        The name of the user or service.

        This value is the friendly name associated with principalId.

        Example: ExampleName

        Parameters:
        principalName - the value to set
        Returns:
        this builder
      • principalId

        public Identity.Builder principalId​(String principalId)
        The OCID of the principal.
        Parameters:
        principalId - the value to set
        Returns:
        this builder
      • authType

        public Identity.Builder authType​(String authType)
        The type of authentication used.

        Example: natv

        Parameters:
        authType - the value to set
        Returns:
        this builder
      • callerName

        public Identity.Builder callerName​(String callerName)
        The name of the user or service.

        This value is the friendly name associated with callerId.

        Parameters:
        callerName - the value to set
        Returns:
        this builder
      • callerId

        public Identity.Builder callerId​(String callerId)
        The OCID of the caller.

        The caller that made a request on behalf of the prinicpal.

        Parameters:
        callerId - the value to set
        Returns:
        this builder
      • tenantId

        public Identity.Builder tenantId​(String tenantId)
        The OCID of the tenant.
        Parameters:
        tenantId - the value to set
        Returns:
        this builder
      • ipAddress

        public Identity.Builder ipAddress​(String ipAddress)
        The IP address of the source of the request.

        Example: 172.24.80.88

        Parameters:
        ipAddress - the value to set
        Returns:
        this builder
      • credentials

        public Identity.Builder credentials​(String credentials)
        The credential ID of the user.

        This value is extracted from the HTTP ‘Authorization’ request header. It consists of the tenantId, userId, and user fingerprint, all delimited by a slash (/).

        Parameters:
        credentials - the value to set
        Returns:
        this builder
      • userAgent

        public Identity.Builder userAgent​(String userAgent)
        The user agent of the client that made the request.

        Example: Jersey/2.23 (HttpUrlConnection 1.8.0_212)

        Parameters:
        userAgent - the value to set
        Returns:
        this builder
      • consoleSessionId

        public Identity.Builder consoleSessionId​(String consoleSessionId)
        This value identifies any Console session associated with this request.
        Parameters:
        consoleSessionId - the value to set
        Returns:
        this builder