Overview
The identity attribute transform can be used to get the value of a user's identity attribute. The intended use case for this transform is within a source's account create or disable profile.
Other Considerations
- It is not intended for use within an another identity profile attribute's calculation. Identity attribute calculations are multi-threaded processes, and there is no guarantee that a specific attribute will have current data, or even exist, at the time of calculation within any given transform. Referencing identity attributes within another identity attribute's calculation can lead to identity exceptions.
Transform Structure
The transform for identity attributes requires the desired identity attribute's system name, along with the standard type and name attributes, as described in the below example:
Example
{
"attributes": {
"name": "email"
},
"type": "identityAttribute",
"name": "Test Identity Attribute Transform"
}
Attributes
-
Required Attributes
- type - This must always be set to
identityAttribute
- name - This is a required attribute for all transforms, and represents the name of the transform as it will appear in the UI's dropdowns
- attributes.name - The system (camel-cased) name of the identity attribute to bring in
-
Optional Attributes
- requiresPeriodicRefresh - A
true or false value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process.
- input - This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If
input is not provided, the transform will take its input from the source and attribute combination configured via the UI.
Examples
Example 1
{
"attributes": {
"name": "uid"
},
"type": "identityAttribute",
"name": "Test Identity Attribute Transform"
}
This transform will return the SailPoint User Name attribute for a user.
Example 2
{
"attributes": {
"name": "identificationNumber"
},
"type": "identityAttribute",
"name": "Test Identity Attribute Transform"
}
This transform will return the Employee Number attribute for a user.
References
