PingAM

OIDC claims scripting API

The following bindings are available to OIDC claims scripts:

This script can be either a legacy or a next-generation script. It has access to all the common bindings for its scripting context.

Learn about converting existing scripts in Migrate OAuth scripts to next-generation scripts.
Binding Description Legacy Next-generation

claims

An object (map) of the default OIDC claims AM provides.

The keys are the claim strings. The values are the claim value objects.

Map

Map

claimLocales

An array of string values from the claims_locales parameter.

Learn more in Claims Languages and Scripts in the OpenID Connect Core 1.0 specification.

Array of Strings

Array of Strings

claimObjects

The default OIDC claims AM provides.

An array of claim objects.

Not available

clientProperties

A map of properties configured in the client profile. Only present if the client was correctly identified.

Find information about the keys in Access client properties.

Map

Map

identity

Represents an identity that AM can access.

Find information about how to use the binding in Access profile data.

An AMIdentity object.

A wrapper object for a scripted identity.

requestedClaims

An object (map) of requested claims. This is empty unless the request includes the claims query string parameter and AM is configured to support its use.

Under Native Consoles > Access Management, go to Realms > Realm Name > Services > OAuth2 Provider > Advanced OpenID Connect. Enable Enable "claims_parameter_supported" and save your change.

Find more information about the claims query string parameter in Requesting Claims using the "claims" Request Parameter in the OpenID Connect Core 1.0 specification.

Map of Set objects

Map of List objects

requestedTypedClaims

This is empty unless the request includes claims.

A claim with a single value means the script should return only that value.

An array of the requested claims objects.

Not available. Use requestedClaims instead.

requestProperties

A read-only object (map) of the request properties.

Learn more in Access request properties.

Map

Map

scopes

The set of scopes in the client request.

Set of Strings

List of Strings

session

A representation of the user’s SSO session object.

An SSOToken object.

A ScriptedSession object.

Methods 
public String getProperty(String name)
public void setProperty(String name, String value)