Create transform

POST /transforms

Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API.

Request

application/json

Body

required

The transform to be created.

name stringrequired

Possible values: non-empty and <= 50 characters

Unique name of this transform

type stringrequired

Possible values: [accountAttribute, base64Decode, base64Encode, concat, conditional, dateCompare, dateFormat, dateMath, decomposeDiacriticalMarks, e164phone, firstValid, rule, identityAttribute, indexOf, iso3166, lastIndexOf, leftPad, lookup, lower, normalizeNames, randomAlphaNumeric, randomNumeric, reference, replaceAll, replace, rightPad, split, static, substring, trim, upper, usernameGenerator, uuid, displayName, rfc5646]

The type of transform operation

attributes object nullable required

Meta-data about the transform. Values in this list are specific to the type of transform to be executed.

oneOf

sourceName stringrequired

A reference to the source to search for the account

attributeName stringrequired

The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.

accountSortAttribute string

Default value: created

The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries

accountSortDescending boolean

Default value: false

The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)

accountReturnFirstLink boolean

Default value: false

The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false

accountFilter string

This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - nativeIdentity - the Account ID - displayName - the Account Name - entitlements - a boolean value to determine if the account has entitlements

accountPropertyFilter string

This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.

All account attributes are available for filtering as this operation is performed in memory.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

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.

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

values object[]required

An array of items to join together

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

expression stringrequired

A comparison statement that follows the structure of ValueA eq ValueB where ValueA and ValueB are static strings or outputs of other transforms.

The eq operator is the only valid comparison

positiveCondition stringrequired

The output of the transform if the expression evalutes to true

negativeCondition stringrequired

The output of the transform if the expression evalutes to false

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

firstDate object required

This is the first date to consider (The date that would be on the left hand side of the comparison operation).

oneOf

accountAttribute
dateFormat

sourceName stringrequired

A reference to the source to search for the account

attributeName stringrequired

The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.

accountSortAttribute string

Default value: created

The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries

accountSortDescending boolean

Default value: false

The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)

accountReturnFirstLink boolean

Default value: false

accountFilter string

accountPropertyFilter string

This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.

All account attributes are available for filtering as this operation is performed in memory.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

inputFormat object

A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.

If no inputFormat is provided, the transform assumes that it is in ISO8601 format

oneOf

Named Construct
Java Simple Date Format

string

outputFormat object

A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.

If no inputFormat is provided, the transform assumes that it is in ISO8601 format

oneOf

Named Construct
Java Simple Date Format

string

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

secondDate object required

This is the second date to consider (The date that would be on the right hand side of the comparison operation).

oneOf

accountAttribute
dateFormat

sourceName stringrequired

A reference to the source to search for the account

attributeName stringrequired

The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.

accountSortAttribute string

Default value: created

The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries

accountSortDescending boolean

Default value: false

The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)

accountReturnFirstLink boolean

Default value: false

accountFilter string

accountPropertyFilter string

This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.

All account attributes are available for filtering as this operation is performed in memory.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

inputFormat object

A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.

If no inputFormat is provided, the transform assumes that it is in ISO8601 format

oneOf

Named Construct
Java Simple Date Format

string

outputFormat object

A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.

If no inputFormat is provided, the transform assumes that it is in ISO8601 format

oneOf

Named Construct
Java Simple Date Format

string

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

operator stringrequired

Possible values: [LT, LTE, GT, GTE]

This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: firstDate < secondDate | | LTE | Less than or equal to: firstDate <= secondDate | | GT | Strictly greater than: firstDate > secondDate | | GTE | Greater than or equal to: firstDate >= secondDate |

positiveCondition stringrequired

The output of the transform if the expression evalutes to true

negativeCondition stringrequired

The output of the transform if the expression evalutes to false

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

inputFormat object

A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.

If no inputFormat is provided, the transform assumes that it is in ISO8601 format

oneOf

Named Construct
Java Simple Date Format

string

outputFormat object

A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.

If no inputFormat is provided, the transform assumes that it is in ISO8601 format

oneOf

Named Construct
Java Simple Date Format

string

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

expression stringrequired

A string value of the date and time components to operation on, along with the math operations to execute.

roundUp boolean

Default value: false

A boolean value to indicate whether the transform should round up or down when a rounding / operation is defined in the expression.

If not provided, the transform will default to false

true indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component)

false indicates the transform should round down (i.e., truncate the fractional date/time component indicated)

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

defaultRegion string

This is an optional attribute that can be used to define the region of the phone number to format into.

If defaultRegion is not provided, it will take US as the default country.

The format of the country code should be in ISO 3166-1 alpha-2 format

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

values object[]required

An array of attributes to evaluate for existence.

ignoreErrors boolean

Default value: false

a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

name stringrequired

The system (camel-cased) name of the identity attribute to bring in

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

substring stringrequired

A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

format string

An optional value to denote which ISO 3166 format to return. Valid values are:

alpha2 - Two-character country code (e.g., "US"); this is the default value if no format is supplied

alpha3 - Three-character country code (e.g., "USA")

numeric - The numeric country code (e.g., "840")

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

length stringrequired

An integer value for the desired length of the final output string

padding string

A string value representing the character that the incoming data should be padded with to get to the desired length

If not provided, the transform will default to a single space (" ") character for padding

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

table objectrequired

This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched

Note the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform.

property name* any

This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched

Note the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

length string

This is an integer value specifying the size/number of characters the random string must contain

This value must be a positive number and cannot be blank
If no length is provided, the transform will default to a value of 32
Due to identity attribute data constraints, the maximum allowable value is 450 characters

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

length string

This is an integer value specifying the size/number of characters the random string must contain

This value must be a positive number and cannot be blank
If no length is provided, the transform will default to a value of 32
Due to identity attribute data constraints, the maximum allowable value is 450 characters

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

id stringrequired

This ID specifies the name of the pre-existing transform which you want to use within your current transform

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

table objectrequired

An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.

property name* any

An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

regex stringrequired

This can be a string or a regex pattern in which you want to replace.

replacement stringrequired

This is the replacement string that should be substituded wherever the string or pattern is found.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

length stringrequired

An integer value for the desired length of the final output string

padding string

A string value representing the character that the incoming data should be padded with to get to the desired length

If not provided, the transform will default to a single space (" ") character for padding

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

delimiter stringrequired

This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data

index stringrequired

An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc.

throws boolean

Default value: false

A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array)

true - The transform should return "IndexOutOfBoundsException"

false - The transform should return null

If not provided, the transform will default to false and return a null

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

values stringrequired

This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

begin int32required

The index of the first character to include in the returned substring.

If begin is set to -1, the transform will begin at character 0 of the input data

beginOffset int32

This integer value is the number of characters to add to the begin attribute when returning a substring.

This attribute is only used if begin is not -1.

end int32

The index of the first character to exclude from the returned substring.

If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string.

endOffset int32

This integer value is the number of characters to add to the end attribute when returning a substring.

This attribute is only used if end is provided and is not -1.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

Responses

Indicates the transform was successfully created and returns its representation.

application/json

Schema
Example (from schema)

Schema

name stringrequired

Possible values: non-empty and <= 50 characters

Unique name of this transform

type stringrequired

The type of transform operation

attributes object nullable required

Meta-data about the transform. Values in this list are specific to the type of transform to be executed.

oneOf

sourceName stringrequired

A reference to the source to search for the account

attributeName stringrequired

The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.

accountSortAttribute string

Default value: created

The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries

accountSortDescending boolean

Default value: false

The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)

accountReturnFirstLink boolean

Default value: false

accountFilter string

accountPropertyFilter string

This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.

All account attributes are available for filtering as this operation is performed in memory.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

values object[]required

An array of items to join together

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

expression stringrequired

A comparison statement that follows the structure of ValueA eq ValueB where ValueA and ValueB are static strings or outputs of other transforms.

The eq operator is the only valid comparison

positiveCondition stringrequired

The output of the transform if the expression evalutes to true

negativeCondition stringrequired

The output of the transform if the expression evalutes to false

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

firstDate object required

This is the first date to consider (The date that would be on the left hand side of the comparison operation).

oneOf

accountAttribute
dateFormat

sourceName stringrequired

A reference to the source to search for the account

attributeName stringrequired

The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.

accountSortAttribute string

Default value: created

The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries

accountSortDescending boolean

Default value: false

The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)

accountReturnFirstLink boolean

Default value: false

accountFilter string

accountPropertyFilter string

This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.

All account attributes are available for filtering as this operation is performed in memory.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

inputFormat object

A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.

If no inputFormat is provided, the transform assumes that it is in ISO8601 format

oneOf

Named Construct
Java Simple Date Format

string

outputFormat object

A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.

If no inputFormat is provided, the transform assumes that it is in ISO8601 format

oneOf

Named Construct
Java Simple Date Format

string

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

secondDate object required

This is the second date to consider (The date that would be on the right hand side of the comparison operation).

oneOf

accountAttribute
dateFormat

sourceName stringrequired

A reference to the source to search for the account

attributeName stringrequired

The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema.

accountSortAttribute string

Default value: created

The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries

accountSortDescending boolean

Default value: false

The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order)

accountReturnFirstLink boolean

Default value: false

accountFilter string

accountPropertyFilter string

This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset.

All account attributes are available for filtering as this operation is performed in memory.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

inputFormat object

A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.

If no inputFormat is provided, the transform assumes that it is in ISO8601 format

oneOf

Named Construct
Java Simple Date Format

string

outputFormat object

A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.

If no inputFormat is provided, the transform assumes that it is in ISO8601 format

oneOf

Named Construct
Java Simple Date Format

string

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

operator stringrequired

Possible values: [LT, LTE, GT, GTE]

positiveCondition stringrequired

The output of the transform if the expression evalutes to true

negativeCondition stringrequired

The output of the transform if the expression evalutes to false

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

inputFormat object

A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data is coming in as.

If no inputFormat is provided, the transform assumes that it is in ISO8601 format

oneOf

Named Construct
Java Simple Date Format

string

outputFormat object

A string value indicating either the explicit SimpleDateFormat or the built-in named format that the data should be formatted into.

If no inputFormat is provided, the transform assumes that it is in ISO8601 format

oneOf

Named Construct
Java Simple Date Format

string

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

expression stringrequired

A string value of the date and time components to operation on, along with the math operations to execute.

roundUp boolean

Default value: false

A boolean value to indicate whether the transform should round up or down when a rounding / operation is defined in the expression.

If not provided, the transform will default to false

true indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component)

false indicates the transform should round down (i.e., truncate the fractional date/time component indicated)

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

defaultRegion string

This is an optional attribute that can be used to define the region of the phone number to format into.

If defaultRegion is not provided, it will take US as the default country.

The format of the country code should be in ISO 3166-1 alpha-2 format

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

values object[]required

An array of attributes to evaluate for existence.

ignoreErrors boolean

Default value: false

a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

name stringrequired

The system (camel-cased) name of the identity attribute to bring in

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

substring stringrequired

A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

format string

An optional value to denote which ISO 3166 format to return. Valid values are:

alpha2 - Two-character country code (e.g., "US"); this is the default value if no format is supplied

alpha3 - Three-character country code (e.g., "USA")

numeric - The numeric country code (e.g., "840")

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

length stringrequired

An integer value for the desired length of the final output string

padding string

A string value representing the character that the incoming data should be padded with to get to the desired length

If not provided, the transform will default to a single space (" ") character for padding

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

table objectrequired

This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched

Note the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform.

property name* any

This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched

Note the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return "Unknown Region" for the attribute that is mapped to this transform.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

length string

This is an integer value specifying the size/number of characters the random string must contain

This value must be a positive number and cannot be blank
If no length is provided, the transform will default to a value of 32
Due to identity attribute data constraints, the maximum allowable value is 450 characters

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

length string

This is an integer value specifying the size/number of characters the random string must contain

This value must be a positive number and cannot be blank
If no length is provided, the transform will default to a value of 32
Due to identity attribute data constraints, the maximum allowable value is 450 characters

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

id stringrequired

This ID specifies the name of the pre-existing transform which you want to use within your current transform

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

table objectrequired

An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.

property name* any

An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

regex stringrequired

This can be a string or a regex pattern in which you want to replace.

replacement stringrequired

This is the replacement string that should be substituded wherever the string or pattern is found.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

length stringrequired

An integer value for the desired length of the final output string

padding string

A string value representing the character that the incoming data should be padded with to get to the desired length

If not provided, the transform will default to a single space (" ") character for padding

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

delimiter stringrequired

This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data

index stringrequired

throws boolean

Default value: false

true - The transform should return "IndexOutOfBoundsException"

false - The transform should return null

If not provided, the transform will default to false and return a null

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

values stringrequired

This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

begin int32required

The index of the first character to include in the returned substring.

If begin is set to -1, the transform will begin at character 0 of the input data

beginOffset int32

This integer value is the number of characters to add to the begin attribute when returning a substring.

This attribute is only used if begin is not -1.

end int32

The index of the first character to exclude from the returned substring.

If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string.

endOffset int32

This integer value is the number of characters to add to the end attribute when returning a substring.

This attribute is only used if end is provided and is not -1.

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

input object

property name* any

requiresPeriodicRefresh RequiresPeriodicRefresh

Default value: false

A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process

id stringrequired

Unique ID of this transform

internal booleanrequired

Default value: false

Indicates whether this is an internal SailPoint-created transform or a customer-created transform

{
  "name": "Timestamp To Date",
  "type": "dateFormat",
  "attributes": {
    "sourceName": "Workday",
    "attributeName": "DEPARTMENT",
    "accountSortAttribute": "created",
    "accountSortDescending": false,
    "accountReturnFirstLink": false,
    "accountFilter": "!(nativeIdentity.startsWith(\"*DELETED*\"))",
    "accountPropertyFilter": "(groups.containsAll({'Admin'}) || location == 'Austin')",
    "requiresPeriodicRefresh": false,
    "input": {
      "type": "accountAttribute",
      "attributes": {
        "attributeName": "first_name",
        "sourceName": "Source"
      }
    }
  },
  "id": "2cd78adghjkja34jh2b1hkjhasuecd",
  "internal": false
}

Client Error - Returned if the request body is invalid.

application/json

Schema
Example (from schema)

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOriginnullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOriginnullable

Possible values: [DEFAULT, REQUEST, null]

text string

Actual text of the error message in the indicated locale.

]

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema
Example (from schema)

Schema

error

A message describing the error

{
  "error": "JWT validation failed: JWT is expired"
}

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema
Example (from schema)
403

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOriginnullable

Possible values: [DEFAULT, REQUEST, null]

text string

Actual text of the error message in the indicated locale.

]

causes object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOriginnullable

Possible values: [DEFAULT, REQUEST, null]

text string

Actual text of the error message in the indicated locale.

]

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

Not Found - returned if the request URL refers to a resource or object that does not exist

application/json

Schema
Example (from schema)
404

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOriginnullable

Possible values: [DEFAULT, REQUEST, null]

text string

Actual text of the error message in the indicated locale.

]

causes object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOriginnullable

Possible values: [DEFAULT, REQUEST, null]

text string

Actual text of the error message in the indicated locale.

]

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

An example of a 404 response object

{
  "detailCode": "404 Not found",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server did not find a current representation for the target resource."
    }
  ]
}

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema
Example (from schema)

Schema

message

A message describing the error

{
  "message": " Rate Limit Exceeded "
}

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema
Example (from schema)
500

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOriginnullable

Possible values: [DEFAULT, REQUEST, null]

text string

Actual text of the error message in the indicated locale.

]

causes object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOriginnullable

Possible values: [DEFAULT, REQUEST, null]

text string

Actual text of the error message in the indicated locale.

]

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Create transform

/transforms

Request​

Body

Responses​

Request

Responses