Package se.curity.identityserver.sdk.data.events

Class RegisteredDcrClientOAuthEvent

Object

se.curity.identityserver.sdk.data.events.OAuthEvent

se.curity.identityserver.sdk.data.events.RegisteredDcrClientOAuthEvent

All Implemented Interfaces:

SerializableAsMap, AuditableEvent, Event

public class RegisteredDcrClientOAuthEvent
extends OAuthEvent
implements AuditableEvent

Event posted when an OAuth client is dynamically registered (DCR).

Since:

2.3.0

Constructor Summary

Constructors

Constructor

Description

RegisteredDcrClientOAuthEvent(boolean templatized, String clientId, @Nullable String instanceOfClient, @Nullable String initialClient, @Nullable String authenticatedUser, Collection<String> scope, Collection<String> redirectUris, Collection<String> grantTypes, Collection<String> capabilities, @Nullable String clientName, @Nullable String clientUri, @Nullable String logoUri, @Nullable String policyUri, @Nullable String tosUri, OptionalLong defaultMaxAge, Collection<String> allowedOrigins, boolean requiresConsent, OptionalLong refreshTokenTtl, long accessTokenTtl, OptionalLong idTokenTtl, @Nullable String applicationUrl, boolean requireProofKey, Collection<String> disallowedProofKeyChallengeMethods, Collection<String> authenticators, Collection<String> backchannelAuthenticators, Collection<String> authenticatorFilters, String profileId)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asMap()	Get a map representation of this Event.
Integer	getAccessTokenTtl()	Returns the TTL of access tokens issued to the registered client.
Collection<String>	getAllowedOrigins()	Returns the allowed origins for the registered client.
@Nullable String	getApplicationUrl()	Returns the application URL of the registered client.
AuditData	getAuditData()	Get all AuditData associated with this auditable event.
@Nullable String	getAuthenticatedSubject()	Returns the subject of the initial access token.
@Nullable String	getAuthenticatedUser()	Returns the subject of the user the initial access token was issued to.
Collection<String>	getAuthenticatorFilters()	Returns the list of authenticator filters for the registered client.
Collection<String>	getAuthenticators()	Returns the list of allowed authenticators for the registered client.
Collection<String>	getBackchannelAuthenticators()	Returns the list of allowed backchannel authenticators for the registered client.
Collection<String>	getCapabilities()	Returns the capabilities of the registered client.
String	getClientId()	Returns the ID of the registered client.
@Nullable String	getClientName()	Returns the human-readable name of the registered client.
@Nullable String	getClientUri()	URL string of a web page providing information about the client that the authorization server should display to the end-user.
@Nullable Integer	getDefaultMaxAge()	Get the default max age for authentication freshness.
Collection<String>	getDisallowedProofKeyChallengeMethods()	Returns the list of disallowed proof key challenge methods for the registered client.
Collection<String>	getGrantTypes()	Returns the allowed grant types the registered client.
@Nullable Integer	getIdTokenTtl()	Returns the TTL of ID tokens issued to the registered client.
@Nullable String	getInitialClient()	Returns the ID of the client the initial access token was issued to.
@Nullable String	getInstanceOfClient()	Returns the ID of the client used as a template for the registered client.
@Nullable String	getLogoUri()	URL string that points to a human-readable logo that the authorization server should display to the end-user.
@Nullable String	getPolicyUri()	URL string that points to a human-readable privacy policy document that the authorization server should display to the end-user.
Collection<String>	getRedirectUris()	Returns the redirect URIs of the registered client.
@Nullable Integer	getRefreshTokenTtl()	Returns the TTL of refresh tokens issued to the registered client.
boolean	getRequireProofKey()	Returns whether the registered client requires a code flow proof key.
boolean	getRequiresConsent()	Returns whether the registered client requires consent.
Collection<String>	getScope()	Returns the allowed scope of the registered client.
@Nullable String	getTosUri()	URL string that points to a human-readable Terms of Service document that the authorization server should display to the end-user.
boolean	isTemplatized()	Returns whether the registered client was based on a template client.

Methods inherited from class se.curity.identityserver.sdk.data.events.OAuthEvent

getProfileId, getRequestingClientId, getRequestingClientName, getRequestingSubject, toString

Methods inherited from class java.lang.Object

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

Constructor Details

RegisteredDcrClientOAuthEvent

public RegisteredDcrClientOAuthEvent(boolean templatized,
 String clientId,
 @Nullable String instanceOfClient,
 @Nullable String initialClient,
 @Nullable String authenticatedUser,
 Collection<String> scope,
 Collection<String> redirectUris,
 Collection<String> grantTypes,
 Collection<String> capabilities,
 @Nullable String clientName,
 @Nullable String clientUri,
 @Nullable String logoUri,
 @Nullable String policyUri,
 @Nullable String tosUri,
 OptionalLong defaultMaxAge,
 Collection<String> allowedOrigins,
 boolean requiresConsent,
 OptionalLong refreshTokenTtl,
 long accessTokenTtl,
 OptionalLong idTokenTtl,
 @Nullable String applicationUrl,
 boolean requireProofKey,
 Collection<String> disallowedProofKeyChallengeMethods,
 Collection<String> authenticators,
 Collection<String> backchannelAuthenticators,
 Collection<String> authenticatorFilters,
 String profileId)

Method Details

isTemplatized

public boolean isTemplatized()

Returns whether the registered client was based on a template client.

Returns:

true if the the new client was templatized; false otherwise

getClientId

public String getClientId()

Returns the ID of the registered client.

Returns:

the registered client's ID

getInstanceOfClient

@Nullable
public @Nullable String getInstanceOfClient()

Returns the ID of the client used as a template for the registered client.

Returns:

the template client's ID

getInitialClient

@Nullable
public @Nullable String getInitialClient()

Returns the ID of the client the initial access token was issued to.

Returns:

the initial client's ID

getAuthenticatedUser

@Nullable
public @Nullable String getAuthenticatedUser()

Returns the subject of the user the initial access token was issued to.

Returns:

the authenticated user

getAuthenticatedSubject

@Nullable
public @Nullable String getAuthenticatedSubject()

Returns the subject of the initial access token.

Returns:

the authenticated subject

getScope

public Collection<String> getScope()

Returns the allowed scope of the registered client.

Returns:

the registered client's scope

getRedirectUris

public Collection<String> getRedirectUris()

Returns the redirect URIs of the registered client.

Returns:

the registered client's redirect URIs

getGrantTypes

public Collection<String> getGrantTypes()

Returns the allowed grant types the registered client.

Returns:

the registered client's grant types

getCapabilities

public Collection<String> getCapabilities()

Returns the capabilities of the registered client.

Returns:

the registered client's capabilities

getClientName

@Nullable
public @Nullable String getClientName()

Returns the human-readable name of the registered client.

Returns:

the registered client's name

getClientUri

@Nullable
public @Nullable String getClientUri()

URL string of a web page providing information about the client that the authorization server should display to the end-user.

Returns:

client web page URL as a String

getLogoUri

@Nullable
public @Nullable String getLogoUri()

URL string that points to a human-readable logo that the authorization server should display to the end-user.

Returns:

logo URL as a String

getPolicyUri

@Nullable
public @Nullable String getPolicyUri()

URL string that points to a human-readable privacy policy document that the authorization server should display to the end-user.

Returns:

privacy policy URL as a String

getTosUri

@Nullable
public @Nullable String getTosUri()

URL string that points to a human-readable Terms of Service document that the authorization server should display to the end-user.

Returns:

Terms of Service URL as a String

getDefaultMaxAge

@Nullable
public @Nullable Integer getDefaultMaxAge()

Get the default max age for authentication freshness.

Returns:

default max age for authentication freshness

getAllowedOrigins

public Collection<String> getAllowedOrigins()

Returns the allowed origins for the registered client.

Returns:

the registered client's allowed origins

getRequiresConsent

public boolean getRequiresConsent()

Returns whether the registered client requires consent.

Returns:

true if the registered client requires consent; false otherwise

getRefreshTokenTtl

@Nullable
public @Nullable Integer getRefreshTokenTtl()

Returns the TTL of refresh tokens issued to the registered client.

Returns:

the registered client's refresh token TTL

getAccessTokenTtl

public Integer getAccessTokenTtl()

Returns the TTL of access tokens issued to the registered client.

Returns:

the registered client's access token TTL

getIdTokenTtl

@Nullable
public @Nullable Integer getIdTokenTtl()

Returns the TTL of ID tokens issued to the registered client.

Returns:

the registered client's ID token TTL

getApplicationUrl

@Nullable
public @Nullable String getApplicationUrl()

Returns the application URL of the registered client.

Returns:

the registered client's application URL

getRequireProofKey

public boolean getRequireProofKey()

Returns whether the registered client requires a code flow proof key.

Returns:

true if the registered client requires a proof key; false otherwise

getDisallowedProofKeyChallengeMethods

public Collection<String> getDisallowedProofKeyChallengeMethods()

Returns the list of disallowed proof key challenge methods for the registered client.

Returns:

a list of the registered client's disallowed proof keys

getAuthenticators

public Collection<String> getAuthenticators()

Returns the list of allowed authenticators for the registered client.

Returns:

a list of the registered client's authenticators

getBackchannelAuthenticators

public Collection<String> getBackchannelAuthenticators()

Returns the list of allowed backchannel authenticators for the registered client.

Returns:

a list of the registered client's backchannel authenticators

getAuthenticatorFilters

public Collection<String> getAuthenticatorFilters()

Returns the list of authenticator filters for the registered client.

Returns:

a list of the registered client's authenticator filters

getAuditData

public AuditData getAuditData()

Description copied from interface: AuditableEvent

Get all AuditData associated with this auditable event.

This method must always return the same instant of AuditData.

Specified by:

getAuditData in interface AuditableEvent

Returns:

the AuditData concisely describing the auditable data of this event

asMap

public Map<String,Object> asMap()

Description copied from interface: Event

Get a map representation of this Event.

Specified by:

asMap in interface Event

Specified by:

asMap in interface SerializableAsMap

Overrides:

asMap in class OAuthEvent

Returns:

a Map representation of this Event. This can be used to serialize events. Sub-types are encouraged to override this method, calling super.asMap() and enriching the returned mutable Map with the more specific information added by the sub-type.