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

Class OidcClientRegistration

java.lang.Object

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

org.springframework.security.oauth2.server.authorization.oidc.OidcClientRegistration

All Implemented Interfaces:

Serializable, ClaimAccessor, OAuth2ClientMetadataClaimAccessor, OidcClientMetadataClaimAccessor

public final class OidcClientRegistration
extends AbstractOAuth2ClientRegistration
implements OidcClientMetadataClaimAccessor

A representation of an OpenID 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 OpenID Connect Dynamic Client Registration 1.0 specification.

Since:

7.0

See Also:

• AbstractOAuth2ClientRegistration
• OidcClientMetadataClaimAccessor
• 3.1. Client Registration Request
• 3.2. Client Registration Response
• 3.1. Client Registration Metadata
• Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.springframework.security.oauth2.server.authorization.AbstractOAuth2ClientRegistration

AbstractOAuth2ClientRegistration.AbstractBuilder<T extends AbstractOAuth2ClientRegistration,B extends AbstractOAuth2ClientRegistration.AbstractBuilder<T,B>>

Method Summary

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

Methods inherited from class org.springframework.security.oauth2.server.authorization.AbstractOAuth2ClientRegistration

getClaims

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface org.springframework.security.oauth2.server.authorization.OAuth2ClientMetadataClaimAccessor

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

Methods inherited from interface org.springframework.security.oauth2.server.authorization.oidc.OidcClientMetadataClaimAccessor

getIdTokenSignedResponseAlgorithm, getPostLogoutRedirectUris, getRegistrationAccessToken, getRegistrationClientUrl, getTokenEndpointAuthenticationSigningAlgorithm

Method Details

builder

public static OidcClientRegistration.Builder builder()

Constructs a new OidcClientRegistration.Builder with empty claims.

Returns:

the OidcClientRegistration.Builder

withClaims

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

Constructs a new OidcClientRegistration.Builder with the provided claims.

Parameters:

claims - the claims to initialize the builder

Returns:

the OidcClientRegistration.Builder