Interface OidcTokenInfo.Builder

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

  • Method Details

    • codeVerifier

      OidcTokenInfo.Builder codeVerifier(String codeVerifier)

      The PKCE (Proof Key for Code Exchange) code verifier, a cryptographically random string used to enhance security in the OAuth flow.

      Parameters:
      codeVerifier - The PKCE (Proof Key for Code Exchange) code verifier, a cryptographically random string used to enhance security in the OAuth flow.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • codeChallenge

      OidcTokenInfo.Builder codeChallenge(String codeChallenge)

      The PKCE code challenge, a transformed version of the code verifier sent during the authorization request for verification.

      Parameters:
      codeChallenge - The PKCE code challenge, a transformed version of the code verifier sent during the authorization request for verification.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessToken

      OidcTokenInfo.Builder accessToken(String accessToken)

      The OAuth access token that can be used to access protected resources on behalf of the authenticated user.

      Parameters:
      accessToken - The OAuth access token that can be used to access protected resources on behalf of the authenticated user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idToken

      OidcTokenInfo.Builder idToken(String idToken)

      The OpenID Connect ID token containing user identity information and authentication context as a signed JWT.

      Parameters:
      idToken - The OpenID Connect ID token containing user identity information and authentication context as a signed JWT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • refreshToken

      OidcTokenInfo.Builder refreshToken(String refreshToken)

      The OAuth refresh token that can be used to obtain new access tokens without requiring the user to re-authenticate.

      Parameters:
      refreshToken - The OAuth refresh token that can be used to obtain new access tokens without requiring the user to re-authenticate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tokenType

      OidcTokenInfo.Builder tokenType(String tokenType)

      The type of access token issued, typically 'Bearer', which indicates how the token should be used in API requests.

      Parameters:
      tokenType - The type of access token issued, typically 'Bearer', which indicates how the token should be used in API requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expiresIn

      OidcTokenInfo.Builder expiresIn(Long expiresIn)

      The lifetime of the access token in seconds, indicating when the token will expire and need to be refreshed.

      Parameters:
      expiresIn - The lifetime of the access token in seconds, indicating when the token will expire and need to be refreshed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.