Interface CreateOAuth2TokenRequestBody.Builder

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

  • Method Details

    • clientId

      CreateOAuth2TokenRequestBody.Builder clientId(String clientId)

      The client identifier (ARN) used during Sign-In onboarding Required for both authorization code and refresh token flows

      Parameters:
      clientId - The client identifier (ARN) used during Sign-In onboarding Required for both authorization code and refresh token flows
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • grantType

      CreateOAuth2TokenRequestBody.Builder grantType(String grantType)

      OAuth 2.0 grant type - determines which flow is used Must be "authorization_code" or "refresh_token"

      Parameters:
      grantType - OAuth 2.0 grant type - determines which flow is used Must be "authorization_code" or "refresh_token"
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • code

      CreateOAuth2TokenRequestBody.Builder code(String code)

      The authorization code received from /v1/authorize Required only when grant_type=authorization_code

      Parameters:
      code - The authorization code received from /v1/authorize Required only when grant_type=authorization_code
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • redirectUri

      CreateOAuth2TokenRequestBody.Builder redirectUri(String redirectUri)

      The redirect URI that must match the original authorization request Required only when grant_type=authorization_code

      Parameters:
      redirectUri - The redirect URI that must match the original authorization request Required only when grant_type=authorization_code
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • codeVerifier

      CreateOAuth2TokenRequestBody.Builder codeVerifier(String codeVerifier)

      PKCE code verifier to prove possession of the original code challenge Required only when grant_type=authorization_code

      Parameters:
      codeVerifier - PKCE code verifier to prove possession of the original code challenge Required only when grant_type=authorization_code
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • refreshToken

      CreateOAuth2TokenRequestBody.Builder refreshToken(String refreshToken)

      The refresh token returned from auth_code redemption Required only when grant_type=refresh_token

      Parameters:
      refreshToken - The refresh token returned from auth_code redemption Required only when grant_type=refresh_token
      Returns:
      Returns a reference to this object so that method calls can be chained together.