Create Application Attribute Mapping
POST {{apiPath}}/environments/{{envID}}/applications/{{appID}}/attributes
The POST /environments/{{envID}}/applications/{{appID}}/attributes
operation adds a new attribute mapping to the application resource specified by its ID in the request URL.
In the request body, the name
and value
attributes are required. All other attribute values are optional for the POST
request.
If you have multiple identity providers (IdPs) configured, you need to include an attribute mapping for IDP ID
to distinguish between the IdPs.
Prerequisites
See Application Attribute Mapping for important overview information.
Create an application to get an
appID
. See Application Operations.
See the Applications attribute data model for complete descriptions.
Property | Type | Required? |
---|---|---|
mappingType | String | Optional |
name | String | Required |
nameFormat | String | Optional |
required | Boolean | Required |
value | String | Required |
idToken | Boolean | Optional |
userInfo | Boolean | Optional |
oidcScopes | List | Optional |
Request Body
{"name"=>"email", "value"=>"${user.email}", "required"=>false}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/fe36bb1a-3983-4d6c-af02-e7d50b0ab99a/attributes/18d4b06c-f8f3-4064-a2c4-0db80250fb5f"},"application":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/fe36bb1a-3983-4d6c-af02-e7d50b0ab99a"}},"id":"18d4b06c-f8f3-4064-a2c4-0db80250fb5f","mappingType":"CUSTOM","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"application":{"id":"fe36bb1a-3983-4d6c-af02-e7d50b0ab99a"},"createdAt":"2019-10-29T16:35:07.847Z","updatedAt":"2019-10-29T16:35:07.847Z","name":"email","value":"${user.email}","required":false}