Class OAuth2ClientRegistration

java.lang.Object

org.springframework.security.oauth2.server.authorization.AbstractOAuth2ClientRegistration

org.springframework.security.oauth2.server.authorization.OAuth2ClientRegistration

All Implemented Interfaces:

Serializable, ClaimAccessor, OAuth2ClientMetadataClaimAccessor

public final class OAuth2ClientRegistration
extends AbstractOAuth2ClientRegistration

A representation of an OAuth 2.0 Client Registration Request and Response, which is sent to and returned from the Client Registration Endpoint, and contains a set of claims about the Client's Registration information. The claims are defined by the OAuth 2.0 Dynamic Client Registration Protocol specification.

Since:

7.0

See Also:

• AbstractOAuth2ClientRegistration
• 3.1. Client Registration Request
• 3.2.1. Client Registration Response
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OAuth2ClientRegistration.Builder	Helps configure an OAuth2ClientRegistration.

Nested classes/interfaces inherited from class AbstractOAuth2ClientRegistration

AbstractOAuth2ClientRegistration.AbstractBuilder<T,B>

Method Summary

Modifier and Type	Method	Description
static OAuth2ClientRegistration.Builder	builder()	Constructs a new OAuth2ClientRegistration.Builder with empty claims.
static OAuth2ClientRegistration.Builder	withClaims(Map<String,Object> claims)	Constructs a new OAuth2ClientRegistration.Builder with the provided claims.

Methods inherited from class AbstractOAuth2ClientRegistration

getClaims

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ClaimAccessor

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

Methods inherited from interface OAuth2ClientMetadataClaimAccessor

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

Method Details

builder

public static OAuth2ClientRegistration.Builder builder()

Constructs a new OAuth2ClientRegistration.Builder with empty claims.

Returns:

the OAuth2ClientRegistration.Builder

withClaims

public static OAuth2ClientRegistration.Builder withClaims(Map<String,Object> claims)

Constructs a new OAuth2ClientRegistration.Builder with the provided claims.

Parameters:

claims - the claims to initialize the builder

Returns:

the OAuth2ClientRegistration.Builder