Transforms allow you to manipulate attribute values while aggregating from, or provisioning to, a source.
You can find out more about the use and construction of transforms in Building Transforms in IdentityNow.
In this document, you can see each type of operation you can perform in a transform, as well as examples of their use.
Sometimes you will hear these transforms referred to as Seaspray, which is the code-name for transforms. IdentityNow Transforms and Seaspray are essentially the same thing.
The general form of a transform definition is as follows:
{
"type": "<transform-type>",
"attributes": {
"transform-attribute-1": "attribute-1-value",
"transform-attribute-2": "attribute-2-value"
}
}
Attribute values can be any JSON value, including nested transforms and primitive operations. A special attribute "input" can be used to seed the input value for a transform instead of deriving it from the transform context.
NOTE: In each of the examples that follows, an example of the input and result of each transform appears at the top of the example in comments. See the following for an example:
// Value -> value
// VALUE -> value
Primitive Operations
Seaspray ships out of the box with a number of primitive operations. They are described in the following sections.
Operations:
Complex Examples
Example: Country Code to Timezone
// Maps an uppercase version of an account attribute into a lookup table to convert a country code to a timezone.
{
"type": "lookup",
"attributes": {
"table": {
"EN-US": "CST",
"ES-MX": "CST",
"EN-GB": "GMT",
"default": "GMT"
},
"input": {
"type": "upper",
"attributes": {
"input": {
"type": "accountAttribute",
"attributes": {
"sourceName": "Salesforce",
"attributeName": "country"
}
}
}
}
}
}
Example: Remove a Prefix and Suffix from a Value
// Removes a prefix and suffix from a value. prefix_value_suffix -> value
{
"type": "substring",
"attributes": {
"begin": {
"type": "indexOf",
"attributes": {
"substring": "_"
}
},
"beginOffset": 1,
"end": {
"type": "lastIndexOf",
"attributes": {
"substring": "_"
}
}
}
}
Example: Nest Operations to Find or Generate a Valid Email Address
This is also an example of defining a default static value when needed.
// Chooses the first valid from a list of account attributes on different sources, falling
// back to a generated value
{
"type": "firstValid",
"attributes": {
"values": [
{
"type": "accountAttribute",
"attributes": {
"attributeName": "mail",
"sourceName": "LDAP"
}
},
{
"type": "accountAttribute",
"attributes": {
"attributeName": "mail",
"sourceName": "OIDP"
}
},
{
"type": "static",
"attributes": {
"value": "$employeeNumber@chadwick.com",
"employeeNumber": {
"type": "accountAttribute",
"attributes": {
"attributeName": "employeeNumber",
"sourceName": "OIDP"
}
}
}
}
]
}
}
Template Engine
Seaspray ships with a template engine that allows a transform to reference, transform, and render values passed into the transform context. Every string value in a seaspray transform may contain templated text, and will be run through the template engine.
Example
// In the following string, the text "$firstName" is replaced by the value of firstName in the template context. The same goes for "$lastName".
"$firstName.$lastName"
Identity Attribute Context
The following variables are available to the template engine when a transform is used to source an identity attribute.
- identity - sailpoint.object.Identity - The identity on which attribute promotion is being performed.
- oldValue - Object - The previous value of the attribute.
- attributeDefinition - sailpoint.object.ObjectAttribute - The definition of the attribute being promoted.
Account Profile Context
The following variables are available to the template engine when a transform is used in an account profile.
- field - sailpoint.object.Field - The field definition backing the account profile attribute.
- identity - sailpoint.object.Identity - The identity that the account profile is being generated for.
- application - sailpoint.object.Application - The application backing the source that owns the account profile.
- current - Object - The current value of the attribute.
Feedback
If you have feedback or suggestions on useful additions to the library, please send an email to dan.smith or jeff.upton and your input will be considered.
