Package com.google.api.client.auth.oauth2
package com.google.api.client.auth.oauth2
Implementation of the OAuth 2.0 Authorization
Framework.
Before using this library, you will typically need to register your application with the authorization server to receive a client ID and client secret. See Client Registration.
These are the typical steps of the web server flow based on an authorization code, as specified in Authorization Code Grant:
- Redirect the end user in the browser to the authorization page using
AuthorizationCodeRequestUrl
to grant your application access to the end user's protected data. - Process the authorization response using
AuthorizationCodeResponseUrl
to parse the authorization code. - Request an access token and possibly a refresh token using
AuthorizationCodeTokenRequest
. - Access protected resources using
Credential
. Expired access tokens will automatically be refreshed using the refresh token (if applicable).
These are the typical steps of the the browser-based client flow specified in Implicit Grant:
- Redirect the end user in the browser to the authorization page using
BrowserClientRequestUrl
to grant your browser application access to the end user's protected data. - Use a JavaScript application to process the access token found in the URL fragment at the redirect URI registered with the authorization server.
- Since:
- 1.7
-
ClassDescriptionThread-safe OAuth 2.0 authorization code flow that manages and persists end-user credentials.Authorization code flow builder.Listener for a created credential after a successful token response in
AuthorizationCodeFlow.createAndStoreCredential(com.google.api.client.auth.oauth2.TokenResponse, java.lang.String)
.OAuth 2.0 URL builder for an authorization web page to allow the end user to authorize the application to access their protected resources and that returns an authorization code, as specified in Authorization Code Grant.OAuth 2.0 URL parser for the redirect URL after end user grants or denies authorization as specified in Authorization Response.OAuth 2.0 request for an access token using an authorization code as specified in Access Token Request.OAuth 2.0 URL builder for an authorization web page to allow the end user to authorize the application to access their protected resources, as specified in Authorization Endpoint.OAuth 2.0 helper for accessing protected resources using the Bearer Token specification.Immutable and thread-safe OAuth 2.0 method for accessing protected resources using the Authorization Request Header Field.Immutable and thread-safe OAuth 2.0 method for accessing protected resources using the Form-Encoded Body Parameter.Immutable and thread-safe OAuth 2.0 method for accessing protected resources using the URI Query Parameter.OAuth 2.0 URL builder for an authorization web page to allow the end user to authorize the application to access their protected resources and that returns the access token to a browser client using a scripting language such as JavaScript, as specified in Implicit Grant.OAuth 2.0 request for an access token using only its client credentials as specified in Client Credentials Grant.Client credentials specified as URL-encoded parameters in the HTTP request body as specified in Client PasswordThread-safe OAuth 2.0 helper for accessing protected resources using an access token, as well as optionally refreshing the access token when it expires using a refresh token.Method of presenting the access token to the resource server as specified in Accessing Protected Resources.Credential builder.Listener for refresh token results.Deprecated.Deprecated.(to be removed in the future) UseDataStoreCredentialRefreshListener
instead.Beta
Thread-safe OAuth 2.0 credential refresh listener that stores the refresh token response in the credential data store.OAuth 2.0 request for an access token using the user's username and password as specified in Resource Owner Password Credentials Grant.OAuth 2.0 request to refresh an access token using a refresh token as specified in Refreshing an Access Token.Beta
Credential information to be stored in aDataStoreFactory
.OAuth 2.0 parser for an error access token response as specified in Error Response.OAuth 2.0 request for an access token as specified in Obtaining Authorization.OAuth 2.0 JSON model for a successful access token response as specified in Successful Response.Exception thrown when receiving an error response from the token server as specified in Error Response
DataStoreFactory
withStoredCredential
instead.