Skip to main content

Create transform

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 Body required

The transform to be created.

  • name string required

    Unique name of this transform

  • type string required

    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]

    The type of transform operation

  • attributes object required

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

    oneOf

  • sourceName string required

    A reference to the source to search for the account

  • attributeName string required

    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

    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

    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

    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 boolean

    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.

Responses

Indicates the transform was successfully created and returns its representation.


Schema
  • id string

    Unique ID of this transform

  • name string

    Unique name of this transform

  • type string

    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]

    The type of transform operation

  • attributes object

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

    oneOf

  • sourceName string

    A reference to the source to search for the account

  • attributeName string

    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

    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

    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

    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 boolean

    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.

  • internal boolean

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

Loading...