Base of all OAuth Token Procedure contexts.

Hierarchy

Properties

accessTokenClaimNames: null | string

Returns

string with space separated list of claim names for the 'access-token' usage.

accessTokenIssuer: ScriptAccessTokenIssuer
authorizationCodeIssuer: ScriptAuthorizationCodeNonceIssuer
claims: any[]

Deprecated

it's not possible to provide a single bag of claims like this without losing information about the groups the claims are in, which may provide different properties.

Deprecated

The OAuth client that made the request.

defaultAccessTokenData: null | object

Compute and return the default access-token data.

Returns

the default data, or claims, for the 'access-token' ClaimUsage.

defaultAccessTokenJwtIssuer: null | DelegationBasedScriptTokenIssuer
defaultAuthorizationCodeData: null | object

Compute and return the default authorization-code data.

Returns

the default data, or claims, for the 'authorization-code' ClaimUsage.

defaultDelegationData: null | object

Compute and return the default delegation (authorization grant) data.

Returns

the default data, or claims, for the 'delegation' ClaimUsage.

defaultDeviceCodeData: null | object

Compute and return the default device-code data.

Returns

the default data, or claims, for the 'device-code' ClaimUsage.

defaultIdTokenData: null | object

Compute and return the default id-token data.

Returns

the default data, or claims, for the 'id-token' ClaimUsage.

defaultRefreshTokenData: null | object

Compute and return the default refresh-token data.

Returns

the default data, or claims, for the 'refresh-token' ClaimUsage.

defaultResponseData: null | object

All known fields to be returned as response data, initialized with default values, or null if the default or configured behaviour of this DefaultClaimsValuesProvider-implementation should not return this kind of data.

delegationIssuer: ScriptDelegationIssuer
idTokenIssuer: ScriptIdTokenIssuer

Returns

the default ID-token Token Issuer that can be used with the OAuth client.

json: Json

Get the JSON helper for serializing/de-serializing JavaScript and Java types.

refreshTokenIssuer: ScriptRefreshTokenIssuer
request: ScriptRequest

The original request object. This can be used to access headers and parameters passed in the original request.

response: ScriptResponse

The Response object. Can be used to modify cookies in the response.

scope: string

Returns

The string-value with the authorized scopes joined.

scopeNames: any[]

Returns

the scope names that are authorized to be added to a token, in this request, as a collection.

scopes: ScriptScope[]

Returns

the scopes instances that are authorized to be added to a token, in this request.

tokenProcedureContextName: string

Returns

a string that describes the type of this token procedure context.

Methods

  • Returns

    a map of the authentication's ContextAttributes.

    Returns object

  • Returns

    a map of the authentication's ContextAttributes, including attribute's authorities metadata.

    Returns object

  • Returns

    string with space separated list of claim names for the 'access-token' usage.

    Returns null | string

  • Returns

    the bucket data source with the given ID, or null if it does not exist.

    Parameters

    • dataSourceId: string

    Returns null | ScriptBucket

  • Returns

    string with space separated list of claim names, or null when an unknown usage was provided.

    Parameters

    • usage: string

    Returns null | string

  • Deprecated

    it's not possible to provide a single bag of claims like this without losing information about the groups the claims are in, which may provide different properties.

    Deprecated

    Returns any[]

  • Compute and return the default authorization-code data.

    Returns

    the default data, or claims, for the 'authorization-code' ClaimUsage.

    Returns null | object

  • Get the cached authorization-code data, or compute then return it.

    Returns

    the default data, or claims, for the 'authorization-code' ClaimUsage.

    Parameters

    Returns null | object

  • Get the default claims for the given ClaimUsage.

    Parameters

    • usage: string

    Returns null | object

  • Get the default claims for the given ClaimUsage. Use the provided cache to resolve claim values when possible.

    Parameters

    Returns null | object

  • Compute and return the default device-code data.

    Returns

    the default data, or claims, for the 'device-code' ClaimUsage.

    Returns null | object

  • Get the cached device authorization code data, or compute then return it.

    Returns

    the default data, or claims, for the 'device-code' ClaimUsage.

    Parameters

    Returns null | object

  • Compute and return the default refresh-token data.

    Returns

    the default data, or claims, for the 'refresh-token' ClaimUsage.

    Returns null | object

  • Get the cached refresh-token data, or compute then return it.

    Returns

    the default data, or claims, for the 'refresh-token' ClaimUsage.

    Parameters

    Returns null | object

  • All known fields to be returned as response data, initialized with default values, or null if the default or configured behaviour of this DefaultClaimsValuesProvider-implementation should not return this kind of data.

    Returns null | object

  • All known fields to be returned as response data, initialized with default values, or null if the default or configured behaviour of this DefaultClaimsValuesProvider-implementation should not return this kind of data.

    Parameters

    • cache: null | ClaimValuesProvider

      the cache to pull already resolved claim values from. Pass null to resolve new values.

    Returns null | object

  • Get the JSON helper for serializing/de-serializing JavaScript and Java types.

    Returns Json

  • Returns

    The string-value with the authorized scopes joined.

    Returns string

  • Returns

    the scope names that are authorized to be added to a token, in this request, as a collection.

    Returns any[]

  • Returns

    the scopes instances that are authorized to be added to a token, in this request.

    Returns ScriptScope[]

  • Issue a delegation (authorization grant) with the provided data.

    Parameters

    • delegationMap: object

      The claims being authorized by the user.

    Returns ScriptDelegation

  • Returns

    a map of the SubjectAttributes of the authenticated subject.

    Returns object

  • Returns

    a map of the SubjectAttributes of the authenticated subject, including attribute's authorities metadata.

    Returns object