A B C D E F G H I L M N O P Q R S T U V W Z

A

AbstractOAuth2Token - Class in org.springframework.security.oauth2.core

Base class for OAuth 2.0 Token implementations.

AbstractOAuth2Token(String) - Constructor for class org.springframework.security.oauth2.core.AbstractOAuth2Token

Sub-class constructor.

AbstractOAuth2Token(String, Instant, Instant) - Constructor for class org.springframework.security.oauth2.core.AbstractOAuth2Token

Sub-class constructor.

ACCESS_DENIED - Static variable in interface org.springframework.security.oauth2.core.OAuth2ErrorCodes

access_denied - The resource owner or authorization server denied the request.

ACCESS_TOKEN - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

access_token - used in Authorization Response and Access Token Response.

ACR - Static variable in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimNames

acr - the Authentication Context Class Reference

addConverters(ConverterRegistry) - Static method in class org.springframework.security.oauth2.core.converter.ClaimConversionService

Adds the converters that provide type conversion for claim values to the provided ConverterRegistry.

additionalParameters(Map<String, Object>) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse.Builder

Sets the additional parameters returned in the response.

additionalParameters(Map<String, Object>) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder

Sets the additional parameters used in the request.

ADDRESS - Static variable in interface org.springframework.security.oauth2.core.oidc.OidcScopes

The address scope requests access to the address claim.

ADDRESS - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

address - the user's preferred postal address

AddressStandardClaim - Interface in org.springframework.security.oauth2.core.oidc

The Address Claim represents a physical mailing address defined by the OpenID Connect Core 1.0 specification that can be returned either in the UserInfo Response or the ID Token.

AMR - Static variable in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimNames

amr - the Authentication Methods References

AT_HASH - Static variable in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimNames

at_hash - the Access Token hash value

attributes(Map<String, Object>) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder

Sets the attributes associated to the request.

AUD - Static variable in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimNames

aud - the Audience(s) that the ID Token is intended for

AUTH_TIME - Static variable in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimNames

auth_time - the time when the End-User authentication occurred

AuthenticationMethod - Class in org.springframework.security.oauth2.core

The authentication method used when sending bearer access tokens in resource requests to resource servers.

AuthenticationMethod(String) - Constructor for class org.springframework.security.oauth2.core.AuthenticationMethod

Constructs an AuthenticationMethod using the provided value.

AUTHORIZATION_CODE - Static variable in class org.springframework.security.oauth2.core.AuthorizationGrantType

authorizationCode() - Static method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

Returns a new OAuth2AuthorizationRequest.Builder, initialized with the authorization code grant type.

AuthorizationGrantType - Class in org.springframework.security.oauth2.core

An authorization grant is a credential representing the resource owner's authorization (to access it's protected resources) to the client and used by the client to obtain an access token.

AuthorizationGrantType(String) - Constructor for class org.springframework.security.oauth2.core.AuthorizationGrantType

Constructs an AuthorizationGrantType using the provided value.

authorizationRequestUri(String) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder

Sets the URI string representation of the OAuth 2.0 Authorization Request.

authorizationUri(String) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder

Sets the uri for the authorization endpoint.

AZP - Static variable in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimNames

azp - the Authorized party to which the ID Token was issued

B

BASIC - Static variable in class org.springframework.security.oauth2.core.ClientAuthenticationMethod

BEARER - Static variable in class org.springframework.security.oauth2.core.OAuth2AccessToken.TokenType

BIRTHDATE - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

birthdate - the user's birth date

build() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse.Builder

Builds a new OAuth2AccessTokenResponse.

build() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder

Builds a new OAuth2AuthorizationRequest.

build() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse.Builder

Builds a new OAuth2AuthorizationResponse.

build() - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim.Builder

Builds a new DefaultAddressStandardClaim.

Builder() - Constructor for class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim.Builder

Default constructor.

Builder(Map<String, Object>) - Constructor for class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim.Builder

Constructs and initializes the address attributes using the provided addressFields.

C

C_HASH - Static variable in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimNames

c_hash - the Authorization Code hash value

ClaimAccessor - Interface in org.springframework.security.oauth2.core

An "accessor" for a set of claims that may be used for assertions.

ClaimConversionService - Class in org.springframework.security.oauth2.core.converter

A ConversionService configured with converters that provide type conversion for claim values.

ClaimTypeConverter - Class in org.springframework.security.oauth2.core.converter

A Converter that provides type conversion for claim values.

ClaimTypeConverter(Map<String, Converter<Object, ?>>) - Constructor for class org.springframework.security.oauth2.core.converter.ClaimTypeConverter

Constructs a ClaimTypeConverter using the provided parameters.

CLIENT_CREDENTIALS - Static variable in class org.springframework.security.oauth2.core.AuthorizationGrantType

CLIENT_ID - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

client_id - used in Authorization Request and Access Token Request.

CLIENT_SECRET - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

client_secret - used in Access Token Request.

ClientAuthenticationMethod - Class in org.springframework.security.oauth2.core

The authentication method used when authenticating the client with the authorization server.

ClientAuthenticationMethod(String) - Constructor for class org.springframework.security.oauth2.core.ClientAuthenticationMethod

Constructs a ClientAuthenticationMethod using the provided value.

clientId(String) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder

Sets the client identifier.

code(String) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse.Builder

Sets the authorization code.

CODE - Static variable in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponseType

CODE - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

code - used in Authorization Response and Access Token Request.

CODE_CHALLENGE - Static variable in interface org.springframework.security.oauth2.core.endpoint.PkceParameterNames

code_challenge - used in Authorization Request.

CODE_CHALLENGE_METHOD - Static variable in interface org.springframework.security.oauth2.core.endpoint.PkceParameterNames

code_challenge_method - used in Authorization Request.

CODE_VERIFIER - Static variable in interface org.springframework.security.oauth2.core.endpoint.PkceParameterNames

code_verifier - used in Token Request.

containsClaim(String) - Method in interface org.springframework.security.oauth2.core.ClaimAccessor

Returns true if the claim exists in ClaimAccessor.getClaims(), otherwise false.

convert(Map<String, Object>) - Method in class org.springframework.security.oauth2.core.converter.ClaimTypeConverter

country(String) - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim.Builder

Sets the country.

D

DefaultAddressStandardClaim - Class in org.springframework.security.oauth2.core.oidc

The default implementation of an Address Claim.

DefaultAddressStandardClaim.Builder - Class in org.springframework.security.oauth2.core.oidc

A builder for DefaultAddressStandardClaim.

DefaultOAuth2AuthenticatedPrincipal - Class in org.springframework.security.oauth2.core

A domain object that wraps the attributes of an OAuth 2.0 token.

DefaultOAuth2AuthenticatedPrincipal(Map<String, Object>, Collection<GrantedAuthority>) - Constructor for class org.springframework.security.oauth2.core.DefaultOAuth2AuthenticatedPrincipal

Constructs an DefaultOAuth2AuthenticatedPrincipal using the provided parameters.

DefaultOAuth2AuthenticatedPrincipal(String, Map<String, Object>, Collection<GrantedAuthority>) - Constructor for class org.springframework.security.oauth2.core.DefaultOAuth2AuthenticatedPrincipal

Constructs an DefaultOAuth2AuthenticatedPrincipal using the provided parameters.

DefaultOAuth2User - Class in org.springframework.security.oauth2.core.user

The default implementation of an OAuth2User.

DefaultOAuth2User(Collection<? extends GrantedAuthority>, Map<String, Object>, String) - Constructor for class org.springframework.security.oauth2.core.user.DefaultOAuth2User

Constructs a DefaultOAuth2User using the provided parameters.

DefaultOidcUser - Class in org.springframework.security.oauth2.core.oidc.user

The default implementation of an OidcUser.

DefaultOidcUser(Collection<? extends GrantedAuthority>, OidcIdToken) - Constructor for class org.springframework.security.oauth2.core.oidc.user.DefaultOidcUser

Constructs a DefaultOidcUser using the provided parameters.

DefaultOidcUser(Collection<? extends GrantedAuthority>, OidcIdToken, String) - Constructor for class org.springframework.security.oauth2.core.oidc.user.DefaultOidcUser

Constructs a DefaultOidcUser using the provided parameters.

DefaultOidcUser(Collection<? extends GrantedAuthority>, OidcIdToken, OidcUserInfo) - Constructor for class org.springframework.security.oauth2.core.oidc.user.DefaultOidcUser

Constructs a DefaultOidcUser using the provided parameters.

DefaultOidcUser(Collection<? extends GrantedAuthority>, OidcIdToken, OidcUserInfo, String) - Constructor for class org.springframework.security.oauth2.core.oidc.user.DefaultOidcUser

Constructs a DefaultOidcUser using the provided parameters.

DelegatingOAuth2TokenValidator<T extends AbstractOAuth2Token> - Class in org.springframework.security.oauth2.core

A composite validator

DelegatingOAuth2TokenValidator(Collection<OAuth2TokenValidator<T>>) - Constructor for class org.springframework.security.oauth2.core.DelegatingOAuth2TokenValidator

Constructs a DelegatingOAuth2TokenValidator using the provided validators.

DelegatingOAuth2TokenValidator(OAuth2TokenValidator<T>...) - Constructor for class org.springframework.security.oauth2.core.DelegatingOAuth2TokenValidator

Constructs a DelegatingOAuth2TokenValidator using the provided validators.

E

EMAIL - Static variable in interface org.springframework.security.oauth2.core.oidc.OidcScopes

The email scope requests access to the email and email_verified claims.

EMAIL - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

email - the user's preferred e-mail address

EMAIL_VERIFIED - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

email_verified - true if the user's e-mail address has been verified, otherwise false

equals(Object) - Method in class org.springframework.security.oauth2.core.AbstractOAuth2Token

equals(Object) - Method in class org.springframework.security.oauth2.core.AuthenticationMethod

equals(Object) - Method in class org.springframework.security.oauth2.core.AuthorizationGrantType

equals(Object) - Method in class org.springframework.security.oauth2.core.ClientAuthenticationMethod

equals(Object) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponseType

equals(Object) - Method in class org.springframework.security.oauth2.core.OAuth2AccessToken.TokenType

equals(Object) - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim

equals(Object) - Method in class org.springframework.security.oauth2.core.oidc.OidcUserInfo

equals(Object) - Method in class org.springframework.security.oauth2.core.oidc.user.OidcUserAuthority

equals(Object) - Method in class org.springframework.security.oauth2.core.user.DefaultOAuth2User

equals(Object) - Method in class org.springframework.security.oauth2.core.user.OAuth2UserAuthority

error(String) - Static method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse

Returns a new OAuth2AuthorizationResponse.Builder, initialized with the error code.

ERROR - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

error - used in Authorization Response and Access Token Response.

ERROR_DESCRIPTION - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

error_description - used in Authorization Response and Access Token Response.

ERROR_URI - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

error_uri - used in Authorization Response and Access Token Response.

errorCode(String) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse.Builder

Sets the error code.

errorConverter - Variable in class org.springframework.security.oauth2.core.http.converter.OAuth2ErrorHttpMessageConverter

errorDescription(String) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse.Builder

Sets the error description.

errorParametersConverter - Variable in class org.springframework.security.oauth2.core.http.converter.OAuth2ErrorHttpMessageConverter

errorUri(String) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse.Builder

Sets the error uri.

EXP - Static variable in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimNames

exp - the Expiration time on or after which the ID Token MUST NOT be accepted

EXPIRES_IN - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

expires_in - used in Authorization Response and Access Token Response.

expiresIn(long) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse.Builder

Sets the lifetime (in seconds) of the access token.

F

failure(OAuth2Error...) - Static method in class org.springframework.security.oauth2.core.OAuth2TokenValidatorResult

Construct a failure OAuth2TokenValidatorResult with the provided detail

failure(Collection<OAuth2Error>) - Static method in class org.springframework.security.oauth2.core.OAuth2TokenValidatorResult

Construct a failure OAuth2TokenValidatorResult with the provided detail

FAMILY_NAME - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

family_name - the user's surname(s) or last name(s)

FORM - Static variable in class org.springframework.security.oauth2.core.AuthenticationMethod

formatted(String) - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim.Builder

Sets the full mailing address, formatted for display.

from(OAuth2AuthorizationRequest) - Static method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

Returns a new OAuth2AuthorizationRequest.Builder, initialized with the values from the provided authorizationRequest.

G

GENDER - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

gender - the user's gender

getAccessToken() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse

Returns the Access Token.

getAccessTokenHash() - Method in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimAccessor

Returns the Access Token hash value (at_hash).

getAdditionalParameters() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse

Returns the additional parameters returned in the response.

getAdditionalParameters() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

Returns the additional parameters used in the request.

getAddress() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the user's preferred postal address (address).

getAttribute(String) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

Returns the value of an attribute associated to the request, or null if not available.

getAttribute(String) - Method in interface org.springframework.security.oauth2.core.OAuth2AuthenticatedPrincipal

Get the OAuth 2.0 token attribute by name

getAttributes() - Method in class org.springframework.security.oauth2.core.DefaultOAuth2AuthenticatedPrincipal

Gets the attributes of the OAuth 2.0 token in map form.

getAttributes() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

Returns the attributes associated to the request.

getAttributes() - Method in interface org.springframework.security.oauth2.core.OAuth2AuthenticatedPrincipal

Get the OAuth 2.0 token attributes

getAttributes() - Method in class org.springframework.security.oauth2.core.user.DefaultOAuth2User

getAttributes() - Method in class org.springframework.security.oauth2.core.user.OAuth2UserAuthority

Returns the attributes about the user.

getAudience() - Method in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimAccessor

Returns the Audience(s) (aud) that this ID Token is intended for.

getAuthenticatedAt() - Method in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimAccessor

Returns the time when the End-User authentication occurred (auth_time).

getAuthenticationContextClass() - Method in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimAccessor

Returns the Authentication Context Class Reference (acr).

getAuthenticationMethods() - Method in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimAccessor

Returns the Authentication Methods References (amr).

getAuthorities() - Method in class org.springframework.security.oauth2.core.DefaultOAuth2AuthenticatedPrincipal

Get the Collection of GrantedAuthoritys associated with this OAuth 2.0 token

getAuthorities() - Method in interface org.springframework.security.oauth2.core.OAuth2AuthenticatedPrincipal

Get the Collection of GrantedAuthoritys associated with this OAuth 2.0 token

getAuthorities() - Method in class org.springframework.security.oauth2.core.user.DefaultOAuth2User

getAuthority() - Method in class org.springframework.security.oauth2.core.user.OAuth2UserAuthority

getAuthorizationCodeHash() - Method in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimAccessor

Returns the Authorization Code hash value (c_hash).

getAuthorizationRequest() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationExchange

Returns the Authorization Request.

getAuthorizationRequestUri() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

Returns the URI string representation of the OAuth 2.0 Authorization Request.

getAuthorizationResponse() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationExchange

Returns the Authorization Response.

getAuthorizationUri() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

Returns the uri for the authorization endpoint.

getAuthorizedParty() - Method in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimAccessor

Returns the Authorized party (azp) to which the ID Token was issued.

getBirthdate() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the user's birth date (birthdate).

getClaim(String) - Method in interface org.springframework.security.oauth2.core.ClaimAccessor

Returns the claim value as a T type.

getClaimAsBoolean(String) - Method in interface org.springframework.security.oauth2.core.ClaimAccessor

Returns the claim value as a Boolean or null if it does not exist.

getClaimAsInstant(String) - Method in interface org.springframework.security.oauth2.core.ClaimAccessor

Returns the claim value as an Instant or null if it does not exist.

getClaimAsMap(String) - Method in interface org.springframework.security.oauth2.core.ClaimAccessor

Returns the claim value as a Map<String, Object> or null if it does not exist or cannot be assigned to a Map.

getClaimAsString(String) - Method in interface org.springframework.security.oauth2.core.ClaimAccessor

Returns the claim value as a String or null if it does not exist or is equal to null.

getClaimAsStringList(String) - Method in interface org.springframework.security.oauth2.core.ClaimAccessor

Returns the claim value as a List<String> or null if it does not exist or cannot be assigned to a List.

getClaimAsURL(String) - Method in interface org.springframework.security.oauth2.core.ClaimAccessor

Returns the claim value as an URL or null if it does not exist.

getClaims() - Method in interface org.springframework.security.oauth2.core.ClaimAccessor

Returns a set of claims that may be used for assertions.

getClaims() - Method in class org.springframework.security.oauth2.core.oidc.OidcIdToken

getClaims() - Method in class org.springframework.security.oauth2.core.oidc.OidcUserInfo

getClaims() - Method in class org.springframework.security.oauth2.core.oidc.user.DefaultOidcUser

getClaims() - Method in interface org.springframework.security.oauth2.core.oidc.user.OidcUser

Returns the claims about the user.

getClientId() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

Returns the client identifier.

getCode() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse

Returns the authorization code.

getCountry() - Method in interface org.springframework.security.oauth2.core.oidc.AddressStandardClaim

Returns the country.

getCountry() - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim

getDescription() - Method in class org.springframework.security.oauth2.core.OAuth2Error

Returns the error description.

getEmail() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the user's preferred e-mail address (email).

getEmailVerified() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns true if the user's e-mail address has been verified (email_verified), otherwise false.

getError() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse

Returns the OAuth 2.0 Error if the Authorization Request failed, otherwise null.

getError() - Method in exception org.springframework.security.oauth2.core.OAuth2AuthenticationException

Returns the OAuth 2.0 Error.

getError() - Method in exception org.springframework.security.oauth2.core.OAuth2AuthorizationException

Returns the OAuth 2.0 Error.

getErrorCode() - Method in class org.springframework.security.oauth2.core.OAuth2Error

Returns the error code.

getErrors() - Method in class org.springframework.security.oauth2.core.OAuth2TokenValidatorResult

Return error details regarding the validation attempt

getExpiresAt() - Method in class org.springframework.security.oauth2.core.AbstractOAuth2Token

Returns the expiration time on or after which the token MUST NOT be accepted.

getExpiresAt() - Method in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimAccessor

Returns the Expiration time (exp) on or after which the ID Token MUST NOT be accepted.

getFamilyName() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the user's surname(s) or last name(s) (family_name).

getFormatted() - Method in interface org.springframework.security.oauth2.core.oidc.AddressStandardClaim

Returns the full mailing address, formatted for display.

getFormatted() - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim

getFullName() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the user's full name (name) in displayable form.

getGender() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the user's gender (gender).

getGivenName() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the user's given name(s) or first name(s) (given_name).

getGrantType() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

Returns the grant type.

getIdToken() - Method in class org.springframework.security.oauth2.core.oidc.user.DefaultOidcUser

getIdToken() - Method in interface org.springframework.security.oauth2.core.oidc.user.OidcUser

Returns the ID Token containing claims about the user.

getIdToken() - Method in class org.springframework.security.oauth2.core.oidc.user.OidcUserAuthority

Returns the ID Token containing claims about the user.

getIssuedAt() - Method in class org.springframework.security.oauth2.core.AbstractOAuth2Token

Returns the time at which the token was issued.

getIssuedAt() - Method in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimAccessor

Returns the time at which the ID Token was issued (iat).

getIssuer() - Method in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimAccessor

Returns the Issuer identifier (iss).

getLocale() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the user's locale (locale).

getLocality() - Method in interface org.springframework.security.oauth2.core.oidc.AddressStandardClaim

Returns the city or locality.

getLocality() - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim

getMiddleName() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the user's middle name(s) (middle_name).

getName() - Method in class org.springframework.security.oauth2.core.DefaultOAuth2AuthenticatedPrincipal

getName() - Method in class org.springframework.security.oauth2.core.user.DefaultOAuth2User

getNickName() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the user's nick name (nickname) that may or may not be the same as the (given_name).

getNonce() - Method in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimAccessor

Returns a String value (nonce) used to associate a Client session with an ID Token, and to mitigate replay attacks.

getPhoneNumber() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the user's preferred phone number (phone_number).

getPhoneNumberVerified() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns true if the user's phone number has been verified (phone_number_verified), otherwise false.

getPicture() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the URL of the user's profile picture (picture).

getPostalCode() - Method in interface org.springframework.security.oauth2.core.oidc.AddressStandardClaim

Returns the zip code or postal code.

getPostalCode() - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim

getPreferredUsername() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the preferred username (preferred_username) that the user wishes to be referred to.

getProfile() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the URL of the user's profile page (profile).

getRedirectUri() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

Returns the uri for the redirection endpoint.

getRedirectUri() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse

Returns the uri where the response was redirected to.

getRefreshToken() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse

Returns the Refresh Token.

getRegion() - Method in interface org.springframework.security.oauth2.core.oidc.AddressStandardClaim

Returns the state, province, prefecture, or region.

getRegion() - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim

getResponseType() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

Returns the response type.

getScopes() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

Returns the scope(s).

getScopes() - Method in class org.springframework.security.oauth2.core.OAuth2AccessToken

Returns the scope(s) associated to the token.

getSharedInstance() - Static method in class org.springframework.security.oauth2.core.converter.ClaimConversionService

Returns a shared instance of ClaimConversionService.

getState() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

Returns the state.

getState() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse

Returns the state.

getStreetAddress() - Method in interface org.springframework.security.oauth2.core.oidc.AddressStandardClaim

Returns the full street address, which may include house number, street name, P.O.

getStreetAddress() - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim

getSubject() - Method in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimAccessor

Returns the Subject identifier (sub).

getSubject() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the Subject identifier (sub).

getTokenType() - Method in class org.springframework.security.oauth2.core.OAuth2AccessToken

Returns the token type.

getTokenValue() - Method in class org.springframework.security.oauth2.core.AbstractOAuth2Token

Returns the token value.

getUpdatedAt() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the time the user's information was last updated (updated_at).

getUri() - Method in class org.springframework.security.oauth2.core.OAuth2Error

Returns the error uri.

getUserInfo() - Method in class org.springframework.security.oauth2.core.oidc.user.DefaultOidcUser

getUserInfo() - Method in interface org.springframework.security.oauth2.core.oidc.user.OidcUser

Returns the UserInfo containing claims about the user.

getUserInfo() - Method in class org.springframework.security.oauth2.core.oidc.user.OidcUserAuthority

Returns the UserInfo containing claims about the user, may be null.

getValue() - Method in class org.springframework.security.oauth2.core.AuthenticationMethod

Returns the value of the authentication method type.

getValue() - Method in class org.springframework.security.oauth2.core.AuthorizationGrantType

Returns the value of the authorization grant type.

getValue() - Method in class org.springframework.security.oauth2.core.ClientAuthenticationMethod

Returns the value of the client authentication method.

getValue() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponseType

Returns the value of the authorization response type.

getValue() - Method in class org.springframework.security.oauth2.core.OAuth2AccessToken.TokenType

Returns the value of the token type.

getWebsite() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the URL of the user's web page or blog (website).

getZoneInfo() - Method in interface org.springframework.security.oauth2.core.oidc.StandardClaimAccessor

Returns the user's time zone (zoneinfo).

GIVEN_NAME - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

given_name - the user's given name(s) or first name(s)

GRANT_TYPE - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

grant_type - used in Access Token Request.

H

hasErrors() - Method in class org.springframework.security.oauth2.core.OAuth2TokenValidatorResult

Say whether this result indicates success

hashCode() - Method in class org.springframework.security.oauth2.core.AbstractOAuth2Token

hashCode() - Method in class org.springframework.security.oauth2.core.AuthenticationMethod

hashCode() - Method in class org.springframework.security.oauth2.core.AuthorizationGrantType

hashCode() - Method in class org.springframework.security.oauth2.core.ClientAuthenticationMethod

hashCode() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponseType

hashCode() - Method in class org.springframework.security.oauth2.core.OAuth2AccessToken.TokenType

hashCode() - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim

hashCode() - Method in class org.springframework.security.oauth2.core.oidc.OidcUserInfo

hashCode() - Method in class org.springframework.security.oauth2.core.oidc.user.OidcUserAuthority

hashCode() - Method in class org.springframework.security.oauth2.core.user.DefaultOAuth2User

hashCode() - Method in class org.springframework.security.oauth2.core.user.OAuth2UserAuthority

HEADER - Static variable in class org.springframework.security.oauth2.core.AuthenticationMethod

I

IAT - Static variable in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimNames

iat - the time at which the ID Token was issued

ID_TOKEN - Static variable in interface org.springframework.security.oauth2.core.oidc.endpoint.OidcParameterNames

id_token - used in the Access Token Response.

IdTokenClaimAccessor - Interface in org.springframework.security.oauth2.core.oidc

A ClaimAccessor for the "claims" that can be returned in the ID Token, which provides information about the authentication of an End-User by an Authorization Server.

IdTokenClaimNames - Interface in org.springframework.security.oauth2.core.oidc

The names of the "claims" defined by the OpenID Connect Core 1.0 specification that can be returned in the ID Token.

IMPLICIT - Static variable in class org.springframework.security.oauth2.core.AuthorizationGrantType

implicit() - Static method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest

Returns a new OAuth2AuthorizationRequest.Builder, initialized with the implicit grant type.

INVALID_CLIENT - Static variable in interface org.springframework.security.oauth2.core.OAuth2ErrorCodes

invalid_client - Client authentication failed (e.g., unknown client, no client authentication included, or unsupported authentication method).

INVALID_GRANT - Static variable in interface org.springframework.security.oauth2.core.OAuth2ErrorCodes

invalid_grant - The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client.

INVALID_REQUEST - Static variable in interface org.springframework.security.oauth2.core.OAuth2ErrorCodes

invalid_request - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.

INVALID_SCOPE - Static variable in interface org.springframework.security.oauth2.core.OAuth2ErrorCodes

invalid_scope - The requested scope is invalid, unknown, malformed or exceeds the scope granted by the resource owner.

ISS - Static variable in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimNames

iss - the Issuer identifier

L

LOCALE - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

locale - the user's locale

locality(String) - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim.Builder

Sets the city or locality.

M

MIDDLE_NAME - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

middle_name - the user's middle name(s)

N

NAME - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

name - the user's full name

NICKNAME - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

nickname - the user's nick name that may or may not be the same as the given_name

NONCE - Static variable in interface org.springframework.security.oauth2.core.oidc.endpoint.OidcParameterNames

nonce - used in the Authentication Request.

NONCE - Static variable in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimNames

nonce - a String value used to associate a Client session with an ID Token, and to mitigate replay attacks.

NONE - Static variable in class org.springframework.security.oauth2.core.ClientAuthenticationMethod

O

OAuth2AccessToken - Class in org.springframework.security.oauth2.core

An implementation of an AbstractOAuth2Token representing an OAuth 2.0 Access Token.

OAuth2AccessToken(OAuth2AccessToken.TokenType, String, Instant, Instant) - Constructor for class org.springframework.security.oauth2.core.OAuth2AccessToken

Constructs an OAuth2AccessToken using the provided parameters.

OAuth2AccessToken(OAuth2AccessToken.TokenType, String, Instant, Instant, Set<String>) - Constructor for class org.springframework.security.oauth2.core.OAuth2AccessToken

Constructs an OAuth2AccessToken using the provided parameters.

OAuth2AccessToken.TokenType - Class in org.springframework.security.oauth2.core

Access Token Types.

OAuth2AccessTokenResponse - Class in org.springframework.security.oauth2.core.endpoint

A representation of an OAuth 2.0 Access Token Response.

oauth2AccessTokenResponse() - Static method in class org.springframework.security.oauth2.core.web.reactive.function.OAuth2BodyExtractors

Extractor to decode an OAuth2AccessTokenResponse

OAuth2AccessTokenResponse.Builder - Class in org.springframework.security.oauth2.core.endpoint

A builder for OAuth2AccessTokenResponse.

OAuth2AccessTokenResponseHttpMessageConverter - Class in org.springframework.security.oauth2.core.http.converter

A HttpMessageConverter for an OAuth 2.0 Access Token Response.

OAuth2AccessTokenResponseHttpMessageConverter() - Constructor for class org.springframework.security.oauth2.core.http.converter.OAuth2AccessTokenResponseHttpMessageConverter

OAuth2AuthenticatedPrincipal - Interface in org.springframework.security.oauth2.core

An AuthenticatedPrincipal that represents the principal associated with an OAuth 2.0 token.

OAuth2AuthenticationException - Exception in org.springframework.security.oauth2.core

This exception is thrown for all OAuth 2.0 related Authentication errors.

OAuth2AuthenticationException(OAuth2Error) - Constructor for exception org.springframework.security.oauth2.core.OAuth2AuthenticationException

Constructs an OAuth2AuthenticationException using the provided parameters.

OAuth2AuthenticationException(OAuth2Error, Throwable) - Constructor for exception org.springframework.security.oauth2.core.OAuth2AuthenticationException

Constructs an OAuth2AuthenticationException using the provided parameters.

OAuth2AuthenticationException(OAuth2Error, String) - Constructor for exception org.springframework.security.oauth2.core.OAuth2AuthenticationException

Constructs an OAuth2AuthenticationException using the provided parameters.

OAuth2AuthenticationException(OAuth2Error, String, Throwable) - Constructor for exception org.springframework.security.oauth2.core.OAuth2AuthenticationException

Constructs an OAuth2AuthenticationException using the provided parameters.

OAuth2AuthorizationException - Exception in org.springframework.security.oauth2.core

Base exception for OAuth 2.0 Authorization errors.

OAuth2AuthorizationException(OAuth2Error) - Constructor for exception org.springframework.security.oauth2.core.OAuth2AuthorizationException

Constructs an OAuth2AuthorizationException using the provided parameters.

OAuth2AuthorizationException(OAuth2Error, Throwable) - Constructor for exception org.springframework.security.oauth2.core.OAuth2AuthorizationException

Constructs an OAuth2AuthorizationException using the provided parameters.

OAuth2AuthorizationExchange - Class in org.springframework.security.oauth2.core.endpoint

An "exchange" of an OAuth 2.0 Authorization Request and Response for the authorization code grant type.

OAuth2AuthorizationExchange(OAuth2AuthorizationRequest, OAuth2AuthorizationResponse) - Constructor for class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationExchange

Constructs a new OAuth2AuthorizationExchange with the provided Authorization Request and Authorization Response.

OAuth2AuthorizationRequest - Class in org.springframework.security.oauth2.core.endpoint

A representation of an OAuth 2.0 Authorization Request for the authorization code grant type or implicit grant type.

OAuth2AuthorizationRequest.Builder - Class in org.springframework.security.oauth2.core.endpoint

A builder for OAuth2AuthorizationRequest.

OAuth2AuthorizationResponse - Class in org.springframework.security.oauth2.core.endpoint

A representation of an OAuth 2.0 Authorization Response for the authorization code grant type.

OAuth2AuthorizationResponse.Builder - Class in org.springframework.security.oauth2.core.endpoint

A builder for OAuth2AuthorizationResponse.

OAuth2AuthorizationResponseType - Class in org.springframework.security.oauth2.core.endpoint

The response_type parameter is consumed by the authorization endpoint which is used by the authorization code grant type and implicit grant type.

OAuth2BodyExtractors - Class in org.springframework.security.oauth2.core.web.reactive.function

Static factory methods for OAuth2 BodyExtractor implementations.

OAuth2Error - Class in org.springframework.security.oauth2.core

A representation of an OAuth 2.0 Error.

OAuth2Error(String) - Constructor for class org.springframework.security.oauth2.core.OAuth2Error

Constructs an OAuth2Error using the provided parameters.

OAuth2Error(String, String, String) - Constructor for class org.springframework.security.oauth2.core.OAuth2Error

Constructs an OAuth2Error using the provided parameters.

OAuth2ErrorCodes - Interface in org.springframework.security.oauth2.core

Standard error codes defined by the OAuth 2.0 Authorization Framework.

OAuth2ErrorHttpMessageConverter - Class in org.springframework.security.oauth2.core.http.converter

A HttpMessageConverter for an OAuth 2.0 Error.

OAuth2ErrorHttpMessageConverter() - Constructor for class org.springframework.security.oauth2.core.http.converter.OAuth2ErrorHttpMessageConverter

OAuth2ParameterNames - Interface in org.springframework.security.oauth2.core.endpoint

Standard and custom (non-standard) parameter names defined in the OAuth Parameters Registry and used by the authorization endpoint and token endpoint.

OAuth2RefreshToken - Class in org.springframework.security.oauth2.core

An implementation of an AbstractOAuth2Token representing an OAuth 2.0 Refresh Token.

OAuth2RefreshToken(String, Instant) - Constructor for class org.springframework.security.oauth2.core.OAuth2RefreshToken

Constructs an OAuth2RefreshToken using the provided parameters.

OAuth2TokenValidator<T extends AbstractOAuth2Token> - Interface in org.springframework.security.oauth2.core

Implementations of this interface are responsible for "verifying" the validity and/or constraints of the attributes contained in an OAuth 2.0 Token.

OAuth2TokenValidatorResult - Class in org.springframework.security.oauth2.core

A result emitted from an OAuth2TokenValidator validation attempt

OAuth2User - Interface in org.springframework.security.oauth2.core.user

A representation of a user Principal that is registered with an OAuth 2.0 Provider.

OAuth2UserAuthority - Class in org.springframework.security.oauth2.core.user

A GrantedAuthority that may be associated to an OAuth2User.

OAuth2UserAuthority(Map<String, Object>) - Constructor for class org.springframework.security.oauth2.core.user.OAuth2UserAuthority

Constructs a OAuth2UserAuthority using the provided parameters and defaults OAuth2UserAuthority.getAuthority() to ROLE_USER.

OAuth2UserAuthority(String, Map<String, Object>) - Constructor for class org.springframework.security.oauth2.core.user.OAuth2UserAuthority

Constructs a OAuth2UserAuthority using the provided parameters.

OidcIdToken - Class in org.springframework.security.oauth2.core.oidc

An implementation of an AbstractOAuth2Token representing an OpenID Connect Core 1.0 ID Token.

OidcIdToken(String, Instant, Instant, Map<String, Object>) - Constructor for class org.springframework.security.oauth2.core.oidc.OidcIdToken

Constructs a OidcIdToken using the provided parameters.

OidcParameterNames - Interface in org.springframework.security.oauth2.core.oidc.endpoint

Standard parameter names defined in the OAuth Parameters Registry and used by the authorization endpoint and token endpoint.

OidcScopes - Interface in org.springframework.security.oauth2.core.oidc

The scope values defined by the OpenID Connect Core 1.0 specification that can be used to request claims.

OidcUser - Interface in org.springframework.security.oauth2.core.oidc.user

A representation of a user Principal that is registered with an OpenID Connect 1.0 Provider.

OidcUserAuthority - Class in org.springframework.security.oauth2.core.oidc.user

A GrantedAuthority that may be associated to an OidcUser.

OidcUserAuthority(OidcIdToken) - Constructor for class org.springframework.security.oauth2.core.oidc.user.OidcUserAuthority

Constructs a OidcUserAuthority using the provided parameters.

OidcUserAuthority(OidcIdToken, OidcUserInfo) - Constructor for class org.springframework.security.oauth2.core.oidc.user.OidcUserAuthority

Constructs a OidcUserAuthority using the provided parameters and defaults OAuth2UserAuthority.getAuthority() to ROLE_USER.

OidcUserAuthority(String, OidcIdToken, OidcUserInfo) - Constructor for class org.springframework.security.oauth2.core.oidc.user.OidcUserAuthority

Constructs a OidcUserAuthority using the provided parameters.

OidcUserInfo - Class in org.springframework.security.oauth2.core.oidc

A representation of a UserInfo Response that is returned from the OAuth 2.0 Protected Resource UserInfo Endpoint.

OidcUserInfo(Map<String, Object>) - Constructor for class org.springframework.security.oauth2.core.oidc.OidcUserInfo

Constructs a OidcUserInfo using the provided parameters.

OPENID - Static variable in interface org.springframework.security.oauth2.core.oidc.OidcScopes

The openid scope is required for OpenID Connect Authentication Requests.

org.springframework.security.oauth2.core - package org.springframework.security.oauth2.core

Core classes and interfaces providing support for the OAuth 2.0 Authorization Framework.

org.springframework.security.oauth2.core.converter - package org.springframework.security.oauth2.core.converter

org.springframework.security.oauth2.core.endpoint - package org.springframework.security.oauth2.core.endpoint

Support classes that model the OAuth 2.0 Request and Response messages from the Authorization Endpoint and Token Endpoint.

org.springframework.security.oauth2.core.http.converter - package org.springframework.security.oauth2.core.http.converter

org.springframework.security.oauth2.core.oidc - package org.springframework.security.oauth2.core.oidc

Core classes and interfaces providing support for OpenID Connect Core 1.0.

org.springframework.security.oauth2.core.oidc.endpoint - package org.springframework.security.oauth2.core.oidc.endpoint

Support classes that model the OpenID Connect Core 1.0 Request and Response messages from the Authorization Endpoint and Token Endpoint.

org.springframework.security.oauth2.core.oidc.user - package org.springframework.security.oauth2.core.oidc.user

Provides a model for an OpenID Connect Core 1.0 representation of a user Principal.

org.springframework.security.oauth2.core.user - package org.springframework.security.oauth2.core.user

Provides a model for an OAuth 2.0 representation of a user Principal.

org.springframework.security.oauth2.core.web.reactive.function - package org.springframework.security.oauth2.core.web.reactive.function

P

PASSWORD - Static variable in class org.springframework.security.oauth2.core.AuthorizationGrantType

PASSWORD - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

password - used in Access Token Request.

PHONE - Static variable in interface org.springframework.security.oauth2.core.oidc.OidcScopes

The phone scope requests access to the phone_number and phone_number_verified claims.

PHONE_NUMBER - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

phone_number - the user's preferred phone number

PHONE_NUMBER_VERIFIED - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

phone_number_verified - true if the user's phone number has been verified, otherwise false

PICTURE - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

picture - the URL of the user's profile picture

PkceParameterNames - Interface in org.springframework.security.oauth2.core.endpoint

Standard parameter names defined in the OAuth Parameters Registry and used by the authorization endpoint and token endpoint.

POST - Static variable in class org.springframework.security.oauth2.core.ClientAuthenticationMethod

postalCode(String) - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim.Builder

Sets the zip code or postal code.

PREFERRED_USERNAME - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

preferred_username - the preferred username that the user wishes to be referred to

PROFILE - Static variable in interface org.springframework.security.oauth2.core.oidc.OidcScopes

The profile scope requests access to the default profile claims, which are: name, family_name, given_name, middle_name, nickname, preferred_username, profile, picture, website, gender, birthdate, zoneinfo, locale, updated_at.

PROFILE - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

profile - the URL of the user's profile page

Q

QUERY - Static variable in class org.springframework.security.oauth2.core.AuthenticationMethod

R

readInternal(Class<? extends OAuth2AccessTokenResponse>, HttpInputMessage) - Method in class org.springframework.security.oauth2.core.http.converter.OAuth2AccessTokenResponseHttpMessageConverter

readInternal(Class<? extends OAuth2Error>, HttpInputMessage) - Method in class org.springframework.security.oauth2.core.http.converter.OAuth2ErrorHttpMessageConverter

REDIRECT_URI - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

redirect_uri - used in Authorization Request and Access Token Request.

redirectUri(String) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder

Sets the uri for the redirection endpoint.

redirectUri(String) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse.Builder

Sets the uri where the response was redirected to.

REFRESH_TOKEN - Static variable in class org.springframework.security.oauth2.core.AuthorizationGrantType

REFRESH_TOKEN - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

refresh_token - used in Access Token Request and Access Token Response.

refreshToken(String) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse.Builder

Sets the refresh token associated to the access token.

region(String) - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim.Builder

Sets the state, province, prefecture, or region.

REGISTRATION_ID - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

Non-standard parameter (used internally).

RESPONSE_TYPE - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

response_type - used in Authorization Request.

S

scope(String...) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder

Sets the scope(s).

SCOPE - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

scope - used in Authorization Request, Authorization Response, Access Token Request and Access Token Response.

scopes(Set<String>) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse.Builder

Sets the scope(s) associated to the access token.

scopes(Set<String>) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder

Sets the scope(s).

SERVER_ERROR - Static variable in interface org.springframework.security.oauth2.core.OAuth2ErrorCodes

server_error - The authorization server encountered an unexpected condition that prevented it from fulfilling the request.

setErrorConverter(Converter<Map<String, String>, OAuth2Error>) - Method in class org.springframework.security.oauth2.core.http.converter.OAuth2ErrorHttpMessageConverter

Sets the Converter used for converting the OAuth 2.0 Error parameters to an OAuth2Error.

setErrorParametersConverter(Converter<OAuth2Error, Map<String, String>>) - Method in class org.springframework.security.oauth2.core.http.converter.OAuth2ErrorHttpMessageConverter

Sets the Converter used for converting the OAuth2Error to a Map representation of the OAuth 2.0 Error parameters.

setTokenResponseConverter(Converter<Map<String, String>, OAuth2AccessTokenResponse>) - Method in class org.springframework.security.oauth2.core.http.converter.OAuth2AccessTokenResponseHttpMessageConverter

Sets the Converter used for converting the OAuth 2.0 Access Token Response parameters to an OAuth2AccessTokenResponse.

setTokenResponseParametersConverter(Converter<OAuth2AccessTokenResponse, Map<String, String>>) - Method in class org.springframework.security.oauth2.core.http.converter.OAuth2AccessTokenResponseHttpMessageConverter

Sets the Converter used for converting the OAuth2AccessTokenResponse to a Map representation of the OAuth 2.0 Access Token Response parameters.

StandardClaimAccessor - Interface in org.springframework.security.oauth2.core.oidc

A ClaimAccessor for the "Standard Claims" that can be returned either in the UserInfo Response or the ID Token.

StandardClaimNames - Interface in org.springframework.security.oauth2.core.oidc

The names of the "Standard Claims" defined by the OpenID Connect Core 1.0 specification that can be returned either in the UserInfo Response or the ID Token.

state(String) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest.Builder

Sets the state.

state(String) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse.Builder

Sets the state.

STATE - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

state - used in Authorization Request and Authorization Response.

statusError() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse

Returns true if the Authorization Request failed, otherwise false.

statusOk() - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse

Returns true if the Authorization Request succeeded, otherwise false.

streetAddress(String) - Method in class org.springframework.security.oauth2.core.oidc.DefaultAddressStandardClaim.Builder

Sets the full street address, which may include house number, street name, P.O.

SUB - Static variable in interface org.springframework.security.oauth2.core.oidc.IdTokenClaimNames

sub - the Subject identifier

SUB - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

sub - the Subject identifier

success(String) - Static method in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponse

Returns a new OAuth2AuthorizationResponse.Builder, initialized with the authorization code.

success() - Static method in class org.springframework.security.oauth2.core.OAuth2TokenValidatorResult

Construct a successful OAuth2TokenValidatorResult

supports(Class<?>) - Method in class org.springframework.security.oauth2.core.http.converter.OAuth2AccessTokenResponseHttpMessageConverter

supports(Class<?>) - Method in class org.springframework.security.oauth2.core.http.converter.OAuth2ErrorHttpMessageConverter

T

TEMPORARILY_UNAVAILABLE - Static variable in interface org.springframework.security.oauth2.core.OAuth2ErrorCodes

temporarily_unavailable - The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

TOKEN - Static variable in class org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponseType

TOKEN_TYPE - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

token_type - used in Authorization Response and Access Token Response.

tokenResponseConverter - Variable in class org.springframework.security.oauth2.core.http.converter.OAuth2AccessTokenResponseHttpMessageConverter

tokenResponseParametersConverter - Variable in class org.springframework.security.oauth2.core.http.converter.OAuth2AccessTokenResponseHttpMessageConverter

tokenType(OAuth2AccessToken.TokenType) - Method in class org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse.Builder

Sets the token type.

toString() - Method in class org.springframework.security.oauth2.core.OAuth2Error

toString() - Method in class org.springframework.security.oauth2.core.user.DefaultOAuth2User

toString() - Method in class org.springframework.security.oauth2.core.user.OAuth2UserAuthority

U

UNAUTHORIZED_CLIENT - Static variable in interface org.springframework.security.oauth2.core.OAuth2ErrorCodes

unauthorized_client - The client is not authorized to request an authorization code or access token using this method.

UNSUPPORTED_GRANT_TYPE - Static variable in interface org.springframework.security.oauth2.core.OAuth2ErrorCodes

unsupported_grant_type - The authorization grant type is not supported by the authorization server.

UNSUPPORTED_RESPONSE_TYPE - Static variable in interface org.springframework.security.oauth2.core.OAuth2ErrorCodes

unsupported_response_type - The authorization server does not support obtaining an authorization code or access token using this method.

UPDATED_AT - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

updated_at - the time the user's information was last updated

USERNAME - Static variable in interface org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames

username - used in Access Token Request.

V

validate(T) - Method in class org.springframework.security.oauth2.core.DelegatingOAuth2TokenValidator

Verify the validity and/or constraints of the provided OAuth 2.0 Token.

validate(T) - Method in interface org.springframework.security.oauth2.core.OAuth2TokenValidator

Verify the validity and/or constraints of the provided OAuth 2.0 Token.

W

WEBSITE - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

website - the URL of the user's web page or blog

withResponse(OAuth2AccessTokenResponse) - Static method in class org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse

Returns a new OAuth2AccessTokenResponse.Builder, initialized with the provided response

withToken(String) - Static method in class org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse

Returns a new OAuth2AccessTokenResponse.Builder, initialized with the provided access token value.

writeInternal(OAuth2AccessTokenResponse, HttpOutputMessage) - Method in class org.springframework.security.oauth2.core.http.converter.OAuth2AccessTokenResponseHttpMessageConverter

writeInternal(OAuth2Error, HttpOutputMessage) - Method in class org.springframework.security.oauth2.core.http.converter.OAuth2ErrorHttpMessageConverter

Z

ZONEINFO - Static variable in interface org.springframework.security.oauth2.core.oidc.StandardClaimNames

zoneinfo - the user's time zone

A B C D E F G H I L M N O P Q R S T U V W Z