Skip navigation links
A B C D E F G H I J M N O P R S T U 

A

ACCESS_DENIED - Static variable in class net.openid.appauth.AuthorizationException.AuthorizationRequestErrors
An access_denied OAuth2 error response.
accessToken - Variable in class net.openid.appauth.AuthorizationResponse
The access token retrieved as part of the authorization flow.
accessToken - Variable in class net.openid.appauth.TokenResponse
The access token, if provided.
accessTokenExpirationTime - Variable in class net.openid.appauth.AuthorizationResponse
The approximate expiration time of the access token, as milliseconds from the UNIX epoch.
accessTokenExpirationTime - Variable in class net.openid.appauth.TokenResponse
The expiration time of the access token, if provided.
additionalParameters - Variable in class net.openid.appauth.AuthorizationRequest
Additional parameters to be passed as part of the request.
additionalParameters - Variable in class net.openid.appauth.AuthorizationResponse
The additional, non-standard parameters in the response.
additionalParameters - Variable in class net.openid.appauth.TokenRequest
Additional parameters to be passed as part of the request.
additionalParameters - Variable in class net.openid.appauth.TokenResponse
Additional, non-standard parameters in the response.
authorizationCode - Variable in class net.openid.appauth.AuthorizationResponse
The authorization code generated by the authorization server.
authorizationCode - Variable in class net.openid.appauth.TokenRequest
An authorization code to be exchanged for one or more tokens.
authorizationEndpoint - Variable in class net.openid.appauth.AuthorizationServiceConfiguration
The authorization service's endpoint.
AuthorizationException - Exception in net.openid.appauth
Returned as a response to OAuth2 requests if they fail.
AuthorizationException(int, int, String, String, Uri, Throwable) - Constructor for exception net.openid.appauth.AuthorizationException
Instantiates an authorization request with optional root cause information.
AuthorizationException.AuthorizationRequestErrors - Class in net.openid.appauth
Error codes related to failed authorization requests.
AuthorizationException.GeneralErrors - Class in net.openid.appauth
Error codes specific to AppAuth for Android, rather than those defined in the OAuth2 and OpenID specifications.
AuthorizationException.TokenRequestErrors - Class in net.openid.appauth
Error codes related to failed token requests.
AuthorizationRequest - Class in net.openid.appauth
An OAuth2 authorization request.
AuthorizationRequest.Builder - Class in net.openid.appauth
Creates instances of AuthorizationRequest.
AuthorizationRequestErrors() - Constructor for class net.openid.appauth.AuthorizationException.AuthorizationRequestErrors
 
AuthorizationResponse - Class in net.openid.appauth
A response to an authorization request.
AuthorizationResponse.Builder - Class in net.openid.appauth
Creates instances of AuthorizationResponse.
AuthorizationService - Class in net.openid.appauth
Dispatches requests to an OAuth2 authorization service.
AuthorizationService(Context) - Constructor for class net.openid.appauth.AuthorizationService
Creates an AuthorizationService instance based on the provided configuration.
AuthorizationService.TokenResponseCallback - Interface in net.openid.appauth
Callback interface for token endpoint requests.
AuthorizationServiceConfiguration - Class in net.openid.appauth
Configuration details required to interact with an authorization service.
AuthorizationServiceConfiguration(Uri, Uri) - Constructor for class net.openid.appauth.AuthorizationServiceConfiguration
Creates a service configuration for a basic OAuth2 provider.
AuthorizationServiceConfiguration(AuthorizationServiceDiscovery) - Constructor for class net.openid.appauth.AuthorizationServiceConfiguration
Creates an service configuration for an OpenID Connect provider, based on its discovery document.
AuthorizationServiceConfiguration.RetrieveConfigurationCallback - Interface in net.openid.appauth
Callback interface for configuration retrieval.
AuthorizationServiceDiscovery - Class in net.openid.appauth
An OpenID Connect 1.0 Discovery Document.
AuthorizationServiceDiscovery(JSONObject) - Constructor for class net.openid.appauth.AuthorizationServiceDiscovery
Extracts a discovery document from its standard JSON representation.
AuthorizationServiceDiscovery.MissingArgumentException - Exception in net.openid.appauth
Thrown when a mandatory property is missing from the discovery document.
AuthState - Class in net.openid.appauth
Collects authorization state from authorization requests and responses.
AuthState() - Constructor for class net.openid.appauth.AuthState
Creates an empty, unauthenticated AuthState.
AuthState(AuthorizationResponse, Exception) - Constructor for class net.openid.appauth.AuthState
Creates an AuthState based on an authorization exchange.
AuthState(AuthorizationResponse, TokenResponse) - Constructor for class net.openid.appauth.AuthState
Creates an AuthState based on an authorization exchange and subsequent token exchange.
AuthState.AuthStateAction - Interface in net.openid.appauth
Interface for actions executed in the context of fresh (non-expired) tokens.

B

build() - Method in class net.openid.appauth.AuthorizationRequest.Builder
Constructs the authorization request.
build() - Method in class net.openid.appauth.AuthorizationResponse.Builder
Builds the Authorization object.
build() - Method in class net.openid.appauth.TokenRequest.Builder
Produces a TokenRequest instance, if all necessary values have been provided.
build() - Method in class net.openid.appauth.TokenResponse.Builder
Creates the token response instance.
Builder(AuthorizationServiceConfiguration, String, String, Uri) - Constructor for class net.openid.appauth.AuthorizationRequest.Builder
Creates an authorization request builder with the specified mandatory properties.
Builder(AuthorizationRequest) - Constructor for class net.openid.appauth.AuthorizationResponse.Builder
Creates an authorization builder with the specified mandatory properties.
Builder(AuthorizationServiceConfiguration, String) - Constructor for class net.openid.appauth.TokenRequest.Builder
Creates a token request builder with the specified mandatory properties.
Builder(TokenRequest) - Constructor for class net.openid.appauth.TokenResponse.Builder
Creates a token response associated with the specified request.
byString(String) - Static method in class net.openid.appauth.AuthorizationException.AuthorizationRequestErrors
Returns the matching exception type for the provided OAuth2 error string, or AuthorizationException.AuthorizationRequestErrors.OTHER if unknown.
byString(String) - Static method in class net.openid.appauth.AuthorizationException.TokenRequestErrors
Returns the matching exception type for the provided OAuth2 error string, or AuthorizationException.TokenRequestErrors.OTHER if unknown.

C

checkCodeVerifier(String) - Static method in class net.openid.appauth.CodeVerifierUtil
Throws an IllegalArgumentException if the provided code verifier is invalid, as defined by the PKCE specification (Section 4.1).
CLIENT_ERROR - Static variable in class net.openid.appauth.AuthorizationException.AuthorizationRequestErrors
An authorization error occurring on the client rather than the server.
CLIENT_ERROR - Static variable in class net.openid.appauth.AuthorizationException.TokenRequestErrors
An authorization error occurring on the client rather than the server.
clientId - Variable in class net.openid.appauth.AuthorizationRequest
The client identifier.
clientId - Variable in class net.openid.appauth.TokenRequest
The client identifier.
code - Variable in exception net.openid.appauth.AuthorizationException
The error code describing the class of problem encountered from the set defined in this class.
CODE_CHALLENGE_METHOD_PLAIN - Static variable in class net.openid.appauth.AuthorizationRequest
Plain-text code verifier challenge method.
CODE_CHALLENGE_METHOD_S256 - Static variable in class net.openid.appauth.AuthorizationRequest
SHA-256 based code verifier challenge method.
codeVerifier - Variable in class net.openid.appauth.AuthorizationRequest
The proof key for code exchange.
codeVerifier - Variable in class net.openid.appauth.TokenRequest
The code verifier that was used to generate the challenge in the original authorization request, if one was used.
codeVerifierChallenge - Variable in class net.openid.appauth.AuthorizationRequest
The challenge derived from the code verifier, using the challenge method.
codeVerifierChallengeMethod - Variable in class net.openid.appauth.AuthorizationRequest
The challenge method used to generate a challenge from the code verifier.
CodeVerifierUtil - Class in net.openid.appauth
Generates code verifiers and challenges for PKCE exchange.
configuration - Variable in class net.openid.appauth.AuthorizationRequest
The service's configuration.
configuration - Variable in class net.openid.appauth.TokenRequest
The service's configuration.
createCustomTabsIntentBuilder() - Method in class net.openid.appauth.AuthorizationService
Creates a custom tab builder, that will use a tab session from an existing connection to a web browser, if available.
createTokenExchangeRequest() - Method in class net.openid.appauth.AuthorizationResponse
Creates a follow-up request to exchange a received authorization code for tokens.
createTokenExchangeRequest(Map<String, String>) - Method in class net.openid.appauth.AuthorizationResponse
Creates a follow-up request to exchange a received authorization code for tokens, including the provided additional parameters.
createTokenRefreshRequest() - Method in class net.openid.appauth.AuthState
Creates a token request for new tokens using the current refresh token.
createTokenRefreshRequest(Map<String, String>) - Method in class net.openid.appauth.AuthState
Creates a token request for new tokens using the current refresh token, adding the specified additional parameters.

D

DEFAULT_CODE_VERIFIER_ENTROPY - Static variable in class net.openid.appauth.CodeVerifierUtil
The default entropy (in bytes) used for the code verifier.
deriveCodeVerifierChallenge(String) - Static method in class net.openid.appauth.CodeVerifierUtil
Produces a challenge from a code verifier, using SHA-256 as the challenge method if the system supports it (all Android devices should support SHA-256), and falls back to the "plain" challenge type if unavailable.
discoveryDoc - Variable in class net.openid.appauth.AuthorizationServiceConfiguration
The discovery document describing the service, if it is an OpenID Connect provider.
dispose() - Method in class net.openid.appauth.AuthorizationService
Disposes state that will not normally be handled by garbage collection.
docJson - Variable in class net.openid.appauth.AuthorizationServiceDiscovery
The JSON representation of the discovery document.

E

equals(Object) - Method in exception net.openid.appauth.AuthorizationException
Exceptions are considered to be equal if their type and code are the same; all other properties are irrelevant for comparison.
error - Variable in exception net.openid.appauth.AuthorizationException
The error string as it is found in the OAuth2 protocol.
errorDescription - Variable in exception net.openid.appauth.AuthorizationException
The human readable error message associated with this exception, if available.
errorUri - Variable in exception net.openid.appauth.AuthorizationException
A URI identifying a human-readable web page with information about this error.
execute(String, String, AuthorizationException) - Method in interface net.openid.appauth.AuthState.AuthStateAction
Executed in the context of fresh (non-expired) tokens.
EXPIRY_TIME_TOLERANCE_MS - Static variable in class net.openid.appauth.AuthState
Tokens which have less time than this value left before expiry will be considered to be expired for the purposes of calls to performActionWithFreshTokens.
EXTRA_EXCEPTION - Static variable in exception net.openid.appauth.AuthorizationException
The extra string that used to store an AuthorizationException in an intent by AuthorizationException.toIntent().
EXTRA_RESPONSE - Static variable in class net.openid.appauth.AuthorizationResponse
The extra string used to store an AuthorizationResponse in an intent by AuthorizationResponse.toIntent().

F

fetchFromIssuer(Uri, AuthorizationServiceConfiguration.RetrieveConfigurationCallback) - Static method in class net.openid.appauth.AuthorizationServiceConfiguration
Fetch an AuthorizationServiceConfiguration from an OpenID Connect issuer URI.
fetchFromUrl(Uri, AuthorizationServiceConfiguration.RetrieveConfigurationCallback) - Static method in class net.openid.appauth.AuthorizationServiceConfiguration
Fetch a AuthorizationServiceConfiguration from an OpenID Connect discovery URI.
fromIntent(Intent) - Static method in exception net.openid.appauth.AuthorizationException
Extracts an AuthorizationException from an intent produced by AuthorizationException.toIntent().
fromIntent(Intent) - Static method in class net.openid.appauth.AuthorizationResponse
Extracts an authorization response from an intent produced by AuthorizationResponse.toIntent().
fromJson(String) - Static method in exception net.openid.appauth.AuthorizationException
Reconstructs an AuthorizationException from the JSON produced by AuthorizationException.toJsonString().
fromJson(JSONObject) - Static method in exception net.openid.appauth.AuthorizationException
Reconstructs an AuthorizationException from the JSON produced by AuthorizationException.toJson().
fromJson(String) - Static method in class net.openid.appauth.AuthorizationRequest
Reads an Authorization request from a JSON string representation produced by AuthorizationRequest.toJsonString().
fromJson(JSONObject) - Static method in class net.openid.appauth.AuthorizationRequest
Reads an Authorization request from a JSON representation produced by AuthorizationRequest.toJson().
fromJson(String) - Static method in class net.openid.appauth.AuthorizationResponse
Reads an authorization response from a JSON string representation produced by AuthorizationResponse.toJsonString().
fromJson(JSONObject) - Static method in class net.openid.appauth.AuthorizationResponse
Reads an authorization response from a JSON object representation produced by AuthorizationResponse.toJson().
fromJson(JSONObject) - Static method in class net.openid.appauth.AuthorizationServiceConfiguration
Reads an Authorization service configuration from a JSON representation produced by the AuthorizationServiceConfiguration.toJson() method or some other equivalent producer.
fromJson(String) - Static method in class net.openid.appauth.AuthorizationServiceConfiguration
Reads an Authorization service configuration from a JSON representation produced by the AuthorizationServiceConfiguration.toJson() method or some other equivalent producer.
fromJson(JSONObject) - Static method in class net.openid.appauth.AuthState
Restores authorization state from JSON produced by AuthState.toJson().
fromJson(String) - Static method in class net.openid.appauth.AuthState
Restored authorization state from a JSON string produced by AuthState.toJsonString().
fromJson(String) - Static method in class net.openid.appauth.TokenRequest
Reads a token request from a JSON string representation produced by the TokenRequest.toJson() method or some other equivalent producer.
fromJson(JSONObject) - Static method in class net.openid.appauth.TokenRequest
Reads a token request from a JSON representation produced by the TokenRequest.toJson() method or some other equivalent producer.
fromJson(String) - Static method in class net.openid.appauth.TokenResponse
Reads a token response from a JSON string produced by TokenResponse.toJsonString().
fromJson(JSONObject) - Static method in class net.openid.appauth.TokenResponse
Reads a token response from a JSON string produced by TokenResponse.toJson().
fromJson(TokenRequest, String) - Static method in class net.openid.appauth.TokenResponse
Reads a token response from a JSON string, and associates it with the provided request.
fromJson(TokenRequest, JSONObject) - Static method in class net.openid.appauth.TokenResponse
Reads a token response from a JSON string, and associates it with the provided request.

G

GeneralErrors() - Constructor for class net.openid.appauth.AuthorizationException.GeneralErrors
 
generateRandomCodeVerifier() - Static method in class net.openid.appauth.CodeVerifierUtil
Generates a random code verifier string using SecureRandom as the source of entropy, with the default entropy quantity as defined by CodeVerifierUtil.DEFAULT_CODE_VERIFIER_ENTROPY.
generateRandomCodeVerifier(SecureRandom, int) - Static method in class net.openid.appauth.CodeVerifierUtil
Generates a random code verifier string using the provided entropy source and the specified number of bytes of entropy.
getAccessToken() - Method in class net.openid.appauth.AuthState
The current access token, if available.
getAccessTokenExpirationTime() - Method in class net.openid.appauth.AuthState
The expiration time of the current access token (if available), as milliseconds from the UNIX epoch (consistent with System.currentTimeMillis()).
getAcrValuesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The authentication context class references supported.
getAuthorizationEndpoint() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The OAuth 2 authorization endpoint URI.
getAuthorizationServiceConfiguration() - Method in class net.openid.appauth.AuthState
The configuration of the authorization service associated with this authorization state.
getClaimsLocalesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
Languages and scripts supported for values in claims being returned.
getClaimsSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The claim names of the claims that the provider may be able to supply values for.
getClaimTypesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The claim types supported.
getCodeVerifierChallengeMethod() - Static method in class net.openid.appauth.CodeVerifierUtil
Returns the challenge method utilized on this system: typically SHA-256 if supported by the system, plain otherwise.
getDisplayValuesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The display parameter values supported.
getGrantTypesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The OAuth 2 grant_type values supported.
getIdToken() - Method in class net.openid.appauth.AuthState
The current ID token, if available.
getIdTokenEncryptionAlgorithmValuesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The JWE encryption algorithms (alg values) supported for encoding ID token claims.
getIdTokenEncryptionEncodingValuesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The JWE encryption encodings (enc values) supported for encoding ID token claims.
getIdTokenSigningAlgorithmValuesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The JWS signing algorithms (alg values) supported for encoding ID token claims.
getIssuer() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The asserted issuer identifier.
getJwksUri() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The JSON web key set document URI.
getLastAuthorizationResponse() - Method in class net.openid.appauth.AuthState
The most recent authorization response used to update the authorization state.
getLastTokenResponse() - Method in class net.openid.appauth.AuthState
The most recent token response used to update this authorization state.
getMissingField() - Method in exception net.openid.appauth.AuthorizationServiceDiscovery.MissingArgumentException
 
getNeedsTokenRefresh() - Method in class net.openid.appauth.AuthState
Determines whether the access token is considered to have expired.
getOpPolicyUri() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
A page articulating the policy regarding the use of data provided by the provider.
getOpTosUri() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
A page articulating the terms of service for the provider.
getRefreshToken() - Method in class net.openid.appauth.AuthState
The most recent refresh token received from the server, if available.
getRegistrationEndpoint() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The dynamic client registration endpoint URI.
getRequestObjectEncryptionAlgorithmValuesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The JWE encryption algorithms (alg values) supported for Request Objects.
getRequestObjectEncryptionEncodingValuesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The JWE encryption encodings (enc values) supported for Request Objects.
getRequestObjectSigningAlgorithmValuesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The JWS signing algorithms (alg values) supported for Request Objects.
getResponseModesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The OAuth 2 response_mode values supported.
getResponseTypesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The OAuth 2 response_type values supported.
getScope() - Method in class net.openid.appauth.AuthState
The scope of the current authorization grant.
getScopeSet() - Method in class net.openid.appauth.AuthorizationRequest
Derives the set of scopes from the consolidated, space-delimited scopes in the AuthorizationRequest.scope field.
getScopeSet() - Method in class net.openid.appauth.AuthorizationResponse
Derives the set of scopes from the consolidated, space-delimited scopes in the AuthorizationResponse.scope field.
getScopeSet() - Method in class net.openid.appauth.AuthState
A set representation of AuthState.getScope(), for convenience.
getScopeSet() - Method in class net.openid.appauth.TokenRequest
Derives the set of scopes from the consolidated, space-delimited scopes in the TokenRequest.scope field.
getScopeSet() - Method in class net.openid.appauth.TokenResponse
Derives the set of scopes from the consolidated, space-delimited scopes in the TokenResponse.scope field.
getScopesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The OAuth 2 scope values supported.
getServiceDocumentation() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
A page containing human-readable information that developers might want or need to know when using this provider.
getSubjectTypesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The subject identifier types supported.
getTokenEndpoint() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The OAuth 2 token endpoint URI.
getTokenEndpointAuthMethodsSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The client authentication methods supported by the token endpoint.
getTokenEndpointAuthSigningAlgorithmValuesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The JWS signing algorithms (alg values) supported by the token endpoint for the signature on the JWT used to authenticate the client for the private_key_jwt and client_secret_jwt authentication methods.
getUiLocalesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
Languages and scripts supported for the user interface.
getUserinfoEncryptionAlgorithmValuesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The JWE encryption algorithms (alg values) supported by the UserInfo Endpoint for encoding ID token claims.
getUserinfoEncryptionEncodingValuesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The JWE encryption encodings (enc values) supported by the UserInfo Endpoint for encoding ID token claims.
getUserinfoEndpoint() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The OpenID Connect UserInfo endpoint URI.
getUserinfoSigningAlgorithmValuesSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
The JWS signing algorithms (alg values) supported by the UserInfo Endpoint for encoding ID token claims.
GRANT_TYPE_AUTHORIZATION_CODE - Static variable in class net.openid.appauth.TokenRequest
The grant type used for exchanging an authorization code for one or more tokens.
GRANT_TYPE_CLIENT_CREDENTIALS - Static variable in class net.openid.appauth.TokenRequest
The grant type used when requesting an access token using client credentials, typically TLS client certificates.
GRANT_TYPE_PASSWORD - Static variable in class net.openid.appauth.TokenRequest
The grant type used when requesting an access token using a username and password.
GRANT_TYPE_REFRESH_TOKEN - Static variable in class net.openid.appauth.TokenRequest
The grant type used when exchanging a refresh token for a new token.
grantType - Variable in class net.openid.appauth.TokenRequest
The type of token being sent to the token endpoint.

H

hasAccessTokenExpired() - Method in class net.openid.appauth.AuthorizationResponse
Determines whether the returned access token has expired.
hashCode() - Method in exception net.openid.appauth.AuthorizationException
 

I

idToken - Variable in class net.openid.appauth.AuthorizationResponse
The id token retrieved as part of the authorization flow.
idToken - Variable in class net.openid.appauth.TokenResponse
The ID token describing the authenticated user, if provided.
INVALID_CLIENT - Static variable in class net.openid.appauth.AuthorizationException.TokenRequestErrors
An invalid_client OAuth2 error response.
INVALID_DISCOVERY_DOCUMENT - Static variable in class net.openid.appauth.AuthorizationException.GeneralErrors
Indicates a problem parsing an OpenID Connect Service Discovery document.
INVALID_GRANT - Static variable in class net.openid.appauth.AuthorizationException.TokenRequestErrors
An invalid_grant OAuth2 error response.
INVALID_REQUEST - Static variable in class net.openid.appauth.AuthorizationException.AuthorizationRequestErrors
An invalid_request OAuth2 error response.
INVALID_REQUEST - Static variable in class net.openid.appauth.AuthorizationException.TokenRequestErrors
An invalid_request OAuth2 error response.
INVALID_SCOPE - Static variable in class net.openid.appauth.AuthorizationException.AuthorizationRequestErrors
An invalid_scope OAuth2 error response.
INVALID_SCOPE - Static variable in class net.openid.appauth.AuthorizationException.TokenRequestErrors
An invalid_scope OAuth2 error response.
isAuthorized() - Method in class net.openid.appauth.AuthState
Determines whether the current state represents a successful authorization, from which at least either an access token or an ID token have been retrieved.
isClaimsParameterSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
Specifies whether the claims parameter is supported for authorization requests.
isRequestParameterSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
Specifies whether the request parameter is supported for authorization requests.
isRequestUriParameterSupported() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
Specifies whether the request_uri is supported for authorization requests.

J

JSON_DESERIALIZATION_ERROR - Static variable in class net.openid.appauth.AuthorizationException.GeneralErrors
Indicates a problem occurred deserializing JSON.

M

MAX_CODE_VERIFIER_ENTROPY - Static variable in class net.openid.appauth.CodeVerifierUtil
The maximum permitted entropy (in bytes) for use with CodeVerifierUtil.generateRandomCodeVerifier(SecureRandom,int).
MAX_CODE_VERIFIER_LENGTH - Static variable in class net.openid.appauth.CodeVerifierUtil
The maximum permitted length for a code verifier.
MIN_CODE_VERIFIER_ENTROPY - Static variable in class net.openid.appauth.CodeVerifierUtil
The minimum permitted entropy (in bytes) for use with CodeVerifierUtil.generateRandomCodeVerifier(SecureRandom,int).
MIN_CODE_VERIFIER_LENGTH - Static variable in class net.openid.appauth.CodeVerifierUtil
The minimum permitted length for a code verifier.
MissingArgumentException(String) - Constructor for exception net.openid.appauth.AuthorizationServiceDiscovery.MissingArgumentException
Indicates that the specified mandatory field is missing from the discovery document.

N

net.openid.appauth - package net.openid.appauth
AppAuth for Android.
NETWORK_ERROR - Static variable in class net.openid.appauth.AuthorizationException.GeneralErrors
Indicates a network error occurred.

O

onCreate(Bundle) - Method in class net.openid.appauth.RedirectUriReceiverActivity
 
onFetchConfigurationCompleted(AuthorizationServiceConfiguration, AuthorizationException) - Method in interface net.openid.appauth.AuthorizationServiceConfiguration.RetrieveConfigurationCallback
Invoked when the retrieval of the discovery doc completes successfully or fails.
onTokenRequestCompleted(TokenResponse, AuthorizationException) - Method in interface net.openid.appauth.AuthorizationService.TokenResponseCallback
Invoked when the request completes successfully or fails.
OPENID_CONFIGURATION_WELL_KNOWN_PATH - Static variable in class net.openid.appauth.AuthorizationServiceConfiguration
The standard path at which an OpenID Connect discovery document can be found under an issuer's base URI.
OTHER - Static variable in class net.openid.appauth.AuthorizationException.AuthorizationRequestErrors
Indicates an OAuth error as per RFC 6749, but the error code is not known to the AppAuth for Android library.
OTHER - Static variable in class net.openid.appauth.AuthorizationException.TokenRequestErrors
Indicates an OAuth error as per RFC 6749, but the error code is not known to the AppAuth for Android library.

P

PARAM_ERROR - Static variable in exception net.openid.appauth.AuthorizationException
The OAuth2 parameter used to indicate the type of error during an authorization or token request.
PARAM_ERROR_DESCRIPTION - Static variable in exception net.openid.appauth.AuthorizationException
The OAuth2 parameter used to provide a human readable description of the error which occurred.
PARAM_ERROR_URI - Static variable in exception net.openid.appauth.AuthorizationException
The OAuth2 parameter used to provide a URI to a human-readable page which describes the error.
performActionWithFreshTokens(AuthorizationService, AuthState.AuthStateAction) - Method in class net.openid.appauth.AuthState
Ensures that a non-expired access token is available before invoking the provided action.
performActionWithFreshTokens(AuthorizationService, Map<String, String>, AuthState.AuthStateAction) - Method in class net.openid.appauth.AuthState
Ensures that a non-expired access token is available before invoking the provided action.
performAuthorizationRequest(AuthorizationRequest, PendingIntent) - Method in class net.openid.appauth.AuthorizationService
Sends an authorization request to the authorization service, using a custom tab.
performAuthorizationRequest(AuthorizationRequest, PendingIntent, CustomTabsIntent) - Method in class net.openid.appauth.AuthorizationService
Sends an authorization request to the authorization service, using a custom tab.
performTokenRequest(TokenRequest, AuthorizationService.TokenResponseCallback) - Method in class net.openid.appauth.AuthorizationService
Sends a request to the authorization service to exchange a code granted as part of an authorization request for a token.
PROGRAM_CANCELED_AUTH_FLOW - Static variable in class net.openid.appauth.AuthorizationException.GeneralErrors
Indicates an OAuth authorization flow was programmatically cancelled.

R

redirectUri - Variable in class net.openid.appauth.AuthorizationRequest
The client's redirect URI.
redirectUri - Variable in class net.openid.appauth.TokenRequest
The client's redirect URI.
RedirectUriReceiverActivity - Class in net.openid.appauth
Activity that receives the redirect Uri sent by the OpenID endpoint.
RedirectUriReceiverActivity() - Constructor for class net.openid.appauth.RedirectUriReceiverActivity
 
refreshToken - Variable in class net.openid.appauth.TokenRequest
A refresh token to be exchanged for a new token.
refreshToken - Variable in class net.openid.appauth.TokenResponse
The refresh token, if provided.
request - Variable in class net.openid.appauth.AuthorizationResponse
The authorization request associated with this response.
request - Variable in class net.openid.appauth.TokenResponse
The token request associated with this response.
requireRequestUriRegistration() - Method in class net.openid.appauth.AuthorizationServiceDiscovery
Specifies whether request_uri values are required to be pre-registered before use.
RESPONSE_MODE_FRAGMENT - Static variable in class net.openid.appauth.AuthorizationRequest
Instructs the authorization server to send response parameters using the fragment portion of the redirect URI.
RESPONSE_MODE_QUERY - Static variable in class net.openid.appauth.AuthorizationRequest
Instructs the authorization server to send response parameters using the query portion of the redirect URI.
RESPONSE_TYPE_CODE - Static variable in class net.openid.appauth.AuthorizationRequest
For requesting an authorization code.
RESPONSE_TYPE_TOKEN - Static variable in class net.openid.appauth.AuthorizationRequest
For requesting an access token via an implicit grant.
responseMode - Variable in class net.openid.appauth.AuthorizationRequest
Instructs the authorization service on the mechanism to be used for returning response parameters from the authorization endpoint.
responseType - Variable in class net.openid.appauth.AuthorizationRequest
The expected response type.

S

scope - Variable in class net.openid.appauth.AuthorizationRequest
The optional set of scopes expressed as a space-delimited, case-sensitive string.
scope - Variable in class net.openid.appauth.AuthorizationResponse
The scope of the returned access token.
scope - Variable in class net.openid.appauth.TokenRequest
A space-delimited set of scopes used to determine the scope of any returned tokens.
scope - Variable in class net.openid.appauth.TokenResponse
The scope of the access token.
SCOPE_ADDRESS - Static variable in class net.openid.appauth.AuthorizationRequest
A scope for the authenticated user's mailing address.
SCOPE_ADDRESS - Static variable in class net.openid.appauth.AuthorizationService
Scope value which requests access to the address claim.
SCOPE_EMAIL - Static variable in class net.openid.appauth.AuthorizationRequest
A scope for the authenticated user's email address.
SCOPE_EMAIL - Static variable in class net.openid.appauth.AuthorizationService
Scope value which requests access to the email and email_verified claims.
SCOPE_OPENID - Static variable in class net.openid.appauth.AuthorizationRequest
A scope for OpenID based authorization.
SCOPE_OPENID - Static variable in class net.openid.appauth.AuthorizationService
Scope value which requests access to the end-user's stable identifier.
SCOPE_PHONE - Static variable in class net.openid.appauth.AuthorizationRequest
A scope for the authenticated user's phone number.
SCOPE_PROFILE - Static variable in class net.openid.appauth.AuthorizationRequest
A scope for the authenticated user's basic profile information.
SCOPE_PROFILE - Static variable in class net.openid.appauth.AuthorizationService
Scope value which requests access to the end-user's default profile claims.
SERVER_ERROR - Static variable in class net.openid.appauth.AuthorizationException.AuthorizationRequestErrors
An server_error OAuth2 error response, equivalent to an HTTP 500 error code, but sent via redirect.
SERVER_ERROR - Static variable in class net.openid.appauth.AuthorizationException.GeneralErrors
Indicates a server error occurred.
setAccessToken(String) - Method in class net.openid.appauth.AuthorizationResponse.Builder
Specifies the OAuth 2 access token.
setAccessToken(String) - Method in class net.openid.appauth.TokenResponse.Builder
Specifies the access token.
setAccessTokenExpirationTime(Long) - Method in class net.openid.appauth.AuthorizationResponse.Builder
Specifies the expiration time of the OAuth 2 access token.
setAccessTokenExpirationTime(Long) - Method in class net.openid.appauth.TokenResponse.Builder
Sets the exact expiration time of the access token, in milliseconds since the UNIX epoch.
setAccessTokenExpiresIn(Long) - Method in class net.openid.appauth.AuthorizationResponse.Builder
Specifies the expiration period of the OAuth 2 access token.
setAccessTokenExpiresIn(Long, Clock) - Method in class net.openid.appauth.AuthorizationResponse.Builder
Specifies the relative expiration time of the access token, in seconds, using the provided clock as the source of the current time.
setAccessTokenExpiresIn(Long) - Method in class net.openid.appauth.TokenResponse.Builder
Sets the relative expiration time of the access token, in seconds, using the default system clock as the source of the current time.
setAdditionalParameters(Map<String, String>) - Method in class net.openid.appauth.AuthorizationRequest.Builder
Specifies additional parameters.
setAdditionalParameters(Map<String, String>) - Method in class net.openid.appauth.AuthorizationResponse.Builder
Specifies the additional set of parameters received as part of the response.
setAdditionalParameters(Map<String, String>) - Method in class net.openid.appauth.TokenRequest.Builder
Specifies an additional set of parameters to be sent as part of the request.
setAdditionalParameters(Map<String, String>) - Method in class net.openid.appauth.TokenResponse.Builder
Specifies the additional, non-standard parameters received as part of the response.
setAuthorizationCode(String) - Method in class net.openid.appauth.AuthorizationResponse.Builder
Specifies the OAuth 2 authorization code.
setAuthorizationCode(String) - Method in class net.openid.appauth.TokenRequest.Builder
Specifies the authorization code for the request.
setAuthorizationServiceConfiguration(AuthorizationServiceConfiguration) - Method in class net.openid.appauth.AuthorizationRequest.Builder
Specifies the service configuration to be used in dispatching this request.
setClientId(String) - Method in class net.openid.appauth.AuthorizationRequest.Builder
Specifies the client ID.
setClientId(String) - Method in class net.openid.appauth.TokenRequest.Builder
Specifies the client ID for the token request, which must not be null or empty.
setCodeVerifier(String) - Method in class net.openid.appauth.AuthorizationRequest.Builder
Specifies the code verifier to use for this authorization request.
setCodeVerifier(String, String, String) - Method in class net.openid.appauth.AuthorizationRequest.Builder
Specifies the code verifier, challenge and method strings to use for this authorization request.
setCodeVerifier(String) - Method in class net.openid.appauth.TokenRequest.Builder
Specifies the code verifier for an authorization code exchange request.
setConfiguration(AuthorizationServiceConfiguration) - Method in class net.openid.appauth.TokenRequest.Builder
Specifies the authorization service configuration for the request, which must not be null or empty.
setGrantType(String) - Method in class net.openid.appauth.TokenRequest.Builder
Specifies the grant type for the request, which must not be null or empty.
setIdToken(String) - Method in class net.openid.appauth.AuthorizationResponse.Builder
Specifies the OAuth 2 Id token.
setIdToken(String) - Method in class net.openid.appauth.TokenResponse.Builder
Specifies the ID token.
setNeedsTokenRefresh(boolean) - Method in class net.openid.appauth.AuthState
Sets whether to force an access token refresh, irrespective of the expiration time.
setRedirectUri(Uri) - Method in class net.openid.appauth.AuthorizationRequest.Builder
Specifies the client's redirect URI.
setRedirectUri(Uri) - Method in class net.openid.appauth.TokenRequest.Builder
Specifies the redirect URI for the request.
setRefreshToken(String) - Method in class net.openid.appauth.TokenRequest.Builder
Specifies the refresh token for the request.
setRefreshToken(String) - Method in class net.openid.appauth.TokenResponse.Builder
Specifies the refresh token.
setRequest(TokenRequest) - Method in class net.openid.appauth.TokenResponse.Builder
Specifies the request associated with this response.
setResponseMode(String) - Method in class net.openid.appauth.AuthorizationRequest.Builder
Specifies the response mode to be used for returning authorization response parameters from the authorization endpoint.
setResponseType(String) - Method in class net.openid.appauth.AuthorizationRequest.Builder
Specifies the expected response type.
setScope(String) - Method in class net.openid.appauth.AuthorizationRequest.Builder
Specifies the encoded scope string, which is a space-delimited set of case-sensitive scope identifiers.
setScope(String) - Method in class net.openid.appauth.AuthorizationResponse.Builder
Specifies the encoded scope string, which is a space-delimited set of case-sensitive scope identifiers.
setScope(String) - Method in class net.openid.appauth.TokenRequest.Builder
Specifies the encoded scope string, which is a space-delimited set of case-sensitive scope identifiers.
setScope(String) - Method in class net.openid.appauth.TokenResponse.Builder
Specifies the encoded scope string, which is a space-delimited set of case-sensitive scope identifiers.
setScopes(String...) - Method in class net.openid.appauth.AuthorizationRequest.Builder
Specifies the set of case-sensitive scopes.
setScopes(Iterable<String>) - Method in class net.openid.appauth.AuthorizationRequest.Builder
Specifies the set of case-sensitive scopes.
setScopes(String...) - Method in class net.openid.appauth.AuthorizationResponse.Builder
Specifies the set of case-sensitive scopes.
setScopes(Iterable<String>) - Method in class net.openid.appauth.AuthorizationResponse.Builder
Specifies the set of case-sensitive scopes.
setScopes(String...) - Method in class net.openid.appauth.TokenRequest.Builder
Specifies the set of case-sensitive scopes.
setScopes(Iterable<String>) - Method in class net.openid.appauth.TokenRequest.Builder
Specifies the set of case-sensitive scopes.
setScopes(String...) - Method in class net.openid.appauth.TokenResponse.Builder
Specifies the set of case-sensitive scopes.
setScopes(Iterable<String>) - Method in class net.openid.appauth.TokenResponse.Builder
Specifies the set of case-sensitive scopes.
setState(String) - Method in class net.openid.appauth.AuthorizationRequest.Builder
Specifies the opaque value used by the client to maintain state between the request and callback.
setState(String) - Method in class net.openid.appauth.AuthorizationResponse.Builder
Specifies the OAuth 2 state.
setTokenType(String) - Method in class net.openid.appauth.AuthorizationResponse.Builder
Specifies the OAuth 2 token type.
setTokenType(String) - Method in class net.openid.appauth.TokenResponse.Builder
Specifies the token type of the access token in this response.
state - Variable in class net.openid.appauth.AuthorizationRequest
An opaque value used by the client to maintain state between the request and callback.
state - Variable in class net.openid.appauth.AuthorizationResponse
The returned state parameter, which must match the value specified in the request.

T

TEMPORARILY_UNAVAILABLE - Static variable in class net.openid.appauth.AuthorizationException.AuthorizationRequestErrors
A temporarily_unavailable OAuth2 error response, equivalent to an HTTP 503 error code, but sent via redirect.
toIntent() - Method in exception net.openid.appauth.AuthorizationException
Creates an intent from this exception.
toIntent() - Method in class net.openid.appauth.AuthorizationResponse
Produces an intent containing this authorization response.
toJson() - Method in exception net.openid.appauth.AuthorizationException
Produces a JSON representation of the authorization exception, for transmission or storage.
toJson() - Method in class net.openid.appauth.AuthorizationRequest
Produces a JSON representation of the request for storage or transmission.
toJson() - Method in class net.openid.appauth.AuthorizationResponse
Converts the response to a JSON object for storage or transmission.
toJson() - Method in class net.openid.appauth.AuthorizationServiceConfiguration
Converts the authorization service configuration to JSON for storage or transmission.
toJson() - Method in class net.openid.appauth.AuthState
Converts the authorization state to a JSON object for storage or transmission.
toJson() - Method in class net.openid.appauth.TokenRequest
Converts the token request to JSON for storage or transmission.
toJson() - Method in class net.openid.appauth.TokenResponse
Converts the token response to a JSON object, for storage or transmission.
toJsonString() - Method in exception net.openid.appauth.AuthorizationException
Provides a JSON string representation of an authorization exception, for transmission or storage.
toJsonString() - Method in class net.openid.appauth.AuthorizationRequest
Produces a JSON string representation of the request for storage or transmission.
toJsonString() - Method in class net.openid.appauth.AuthorizationResponse
Converts the response to a JSON string for storage or transmission.
toJsonString() - Method in class net.openid.appauth.AuthorizationServiceConfiguration
Converts the authorization service configuration to a JSON string for storage or transmission.
toJsonString() - Method in class net.openid.appauth.AuthState
Converts the authorization state to a JSON string for storage or transmission.
toJsonString() - Method in class net.openid.appauth.TokenRequest
Converts the authorization request to a JSON string for storage or transmission.
toJsonString() - Method in class net.openid.appauth.TokenResponse
Converts the token response to a JSON string, for storage or transmission.
TOKEN_RESPONSE_CONSTRUCTION_ERROR - Static variable in class net.openid.appauth.AuthorizationException.GeneralErrors
Indicates a problem occurred constructing a token response object from the JSON provided by the server.
TOKEN_TYPE_BEARER - Static variable in class net.openid.appauth.AuthorizationResponse
Indicates that a provided access token is a bearer token.
TOKEN_TYPE_BEARER - Static variable in class net.openid.appauth.TokenResponse
Indicates that a provided access token is a bearer token.
tokenEndpoint - Variable in class net.openid.appauth.AuthorizationServiceConfiguration
The authorization service's token exchange and refresh endpoint.
TokenRequest - Class in net.openid.appauth
An OAuth2 token request.
TokenRequest.Builder - Class in net.openid.appauth
Creates instances of TokenRequest.
TokenRequestErrors() - Constructor for class net.openid.appauth.AuthorizationException.TokenRequestErrors
 
TokenResponse - Class in net.openid.appauth
A response to a token request.
TokenResponse.Builder - Class in net.openid.appauth
Creates instances of TokenResponse.
tokenType - Variable in class net.openid.appauth.AuthorizationResponse
The type of the retrieved token.
tokenType - Variable in class net.openid.appauth.TokenResponse
The type of the token returned.
toString() - Method in exception net.openid.appauth.AuthorizationException
 
type - Variable in exception net.openid.appauth.AuthorizationException
The type of the error.
TYPE_GENERAL_ERROR - Static variable in exception net.openid.appauth.AuthorizationException
The error type used for all errors that are not specific to OAuth related responses.
TYPE_OAUTH_AUTHORIZATION_ERROR - Static variable in exception net.openid.appauth.AuthorizationException
The error type for OAuth specific errors on the authorization endpoint.
TYPE_OAUTH_TOKEN_ERROR - Static variable in exception net.openid.appauth.AuthorizationException
The error type for OAuth specific errors on the token endpoint.
TYPE_RESOURCE_SERVER_AUTHORIZATION_ERROR - Static variable in exception net.openid.appauth.AuthorizationException
The error type for authorization errors encountered out of band on the resource server.

U

UNAUTHORIZED_CLIENT - Static variable in class net.openid.appauth.AuthorizationException.AuthorizationRequestErrors
An unauthorized_client OAuth2 error response.
UNAUTHORIZED_CLIENT - Static variable in class net.openid.appauth.AuthorizationException.TokenRequestErrors
An unauthorized_client OAuth2 error response.
UNSUPPORTED_GRANT_TYPE - Static variable in class net.openid.appauth.AuthorizationException.TokenRequestErrors
An unsupported_grant_type OAuth2 error response.
UNSUPPORTED_RESPONSE_TYPE - Static variable in class net.openid.appauth.AuthorizationException.AuthorizationRequestErrors
An unsupported_response_type OAuth2 error response.
update(AuthorizationResponse, Exception) - Method in class net.openid.appauth.AuthState
Updates the authorization state based on a new authorization response.
update(TokenResponse, Exception) - Method in class net.openid.appauth.AuthState
Updates the authorization state based on a new token response.
USER_CANCELED_AUTH_FLOW - Static variable in class net.openid.appauth.AuthorizationException.GeneralErrors
Indicates the user manually canceled the OAuth authorization code flow.
A B C D E F G H I J M N O P R S T U 
Skip navigation links