How To - Save REST API response in Saviynt attribute during Create Account

[SB]

Use Case

Need to be able to save REST API response in Saviynt during Create account request. In this scenario, the target application generates the status value on Account creation and the same needs to be saved in Saviynt's Custom Property attribute. 

Pre-requisites

Ensure the CreateAccount JSON is valid and the call is successful for creating accounts in target.

Applicable Version(s)

All

Solution

Snippet of response from logs

2022-04-27 15:24:05,763 [Thread-138] DEBUG rest.RestProvisioningService  - Got Webservice API Response: 
[headers:[Content-Type: application/json, Content-Length: 361], responseText:{"code":0,"msg":"success",
"time":1651073045,"eventTime":"2022-04-27T15:24:05.000+00:00","data":{"name":"xxxx xxxx A/P xxxx xxxx",
"email":"xxxxxxxx@xxxxxxx.xxx","mobile":"xxxxxxxxxx","role_id":"61ade16b9e90c314252083a3","status":1.0,
"maxis_id":"xxxxxx","create_time":"2022-04-27T23:24:05+08:00","update_time":"2022-04-27T23:24:05+08:00"},
"pagination":null}, cookies:[], statusCode:200]

We need to update responseColsToPropsMap and use the below value to store in Saviynt.

Based on the response above, we need to read the value under which the user attributes are visible in response. (highlighted in green)

In our case it was under data, for some other application it could also be under "User" or any other value. 

{
"accountIdPath": "accountName",
"responseColsToPropsMap": {
"customproperty1": "call1.message.data.status~#~int"
},
"call": [
{
"name": "CreateUser2",
"connection": "acctAuth",
"url": "",
"httpMethod": "POST",
"httpParams": "{}",
"httpHeaders": {},
"httpContentType": "application/json",
"successResponses": {
"statusCode": [
200,
201
]
}
}
]
}

[npise]

@SB what if one need to map attribute values of user object instead of response. is it possible? if yes can you share example

[SB]

responseColsToPropsMap can only be used to save the response you receive from the target. In case this is an attribute you can store in the target application, then you can pass it in the Create Account JSON. There are 2 ways to store it back in any of the Account's CP attribute.

1. If the target response does display this attribute post Account creation, you can leverage the responseColsToPropsMap parameter. OR

2. In your Account import mapping, map the targets attribute where we provisioned this value to the CP attribute of Saviynt.