Skip to main content

List transforms

GET 

/transforms

Gets a list of all saved transform objects. A token with transforms-list read authority is required to call this API.

Request

Query Parameters

    offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
    name string

    Name of the transform to retrieve from the list.

    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    internal: eq

    name: eq, sw

    Example: name eq "Uppercase"

Responses

A list of transforms matching the given criteria.

Schema
  • Array [
  • 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]

    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

    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.

    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

  • ]
Loading...