Package org.springframework.security.oauth2.server.authorization

Interface OAuth2AuthorizationServerMetadataClaimAccessor

All Superinterfaces:

org.springframework.security.oauth2.core.ClaimAccessor

All Known Subinterfaces:

OidcProviderMetadataClaimAccessor

All Known Implementing Classes:

AbstractOAuth2AuthorizationServerMetadata, OAuth2AuthorizationServerMetadata, OidcProviderConfiguration

public interface OAuth2AuthorizationServerMetadataClaimAccessor
extends org.springframework.security.oauth2.core.ClaimAccessor

A ClaimAccessor for the "claims" an Authorization Server describes about its configuration, used in OAuth 2.0 Authorization Server Metadata and OpenID Connect Discovery 1.0.

Since:

0.1.1

See Also:

• ClaimAccessor
• OAuth2AuthorizationServerMetadataClaimNames
• 2. Authorization Server Metadata
• 3. OpenID Provider Metadata
• 4. Device Authorization Grant Metadata
• 3.3 Mutual-TLS Client Certificate-Bound Access Tokens Metadata

Method Summary

Modifier and Type	Method	Description
default URL	getAuthorizationEndpoint()	Returns the URL of the OAuth 2.0 Authorization Endpoint (authorization_endpoint).
default URL	getClientRegistrationEndpoint()	Returns the URL of the OAuth 2.0 Dynamic Client Registration Endpoint (registration_endpoint).
default List<String>	getCodeChallengeMethods()	Returns the Proof Key for Code Exchange (PKCE) code_challenge_method values supported (code_challenge_methods_supported).
default URL	getDeviceAuthorizationEndpoint()	Returns the URL of the OAuth 2.0 Device Authorization Endpoint (device_authorization_endpoint).
default List<String>	getGrantTypes()	Returns the OAuth 2.0 grant_type values supported (grant_types_supported).
default URL	getIssuer()	Returns the URL the Authorization Server asserts as its Issuer Identifier (issuer).
default URL	getJwkSetUrl()	Returns the URL of the JSON Web Key Set (jwks_uri).
default List<String>	getResponseTypes()	Returns the OAuth 2.0 response_type values supported (response_types_supported).
default List<String>	getScopes()	Returns the OAuth 2.0 scope values supported (scopes_supported).
default URL	getTokenEndpoint()	Returns the URL of the OAuth 2.0 Token Endpoint (token_endpoint).
default List<String>	getTokenEndpointAuthenticationMethods()	Returns the client authentication methods supported by the OAuth 2.0 Token Endpoint (token_endpoint_auth_methods_supported).
default URL	getTokenIntrospectionEndpoint()	Returns the URL of the OAuth 2.0 Token Introspection Endpoint (introspection_endpoint).
default List<String>	getTokenIntrospectionEndpointAuthenticationMethods()	Returns the client authentication methods supported by the OAuth 2.0 Token Introspection Endpoint (introspection_endpoint_auth_methods_supported).
default URL	getTokenRevocationEndpoint()	Returns the URL of the OAuth 2.0 Token Revocation Endpoint (revocation_endpoint).
default List<String>	getTokenRevocationEndpointAuthenticationMethods()	Returns the client authentication methods supported by the OAuth 2.0 Token Revocation Endpoint (revocation_endpoint_auth_methods_supported).
default boolean	isTlsClientCertificateBoundAccessTokens()	Returns true to indicate support for mutual-TLS client certificate-bound access tokens (tls_client_certificate_bound_access_tokens).

Methods inherited from interface org.springframework.security.oauth2.core.ClaimAccessor

getClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL, getClaims, hasClaim

Method Details

getIssuer

default URL getIssuer()

Returns the URL the Authorization Server asserts as its Issuer Identifier (issuer).

Returns:

the URL the Authorization Server asserts as its Issuer Identifier

getAuthorizationEndpoint

default URL getAuthorizationEndpoint()

Returns the URL of the OAuth 2.0 Authorization Endpoint (authorization_endpoint).

Returns:

the URL of the OAuth 2.0 Authorization Endpoint

getDeviceAuthorizationEndpoint

default URL getDeviceAuthorizationEndpoint()

Returns the URL of the OAuth 2.0 Device Authorization Endpoint (device_authorization_endpoint).

Returns:

the URL of the OAuth 2.0 Device Authorization Endpoint

Since:

1.1

getTokenEndpoint

default URL getTokenEndpoint()

Returns the URL of the OAuth 2.0 Token Endpoint (token_endpoint).

Returns:

the URL of the OAuth 2.0 Token Endpoint

getTokenEndpointAuthenticationMethods

default List<String> getTokenEndpointAuthenticationMethods()

Returns the client authentication methods supported by the OAuth 2.0 Token Endpoint (token_endpoint_auth_methods_supported).

Returns:

the client authentication methods supported by the OAuth 2.0 Token Endpoint

getJwkSetUrl

default URL getJwkSetUrl()

Returns the URL of the JSON Web Key Set (jwks_uri).

Returns:

the URL of the JSON Web Key Set

getScopes

default List<String> getScopes()

Returns the OAuth 2.0 scope values supported (scopes_supported).

Returns:

the OAuth 2.0 scope values supported

getResponseTypes

default List<String> getResponseTypes()

Returns the OAuth 2.0 response_type values supported (response_types_supported).

Returns:

the OAuth 2.0 response_type values supported

getGrantTypes

default List<String> getGrantTypes()

Returns the OAuth 2.0 grant_type values supported (grant_types_supported).

Returns:

the OAuth 2.0 grant_type values supported

getTokenRevocationEndpoint

default URL getTokenRevocationEndpoint()

Returns the URL of the OAuth 2.0 Token Revocation Endpoint (revocation_endpoint).

Returns:

the URL of the OAuth 2.0 Token Revocation Endpoint

getTokenRevocationEndpointAuthenticationMethods

default List<String> getTokenRevocationEndpointAuthenticationMethods()

Returns the client authentication methods supported by the OAuth 2.0 Token Revocation Endpoint (revocation_endpoint_auth_methods_supported).

Returns:

the client authentication methods supported by the OAuth 2.0 Token Revocation Endpoint

getTokenIntrospectionEndpoint

default URL getTokenIntrospectionEndpoint()

Returns the URL of the OAuth 2.0 Token Introspection Endpoint (introspection_endpoint).

Returns:

the URL of the OAuth 2.0 Token Introspection Endpoint

getTokenIntrospectionEndpointAuthenticationMethods

default List<String> getTokenIntrospectionEndpointAuthenticationMethods()

Returns the client authentication methods supported by the OAuth 2.0 Token Introspection Endpoint (introspection_endpoint_auth_methods_supported).

Returns:

the client authentication methods supported by the OAuth 2.0 Token Introspection Endpoint

getClientRegistrationEndpoint

default URL getClientRegistrationEndpoint()

Returns the URL of the OAuth 2.0 Dynamic Client Registration Endpoint (registration_endpoint).

Returns:

the URL of the OAuth 2.0 Dynamic Client Registration Endpoint

Since:

0.4.0

getCodeChallengeMethods

default List<String> getCodeChallengeMethods()

Returns the Proof Key for Code Exchange (PKCE) code_challenge_method values supported (code_challenge_methods_supported).

Returns:

the code_challenge_method values supported

isTlsClientCertificateBoundAccessTokens

default boolean isTlsClientCertificateBoundAccessTokens()

Returns true to indicate support for mutual-TLS client certificate-bound access tokens (tls_client_certificate_bound_access_tokens).

Returns:

true to indicate support for mutual-TLS client certificate-bound access tokens, false otherwise

Since:

1.3