Interface RegisterOidcConfigRequest.Builder

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

  • Method Details

    • networkId

      RegisterOidcConfigRequest.Builder networkId(String networkId)

      The ID of the Wickr network for which OIDC will be configured.

      Parameters:
      networkId - The ID of the Wickr network for which OIDC will be configured.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • companyId

      RegisterOidcConfigRequest.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.

    • customUsername

      RegisterOidcConfigRequest.Builder customUsername(String customUsername)

      A custom field mapping to extract the username from the OIDC token (optional).

      The customUsername is only required if you use something other than email as the username field.

      Parameters:
      customUsername - A custom field mapping to extract the username from the OIDC token (optional).

      The customUsername is only required if you use something other than email as the username field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • extraAuthParams

      RegisterOidcConfigRequest.Builder extraAuthParams(String extraAuthParams)

      Additional authentication parameters to include in the OIDC flow (optional).

      Parameters:
      extraAuthParams - Additional authentication parameters to include in the OIDC flow (optional).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • issuer

      RegisterOidcConfigRequest.Builder issuer(String issuer)

      The issuer URL of the OIDC provider (e.g., 'https://login.example.com').

      Parameters:
      issuer - The issuer URL of the OIDC provider (e.g., 'https://login.example.com').
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      RegisterOidcConfigRequest.Builder scopes(String scopes)

      The OAuth scopes to request from the OIDC provider (e.g., 'openid profile email').

      Parameters:
      scopes - The OAuth scopes to request from the OIDC provider (e.g., 'openid profile email').
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secret

      RegisterOidcConfigRequest.Builder secret(String secret)

      The client secret for authenticating with the OIDC provider (optional).

      Parameters:
      secret - The client secret for authenticating with the OIDC provider (optional).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ssoTokenBufferMinutes

      RegisterOidcConfigRequest.Builder ssoTokenBufferMinutes(Integer ssoTokenBufferMinutes)

      The buffer time in minutes before the SSO token expires to refresh it (optional).

      Parameters:
      ssoTokenBufferMinutes - The buffer time in minutes before the SSO token expires to refresh it (optional).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      RegisterOidcConfigRequest.Builder userId(String userId)

      Unique identifier provided by your identity provider to authenticate the access request. Also referred to as clientID.

      Parameters:
      userId - Unique identifier provided by your identity provider to authenticate the access request. Also referred to as clientID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      RegisterOidcConfigRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      RegisterOidcConfigRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.