Package se.curity.identityserver.sdk.data.authorization

Interface Delegation

All Superinterfaces:

Activatable<DelegationStatus>, SerializableAsMap

public interface Delegation
extends Activatable<DelegationStatus>, SerializableAsMap

A delegation is an authorization grant given by the resource owner to a third-party to access some resource.

The server manages such authorization, which can be materialized in the form of an OAuth token, for example.

The same delegation can be used to issue multiple tokens at different times.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_AUTHENTICATION_ATTRIBUTES
static final String	KEY_AUTHORIZATION_CODE_HASH
static final String	KEY_CLAIM_MAP
static final String	KEY_CLAIMS	claims as used before the configurable claims system was introduced meant "optional attributes".
static final String	KEY_CLIENT_ID
static final String	KEY_CONSENT_ATTRIBUTES
static final String	KEY_CREATED
static final String	KEY_CUSTOM_CLAIM_VALUES
static final String	KEY_EXPIRES
static final String	KEY_ID
static final String	KEY_MTLS_CLIENT_CERTIFICATE
static final String	KEY_MTLS_CLIENT_CERTIFICATE_DN
static final String	KEY_MTLS_CLIENT_CERTIFICATE_X5TS256
static final String	KEY_OWNER
static final String	KEY_REDIRECT_URI
static final String	KEY_REQUESTED_CLAIMS	Deprecated, for removal: This API element is subject to removal in a future version. since 4.2 - scheduled for removal in 8.0.
static final String	KEY_SCOPE
static final String	KEY_SCOPECLAIMS
static final String	KEY_STATUS

Method Summary

Modifier and Type	Method	Description
default Map<String,Object>	asMap()
AuthenticationAttributes	getAuthenticationAttributes()
@Nullable String	getAuthorizationCodeHash()
Map<String,Object>	getClaimMap()
Map<String,Object>	getClaims()
String	getClientId()
@Nullable DelegationConsentResult	getConsentResult()	Returns the consent information stored in the delegation.
long	getCreated()
Map<String,Object>	getCustomClaimValues()
DelegationStatus	getEnumActiveStatus()
long	getExpires()
String	getId()
@Nullable String	getMtlsClientCertificate()
@Nullable String	getMtlsClientCertificateDN()
@Nullable String	getMtlsClientCertificateX5TS256()
String	getOwner()
@Nullable String	getRedirectUri()
String	getScope()
Set<ScopeClaim>	getScopeClaims()	Deprecated. since 4.0.0, prefer to use getClaimMap().
DelegationStatus	getStatus()

Methods inherited from interface se.curity.identityserver.sdk.data.Activatable

isActive

Field Details

KEY_ID

static final String KEY_ID

See Also:

• Constant Field Values

KEY_OWNER

static final String KEY_OWNER

See Also:

• Constant Field Values

KEY_CREATED

static final String KEY_CREATED

See Also:

• Constant Field Values

KEY_SCOPE

static final String KEY_SCOPE

See Also:

• Constant Field Values

KEY_SCOPECLAIMS

static final String KEY_SCOPECLAIMS

See Also:

• Constant Field Values

KEY_CLIENT_ID

static final String KEY_CLIENT_ID

See Also:

• Constant Field Values

KEY_EXPIRES

static final String KEY_EXPIRES

See Also:

• Constant Field Values

KEY_STATUS

static final String KEY_STATUS

See Also:

• Constant Field Values

KEY_AUTHENTICATION_ATTRIBUTES

static final String KEY_AUTHENTICATION_ATTRIBUTES

See Also:

• Constant Field Values

KEY_REQUESTED_CLAIMS

@Deprecated(since="4.2.0",
            forRemoval=true)
static final String KEY_REQUESTED_CLAIMS

Deprecated, for removal: This API element is subject to removal in a future version.

since 4.2 - scheduled for removal in 8.0.

See Also:

• Constant Field Values

KEY_CLAIMS

static final String KEY_CLAIMS

claims as used before the configurable claims system was introduced meant "optional attributes".

See Also:

• Constant Field Values

KEY_REDIRECT_URI

static final String KEY_REDIRECT_URI

See Also:

• Constant Field Values

KEY_AUTHORIZATION_CODE_HASH

static final String KEY_AUTHORIZATION_CODE_HASH

See Also:

• Constant Field Values

KEY_CLAIM_MAP

static final String KEY_CLAIM_MAP

See Also:

• Constant Field Values

KEY_MTLS_CLIENT_CERTIFICATE

static final String KEY_MTLS_CLIENT_CERTIFICATE

See Also:

• Constant Field Values

KEY_MTLS_CLIENT_CERTIFICATE_X5TS256

static final String KEY_MTLS_CLIENT_CERTIFICATE_X5TS256

See Also:

• Constant Field Values

KEY_MTLS_CLIENT_CERTIFICATE_DN

static final String KEY_MTLS_CLIENT_CERTIFICATE_DN

See Also:

• Constant Field Values

KEY_CUSTOM_CLAIM_VALUES

static final String KEY_CUSTOM_CLAIM_VALUES

See Also:

• Constant Field Values

KEY_CONSENT_ATTRIBUTES

static final String KEY_CONSENT_ATTRIBUTES

See Also:

• Constant Field Values

Method Details

getId

String getId()

Returns:

the ID of the token.

getOwner

String getOwner()

Returns:

the owner of the delegation.

getCreated

long getCreated()

Returns:

the time when the delegation was created, in epoch-seconds.

getScope

String getScope()

Returns:

the scopes (whitespace separated) this delegation has.

getScopeClaims

@Deprecated(since="4.0.0")
Set<ScopeClaim> getScopeClaims()

Deprecated.

since 4.0.0, prefer to use getClaimMap().

The expanded claims from the scopes of this delegation.

Returns:

the scope-claims this delegation has.

Since:

3.0.0

getClaimMap

Map<String,Object> getClaimMap()

Returns:

a map from claim usage to the claims granted by this delegation.

Since:

4.0.0

getClientId

String getClientId()

Returns:

the ID of the client that may use tokens based on this delegation.

getRedirectUri

@Nullable
@Nullable String getRedirectUri()

Returns:

the URI to redirect clients to once a token is issued.

getAuthorizationCodeHash

@Nullable
@Nullable String getAuthorizationCodeHash()

Returns:

a hash of the authorization code that initiated issuance of this delegation

getAuthenticationAttributes

AuthenticationAttributes getAuthenticationAttributes()

Returns:

the authentication attributes that this delegation is based on

getCustomClaimValues

Map<String,Object> getCustomClaimValues()

Returns:

a map containing all values for custom claims cached on this delegation

Since:

4.1.0

getExpires

long getExpires()

Specified by:

getExpires in interface Activatable<DelegationStatus>

Returns:

the time when the delegation expires, in epoch-seconds.

getStatus

DelegationStatus getStatus()

Specified by:

getStatus in interface Activatable<DelegationStatus>

Returns:

the current status of this delegation.

getEnumActiveStatus

DelegationStatus getEnumActiveStatus()

Specified by:

getEnumActiveStatus in interface Activatable<DelegationStatus>

Returns:

the current status of this delegation.

getMtlsClientCertificate

@Nullable
@Nullable String getMtlsClientCertificate()

getMtlsClientCertificateX5TS256

@Nullable
@Nullable String getMtlsClientCertificateX5TS256()

getMtlsClientCertificateDN

@Nullable
@Nullable String getMtlsClientCertificateDN()

getConsentResult

@Nullable
@Nullable DelegationConsentResult getConsentResult()

Returns the consent information stored in the delegation.

Returns:

the delegation consent result information.

getClaims

Map<String,Object> getClaims()

Returns:

all fields which are added to the source Map for this delegation but are not known (i.e. not mapped by one of the keys declared in this interface).

asMap

default Map<String,Object> asMap()

Specified by:

asMap in interface SerializableAsMap

Returns:

a Map representing this delegation's full information.