Interface OidcConfigInfo.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OidcConfigInfo.Builder,OidcConfigInfo>, SdkBuilder<OidcConfigInfo.Builder,OidcConfigInfo>, SdkPojo
Enclosing class:
OidcConfigInfo
@Mutable @NotThreadSafe public static interface OidcConfigInfo.Builder extends SdkPojo, CopyableBuilder<OidcConfigInfo.Builder,OidcConfigInfo>

  • Method Details

    • applicationName

      OidcConfigInfo.Builder applicationName(String applicationName)

      The name of the OIDC application as registered with the identity provider.

      Parameters:
      applicationName - The name of the OIDC application as registered with the identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientId

      OidcConfigInfo.Builder clientId(String clientId)

      The OAuth client ID assigned by the identity provider for authentication requests.

      Parameters:
      clientId - The OAuth client ID assigned by the identity provider for authentication requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • companyId

      OidcConfigInfo.Builder companyId(String companyId)

      Custom identifier your end users will use to sign in with SSO.

      Parameters:
      companyId - Custom identifier your end users will use to sign in with SSO.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      OidcConfigInfo.Builder scopes(String scopes)

      The OAuth scopes requested from the identity provider, which determine what user information is accessible (e.g., 'openid profile email').

      Parameters:
      scopes - The OAuth scopes requested from the identity provider, which determine what user information is accessible (e.g., 'openid profile email').
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • issuer

      OidcConfigInfo.Builder issuer(String issuer)

      The issuer URL of the identity provider, which serves as the base URL for OIDC endpoints and configuration discovery.

      Parameters:
      issuer - The issuer URL of the identity provider, which serves as the base URL for OIDC endpoints and configuration discovery.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientSecret

      OidcConfigInfo.Builder clientSecret(String clientSecret)

      The OAuth client secret used to authenticate the application with the identity provider.

      Parameters:
      clientSecret - The OAuth client secret used to authenticate the application with the identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secret

      OidcConfigInfo.Builder secret(String secret)

      An additional secret credential used by the identity provider for authentication.

      Parameters:
      secret - An additional secret credential used by the identity provider for authentication.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • redirectUrl

      OidcConfigInfo.Builder redirectUrl(String redirectUrl)

      The callback URL where the identity provider redirects users after successful authentication. This URL must be registered with the identity provider.

      Parameters:
      redirectUrl - The callback URL where the identity provider redirects users after successful authentication. This URL must be registered with the identity provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      OidcConfigInfo.Builder userId(String userId)

      The claim field from the OIDC token to use as the unique user identifier (e.g., 'email', 'sub', or a custom claim).

      Parameters:
      userId - The claim field from the OIDC token to use as the unique user identifier (e.g., 'email', 'sub', or a custom claim).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customUsername

      OidcConfigInfo.Builder customUsername(String customUsername)

      A custom field mapping to extract the username from the OIDC token when the standard username claim is insufficient.

      Parameters:
      customUsername - A custom field mapping to extract the username from the OIDC token when the standard username claim is insufficient.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • caCertificate

      OidcConfigInfo.Builder caCertificate(String caCertificate)

      The X.509 CA certificate for validating SSL/TLS connections to the identity provider when using self-signed or enterprise certificates.

      Parameters:
      caCertificate - The X.509 CA certificate for validating SSL/TLS connections to the identity provider when using self-signed or enterprise certificates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applicationId

      OidcConfigInfo.Builder applicationId(Integer applicationId)

      The unique identifier for the registered OIDC application. Valid range is 1-10.

      Parameters:
      applicationId - The unique identifier for the registered OIDC application. Valid range is 1-10.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ssoTokenBufferMinutes

      OidcConfigInfo.Builder ssoTokenBufferMinutes(Integer ssoTokenBufferMinutes)

      The grace period in minutes before the SSO token expires when the system should proactively refresh the token to maintain seamless user access.

      Parameters:
      ssoTokenBufferMinutes - The grace period in minutes before the SSO token expires when the system should proactively refresh the token to maintain seamless user access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • extraAuthParams

      OidcConfigInfo.Builder extraAuthParams(String extraAuthParams)

      Additional authentication parameters to include in the OIDC authorization request as a query string. Useful for provider-specific extensions.

      Parameters:
      extraAuthParams - Additional authentication parameters to include in the OIDC authorization request as a query string. Useful for provider-specific extensions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.