May act scripting API

The following bindings are available to May act scripts for token exchange.

This script can be either a next-generation or a legacy 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

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

identity

Represents an identity that AM can access.

Find examples of how to use the binding in Access profile data.

An AMIdentity object.

A wrapper object for a scripted identity.

requestProperties

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

requestUri

The URI as a string.

realm

The realm as a string.

requestParams

A map of request parameters and posted data, where each value is an array of parameters.

To mitigate the risk of reflection-type attacks, use OWASP best practices when handling these parameters. Refer to Unsafe use of Reflection.

requestHeaders

The value of the named request header. Returns a map of <String, List<String>> as a native JavaScript object, for example:

var ipAddress = requestProperties.requestHeaders["X-Forwarded-For"][0]

Header names are case-sensitive.

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)

token

The token to be updated. The token is a mutable object, which means that changes directly update the underlying token state.

Use the token.setMayAct(JsonValue value) method to add a may_act claim to a token.

An ExchangeableToken object

An ExchangeableTokenScriptWrapper object

Methods

public void setMayAct(Map<String, Object> value) throws ServerException
public Map<String, Object> getMayAct()
public Map<String, Object> getAct()
public void setAct(Map<String, Object> value) throws ServerException
public Object getField(String key)

PingAM

May act scripting API