Interface OidcClientMetadataClaimAccessor

All Superinterfaces:

org.springframework.security.oauth2.core.ClaimAccessor, OAuth2ClientMetadataClaimAccessor

All Known Implementing Classes:

OidcClientRegistration

public interface OidcClientMetadataClaimAccessor
extends OAuth2ClientMetadataClaimAccessor

A ClaimAccessor for the "claims" that are contained in the OpenID Client Registration Request and Response.

Since:

7.0

See Also:

• OAuth2ClientMetadataClaimAccessor
• OidcClientMetadataClaimNames
• OidcClientRegistration
• 2. Client Metadata
• 3.1. Client Registration Metadata

Method Summary

Modifier and Type	Method	Description
default @Nullable String	getIdTokenSignedResponseAlgorithm()	Returns the JWS algorithm required for signing the ID Token issued to the Client (id_token_signed_response_alg).
default @Nullable List<String>	getPostLogoutRedirectUris()	Returns the post logout redirection URI values used by the Client (post_logout_redirect_uris).
default @Nullable String	getRegistrationAccessToken()	Returns the Registration Access Token that can be used at the Client Configuration Endpoint.
default @Nullable URL	getRegistrationClientUrl()	Returns the URL of the Client Configuration Endpoint where the Registration Access Token can be used.
default @Nullable String	getTokenEndpointAuthenticationSigningAlgorithm()	Returns the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods (token_endpoint_auth_signing_alg).

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

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

Methods inherited from interface OAuth2ClientMetadataClaimAccessor

getClientId, getClientIdIssuedAt, getClientName, getClientSecret, getClientSecretExpiresAt, getGrantTypes, getJwkSetUrl, getRedirectUris, getResponseTypes, getScopes, getTokenEndpointAuthenticationMethod

Method Details

getPostLogoutRedirectUris

default @Nullable List<String> getPostLogoutRedirectUris()

Returns the post logout redirection URI values used by the Client (post_logout_redirect_uris). The post_logout_redirect_uri parameter is used by the client when requesting that the End-User's User Agent be redirected to after a logout has been performed.

Returns:

the post logout redirection URI values used by the Client

getTokenEndpointAuthenticationSigningAlgorithm

default @Nullable String getTokenEndpointAuthenticationSigningAlgorithm()

Returns the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods (token_endpoint_auth_signing_alg).

Returns:

the JWS algorithm that must be used for signing the JWT used to authenticate the Client at the Token Endpoint

getIdTokenSignedResponseAlgorithm

default @Nullable String getIdTokenSignedResponseAlgorithm()

Returns the JWS algorithm required for signing the ID Token issued to the Client (id_token_signed_response_alg).

Returns:

the JWS algorithm required for signing the ID Token issued to the Client

getRegistrationAccessToken

default @Nullable String getRegistrationAccessToken()

Returns the Registration Access Token that can be used at the Client Configuration Endpoint.

Returns:

the Registration Access Token that can be used at the Client Configuration Endpoint

getRegistrationClientUrl

default @Nullable URL getRegistrationClientUrl()

Returns the URL of the Client Configuration Endpoint where the Registration Access Token can be used.

Returns:

the URL of the Client Configuration Endpoint where the Registration Access Token can be used