Identity Profiles List

GET 
/identity-profiles

This returns a list of Identity Profiles based on the specified query parameters.

Request

Query Parameters

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
offset int32
Default value: 0
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
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
filters string
Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
id: eq, ne, ge, gt, in, le, lt, isnull, sw
name: eq, ne, ge, gt, in, le, lt, isnull, sw
priority: eq, ne
Example: id eq "ef38f94347e94562b5bb8424a56397d8"
sorters comma-separated
Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: id, name, priority, created, modified, owner.id, owner.name
Example: id,name

Responses

200

List of identityProfiles.

application/json

Schema

Schema

• Array [

id string

System-generated unique ID of the Object

name stringrequired

Name of the Object

created date-time

Creation date of the Object

modified date-time

Last modification date of the Object

description stringnullable

The description of the Identity Profile.

owner

object

nullable

The owner of the Identity Profile.

type string

Possible values: [IDENTITY]

Type of the object to which this reference applies

id string

ID of the object to which this reference applies

name string

Human-readable display name of the object to which this reference applies

priority int64

The priority for an Identity Profile.

authoritativeSource

object

required

type string

Possible values: [SOURCE]

Type of the object to which this reference applies

id string

ID of the object to which this reference applies

name string

Human-readable display name of the object to which this reference applies

identityRefreshRequired boolean

True if a identity refresh is needed. Typically triggered when a change on the source has been made.

identityCount int32

The number of identities that belong to the Identity Profile.

identityAttributeConfig

object

Defines all the identity attribute mapping configurations. This defines how to generate or collect data for each identity attributes in identity refresh process.

enabled boolean

The backend will only promote values if the profile/mapping is enabled.

attributeTransforms

object[]

Array [

identityAttributeName string

Name of the identity attribute.

transformDefinition

object

The seaspray transformation definition.

type string

The type of the transform definition.

attributes

object

Arbitrary key-value pairs to store any metadata for the object

property name* any

Arbitrary key-value pairs to store any metadata for the object

]

identityExceptionReportReference

object

nullable

taskResultId uuid

The id of the task result.

reportName string

The name of the report.

hasTimeBasedAttr boolean

Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.

• ]

Example (from schema)

[
  {
    "id": "id12345",
    "name": "aName",
    "created": "2015-05-28T14:07:17Z",
    "modified": "2015-05-28T14:07:17Z",
    "description": "My custom flat file profile",
    "owner": {
      "type": "IDENTITY",
      "id": "2c9180835d191a86015d28455b4b232a",
      "name": "William Wilson"
    },
    "priority": 10,
    "authoritativeSource": {
      "type": "SOURCE",
      "id": "2c9180835d191a86015d28455b4b232a",
      "name": "HR Active Directory"
    },
    "identityRefreshRequired": true,
    "identityCount": 8,
    "identityAttributeConfig": {
      "enabled": true,
      "attributeTransforms": [
        {
          "identityAttributeName": "email",
          "transformDefinition": {
            "type": "accountAttribute",
            "attributes": {
              "attributeName": "e-mail",
              "sourceName": "MySource",
              "sourceId": "2c9180877a826e68017a8c0b03da1a53"
            }
          }
        }
      ]
    },
    "identityExceptionReportReference": {
      "taskResultId": "2b838de9-db9b-abcf-e646-d4f274ad4238",
      "reportName": "My annual report"
    },
    "hasTimeBasedAttr": true
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

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 LocaleOrigin (string)nullable

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 LocaleOrigin (string)nullable

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.

]

Example (from schema)

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

401

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

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

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

403

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

application/json

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 LocaleOrigin (string)nullable

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 LocaleOrigin (string)nullable

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.

]

Example (from schema)

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

403

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

429

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

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

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

application/json

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 LocaleOrigin (string)nullable

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 LocaleOrigin (string)nullable

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.

]

Example (from schema)

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

500

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

Loading...