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

Class OidcClientRegistration

java.lang.Object

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

All Implemented Interfaces:

Serializable, org.springframework.security.oauth2.core.ClaimAccessor, OidcClientMetadataClaimAccessor

public final class OidcClientRegistration
extends Object
implements OidcClientMetadataClaimAccessor, Serializable

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:

0.1.1

See Also:

• 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 class	OidcClientRegistration.Builder	Helps configure an OidcClientRegistration.

Method Summary

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

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, hasClaim

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

getClientId, getClientIdIssuedAt, getClientName, getClientSecret, getClientSecretExpiresAt, getGrantTypes, getIdTokenSignedResponseAlgorithm, getJwkSetUrl, getPostLogoutRedirectUris, getRedirectUris, getRegistrationAccessToken, getRegistrationClientUrl, getResponseTypes, getScopes, getTokenEndpointAuthenticationMethod, getTokenEndpointAuthenticationSigningAlgorithm

Method Details

getClaims

public Map<String,Object> getClaims()

Returns the metadata as claims.

Specified by:

getClaims in interface org.springframework.security.oauth2.core.ClaimAccessor

Returns:

a Map of the metadata as claims

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