Keywords

The Web Service source supports the following keywords for various configuration attributes such as Authentication URL, Headers, Body (JSON and Form-data) for a single or multiple endpoints.

plan

Used for configuring the provisioning operations such as create account and update account. For example:

Authentication URL - /api/core/v3/people/$plan.nativeIdentity$

JSON Body example for plan:

{"new_members": [
   {
  "email": "$plan.email$",
  "first_name": "$plan.first_name$",
  "surname": "$plan.surname$",
  "send_welcome_email": $plan.send_welcome_email$,
  "role": {
   ".tag": "member_only"
  }
}
]
}

response

Used for multiple endpoints, where the response from the first endpoint is provided as an input for the second endpoint. For example, there are two endpoints for account aggregation:

The first endpoint returns a response as a list of member_ids that is an input for the second endpoint.
The second endpoint's JSON body is: {"members_info":[{"member_id":"$response.member_id$"}]}

application

Used to get other configuration attributes from the current source. For example:

"$application.<accesstoken>$",

Where <accesstoken> is a source configuration attribute.

getobject

Used while performing the Aggregate Account operation (get a single account details). The $getobject allows you to use any attribute of the account. For example, $getObject.lastLoginDate$ .

JSON body:

{"members": [
   {
  ".tag": "member_id",
  "member_id": "$getobject.nativeIdentity$"
}
]
}

Authentication URL for get object:

/api/v4/admin/$getobject.nativeIdentity$

nativeIdentity

Indicates the AccountID identity attribute in the plan or during the getobject operation. For example, nativeIdentity is used along with the keyword as follows:

getobject - $getobject.nativeIdentity$
plan - $plan.nativeIdentity$

Note

There may be instances where nativeIdentity is present in the account request for account creation. In such cases, nativeIdentity may occasionally reflect different values.

planNativeIdentity

Represents the Plan's nativeIdentity in the Provisioning plan. For example, planNativeIdentity is used along with the keyword as follows:

plan - $plan.planNativeIdentity$

Web Services can be configured with the native identity from the provisioning plan using the placeholder $plan.planNativeIdentity$ .

Note

There is a possibility that nativeIdentity may be present in the account creation request. It may sometimes correspond to different values.

authenticate

To provide the username and password in the endpoint configuration, use the following placeholders:

$authenticate.username$
$authenticate.password$

Refer to Pass-Through Authentication for more information on configuration.

Note

SailPoint recommends using a placeholder in the body and URL rather than adding sensitive information directly. For example:

https://TESTMACHINE:9096/users/user/$application.accesstoken$

Attributes mapped to a raw JSON response may contain formatted values similar to ".tag": "member_id", such as:

['.tag']
['@etag']
['@@test']
['complex.name']
['role name']
['role_name']

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.