List transforms

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

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.

• 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

Responses

• 200
• 403

---

A list of transforms matching the given criteria.

application/json

• Schema
• Example (from schema)
• Example

---

Schema array

• id string

  Unique ID of this transform

• name string

  Unique name of this transform

• type string

  The transform type (see Transformations in IdentityNow Using Seaspray).

• attributes object

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

• internal boolean

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

[
  {
    "id": "2cd78adghjkja34jh2b1hkjhasuecd",
    "name": "Timestamp To Date",
    "type": "concat",
    "attributes": {
      "inputFormat": "MMM dd yyyy, HH:mm:ss.SSS",
      "outputFormat": "yyyy/dd/MM"
    },
    "internal": false
  }
]

[
  {
    "id": "2cd78adghjkja34jh2b1hkjhasuecd",
    "name": "Timestamp To Date",
    "type": "dateFormat",
    "attributes": {
      "inputFormat": "MMM-dd-yyyy, HH:mm:ss.SSS",
      "outputFormat": "yyyy/dd/MM"
    },
    "internal": false
  },
  {
    "id": "2lkas8dhj4bkuakja77giih7l4ashh",
    "name": "PrefixSubstring",
    "type": "substring",
    "attributes": {
      "begin": 0,
      "end": 3
    },
    "internal": true
  }
]

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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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

  locale string

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

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  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.

{
  "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."
    }
  ]
}

Loading...