Interface TransformationProcedureContext

Context for attribute transformation procedures.

Hierarchy

RequestScopeProcedureContext
QueryParameterContainer
SessionManagerContainer
- TransformationProcedureContext

Properties

actionAttributeMap

actionAttributeMap: null | object

Gets the authentication action attributes in a mapView format. Only available when the transformation procedure is used in a context that provides this type of attributes.

Returns

authentication action attributes in MapView format.

attributeMap

attributeMap: object

Gets the attributes to transform in a mapView format.

Returns

attributes to transform in MapView format.

contextAttributeMap

contextAttributeMap: null | JsonObject & {
    acr?: string;
    expiresAt: number;
    scope: string;
    sid?: string;
}

Gets the authentication context attributes in a mapView format. Only available when the transformation procedure is used in a context that provides this type of attributes.

Returns

authentication context attributes in MapView format.

json

json: Json

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

originalQueryParameters

originalQueryParameters: ScriptQueryParameterCollection

Get the query-string used in OAuth authorization requests and authentication requests.

request

request: ScriptRequest

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

requestingOAuthClient

requestingOAuthClient: null | OAuthClientConfiguration

response

response: ScriptResponse

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

sessionManager

sessionManager: ScriptSessionManager

subjectAttributeMap

subjectAttributeMap: null | JsonObject & {
subject: string;
}

Gets the authentication subject attributes in a mapView format. Only available when the transformation procedure is used in a context that provides this type of attributes.

Returns

authentication subject attributes in MapView format.

Methods

describe

describe(): string
Deprecated
Please use the Procedures API Documentation instead: https://curity.io/docs/idsvr/latest/developer-guide/scripting/index.html#scripting-guide

Returns string
Inherited from RequestScopeProcedureContext.describe
- Defined in typescript-definitions.ts:2302

describeInterface

describeInterface(): string
Deprecated
Please use the Procedures API Documentation instead: https://curity.io/docs/idsvr/latest/developer-guide/scripting/index.html#scripting-guide

Returns string
Inherited from RequestScopeProcedureContext.describeInterface
- Defined in typescript-definitions.ts:2307

getActionAttributeMap

getActionAttributeMap(): null | object
Gets the authentication action attributes in a mapView format. Only available when the transformation procedure is used in a context that provides this type of attributes.

Returns
authentication action attributes in MapView format.

Returns null | object
- Defined in typescript-definitions.ts:2580

getAttributeDataSource

getAttributeDataSource(dataSourceId: string): null | AttributeDataAccessProvider
Returns
the attributes data source with the given ID, or null if it does not exist.
Parameters
- dataSourceId: string
Returns null | AttributeDataAccessProvider
Inherited from RequestScopeProcedureContext.getAttributeDataSource
- Defined in typescript-definitions.ts:3237

getAttributeMap

getAttributeMap(): object
Gets the attributes to transform in a mapView format.

Returns
attributes to transform in MapView format.

Returns object
- Defined in typescript-definitions.ts:2594

getBucket

getBucket(dataSourceId: string): null | ScriptBucket
Returns
the bucket data source with the given ID, or null if it does not exist.
Parameters
- dataSourceId: string
Returns null | ScriptBucket
Inherited from RequestScopeProcedureContext.getBucket
- Defined in typescript-definitions.ts:3244

getContextAttributeMap

getContextAttributeMap(): null | JsonObject & {
    acr?: string;
    expiresAt: number;
    scope: string;
    sid?: string;
}
Gets the authentication context attributes in a mapView format. Only available when the transformation procedure is used in a context that provides this type of attributes.

Returns
authentication context attributes in MapView format.

Returns null | JsonObject & {
    acr?: string;
    expiresAt: number;
    scope: string;
    sid?: string;
}
- Defined in typescript-definitions.ts:2608

getJson

getJson(): Json
Get the JSON helper for serializing/de-serializing JavaScript and Java types.

Returns Json
Inherited from RequestScopeProcedureContext.getJson
- Defined in typescript-definitions.ts:2312

getOriginalQueryParameters

getOriginalQueryParameters(): ScriptQueryParameterCollection
Get the query-string used in OAuth authorization requests and authentication requests.

Returns ScriptQueryParameterCollection
Inherited from QueryParameterContainer.getOriginalQueryParameters
- Defined in typescript-definitions.ts:3254

getRequest

getRequest(): ScriptRequest
The original request object. This can be used to access headers and parameters passed in the original request.

Returns ScriptRequest
Inherited from RequestScopeProcedureContext.getRequest
- Defined in typescript-definitions.ts:3269

getRequestingOAuthClient

getRequestingOAuthClient(): null | OAuthClientConfiguration
Returns null | OAuthClientConfiguration
- Defined in typescript-definitions.ts:2618

getResponse

getResponse(): ScriptResponse
The Response object. Can be used to modify cookies in the response.

Returns ScriptResponse
Inherited from RequestScopeProcedureContext.getResponse
- Defined in typescript-definitions.ts:3284

getSessionManager

getSessionManager(): ScriptSessionManager
Returns ScriptSessionManager
Inherited from SessionManagerContainer.getSessionManager
- Defined in typescript-definitions.ts:3296

getSubjectAttributeMap

getSubjectAttributeMap(): null | JsonObject & {
subject: string;
}
Gets the authentication subject attributes in a mapView format. Only available when the transformation procedure is used in a context that provides this type of attributes.

Returns
authentication subject attributes in MapView format.

Returns null | JsonObject & {
subject: string;
}
- Defined in typescript-definitions.ts:2628

Interface TransformationProcedureContext

Hierarchy

Index

Properties

Methods

Properties

actionAttributeMap

Returns

attributeMap

Returns

contextAttributeMap

Returns

json

originalQueryParameters

request

requestingOAuthClient

response

sessionManager

subjectAttributeMap

Returns

Methods

describe

Deprecated

Returns string

describeInterface

Deprecated

Returns string

getActionAttributeMap

Returns

Returns null | object

getAttributeDataSource

Returns

Parameters

dataSourceId: string

Returns null | AttributeDataAccessProvider

getAttributeMap

Returns

Returns object

getBucket

Returns

Parameters

dataSourceId: string

Returns null | ScriptBucket

getContextAttributeMap

Returns

Returns null | JsonObject & { acr?: string; expiresAt: number; scope: string; sid?: string; }

getJson

Returns Json

getOriginalQueryParameters

Returns ScriptQueryParameterCollection

getRequest

Returns ScriptRequest

getRequestingOAuthClient

Returns null | OAuthClientConfiguration

getResponse

Returns ScriptResponse

getSessionManager

Returns ScriptSessionManager

getSubjectAttributeMap

Returns

Returns null | JsonObject & { subject: string; }

Settings

Member Visibility

Theme

Returns null | JsonObject & {
acr?: string;
expiresAt: number;
scope: string;
sid?: string;
}

Returns null | JsonObject & {
subject: string;
}