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

Interface OAuth2ClientMetadataClaimAccessor

All Superinterfaces:
org.springframework.security.oauth2.core.ClaimAccessor
All Known Subinterfaces:
OidcClientMetadataClaimAccessor
All Known Implementing Classes:
AbstractOAuth2ClientRegistration, OAuth2ClientRegistration, OidcClientRegistration
public interface OAuth2ClientMetadataClaimAccessor extends org.springframework.security.oauth2.core.ClaimAccessor
A ClaimAccessor for the claims that are contained in the OAuth 2.0 Client Registration Request and Response.
Since:
7.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getClientId()
    Returns the Client Identifier (client_id).
    default Instant
    getClientIdIssuedAt()
    Returns the time at which the Client Identifier was issued (client_id_issued_at).
    default String
    getClientName()
    Returns the name of the Client to be presented to the End-User (client_name).
    default String
    getClientSecret()
    Returns the Client Secret (client_secret).
    default Instant
    getClientSecretExpiresAt()
    Returns the time at which the client_secret will expire (client_secret_expires_at).
    default List<String>
    getGrantTypes()
    Returns the OAuth 2.0 grant_type values that the Client will restrict itself to using (grant_types).
    default URL
    getJwkSetUrl()
    Returns the URL for the Client's JSON Web Key Set (jwks_uri).
    default List<String>
    getRedirectUris()
    Returns the redirection URI values used by the Client (redirect_uris).
    default List<String>
    getResponseTypes()
    Returns the OAuth 2.0 response_type values that the Client will restrict itself to using (response_types).
    default List<String>
    getScopes()
    Returns the OAuth 2.0 scope values that the Client will restrict itself to using (scope).
    default String
    getTokenEndpointAuthenticationMethod()
    Returns the authentication method used by the Client for the Token Endpoint (token_endpoint_auth_method).

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

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

  • Method Details

    • getClientId

      default String getClientId()
      Returns the Client Identifier (client_id).
      Returns:
      the Client Identifier

    • getClientIdIssuedAt

      default Instant getClientIdIssuedAt()
      Returns the time at which the Client Identifier was issued (client_id_issued_at).
      Returns:
      the time at which the Client Identifier was issued

    • getClientSecret

      default String getClientSecret()
      Returns the Client Secret (client_secret).
      Returns:
      the Client Secret

    • getClientSecretExpiresAt

      default Instant getClientSecretExpiresAt()
      Returns the time at which the client_secret will expire (client_secret_expires_at).
      Returns:
      the time at which the client_secret will expire

    • getClientName

      default String getClientName()
      Returns the name of the Client to be presented to the End-User (client_name).
      Returns:
      the name of the Client to be presented to the End-User

    • getRedirectUris

      default List<String> getRedirectUris()
      Returns the redirection URI values used by the Client (redirect_uris).
      Returns:
      the redirection URI values used by the Client

    • getTokenEndpointAuthenticationMethod

      default String getTokenEndpointAuthenticationMethod()
      Returns the authentication method used by the Client for the Token Endpoint (token_endpoint_auth_method).
      Returns:
      the authentication method used by the Client for the Token Endpoint

    • getGrantTypes

      default List<String> getGrantTypes()
      Returns the OAuth 2.0 grant_type values that the Client will restrict itself to using (grant_types).
      Returns:
      the OAuth 2.0 grant_type values that the Client will restrict itself to using

    • getResponseTypes

      default List<String> getResponseTypes()
      Returns the OAuth 2.0 response_type values that the Client will restrict itself to using (response_types).
      Returns:
      the OAuth 2.0 response_type values that the Client will restrict itself to using

    • getScopes

      default List<String> getScopes()
      Returns the OAuth 2.0 scope values that the Client will restrict itself to using (scope).
      Returns:
      the OAuth 2.0 scope values that the Client will restrict itself to using

    • getJwkSetUrl

      default URL getJwkSetUrl()
      Returns the URL for the Client's JSON Web Key Set (jwks_uri).
      Returns:
      the URL for the Client's JSON Web Key Set (jwks_uri)