Class UserAuthorizer.TokenResponseWithConfig

java.lang.Object
com.google.auth.oauth2.UserAuthorizer.TokenResponseWithConfig
Enclosing class:
UserAuthorizer
public static class UserAuthorizer.TokenResponseWithConfig extends Object
Represents the response from an OAuth token exchange, including configuration details used to initiate the flow.

This response can be used to initialize the following credentials types: 

// UserCredentials when Google is the identity provider:
UserCredentials userCredentials = UserCredentials.newBuilder()
    .setHttpTransportFactory(tokenResponseWithConfig.getHttpTransportFactory())
    .setClientId(tokenResponseWithConfig.getClientId())
    .setClientSecret(tokenResponseWithConfig.getClientSecret())
    .setAccessToken(tokenResponseWithConfig.getAccessToken())
    .setRefreshToken(tokenResponseWithConfig.getRefreshToken())
    .setTokenServerUri(tokenResponseWithConfig.getTokenServerUri())
    .build();

// ExternalAccountAuthorizedUserCredentials when using Workforce Identity Federation:
ExternalAccountAuthorizedUserCredentials externalAccountAuthorizedUserCredentials =
    ExternalAccountAuthorizedUserCredentials.newBuilder()
        .setHttpTransportFactory(tokenResponseWithConfig.getHttpTransportFactory())
        .setClientId(tokenResponseWithConfig.getClientId())
        .setClientSecret(tokenResponseWithConfig.getClientSecret())
        .setAccessToken(tokenResponseWithConfig.getAccessToken())
        .setRefreshToken(tokenResponseWithConfig.getRefreshToken())
        .setTokenUrl(tokenResponseWithConfig.getTokenServerUri().toURL().toString())
        .build();

  • Field Details

    • clientId

      private final String clientId

    • clientSecret

      private final String clientSecret

    • refreshToken

      private final String refreshToken

    • accessToken

      private final AccessToken accessToken

    • tokenServerUri

      private URI tokenServerUri

    • httpTransportFactory

      private final HttpTransportFactory httpTransportFactory

  • Constructor Details

  • Method Details

    • getClientId

      public String getClientId()
      Returns the OAuth 2.0 client ID used.
      Returns:
      The client ID.

    • getClientSecret

      public String getClientSecret()
      Returns the OAuth 2.0 client secret used.
      Returns:
      The client secret.

    • getAccessToken

      public AccessToken getAccessToken()
      Returns the access token obtained from the token exchange.
      Returns:
      The access token.

    • getHttpTransportFactory

      public HttpTransportFactory getHttpTransportFactory()
      Returns the HTTP transport factory used.
      Returns:
      The HTTP transport factory.

    • getTokenServerUri

      public URI getTokenServerUri()
      Returns the URI of the token server used.
      Returns:
      The token server URI.

    • getRefreshToken

      @Nullable public String getRefreshToken()
      Returns the refresh token obtained from the token exchange, if available.
      Returns:
      The refresh token, or null if not granted.

    • newBuilder

      static UserAuthorizer.TokenResponseWithConfig.Builder newBuilder()