List Identities

GET 
https://sailpoint.api.identitynow.com/beta/identities

This API returns a list of identities.

Request

Query Parameters

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, in
name: eq, sw
alias: eq, sw
firstname: eq, sw
lastname: eq, sw
email: eq, sw
cloudStatus: eq
processingState: eq
correlated: eq
protected: eq
Example: id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false
sorters comma-separated
Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: name, alias, cloudStatus
Example: name,-cloudStatus
defaultFilter string
Possible values: [CORRELATED_ONLY, NONE]
Adds additional filter to filters query parameter.
CORRELATED_ONLY adds correlated=true and returns only identities that are correlated.
NONE does not add any and returns all identities that satisfy filters query parameter.
Default value: CORRELATED_ONLY
Example: NONE
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.
Default value: false
Example: true
limit int32
Possible values: <= 250
Max number of results to return. See V3 API Standard Collection Parameters for more information.
Default value: 250
Example: 250
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.
Default value: 0
Example: 0

Responses

200

List of identities.

application/json

Schema

Schema

Array [
idstring
System-generated unique ID of the identity
Example: 01f04e428c484542a241dc89c303b178
namestringrequired
The identity's name is equivalent to its Display Name attribute.
Example: Walter White
createddate-time
Creation date of the identity
Example: 2023-01-03T21:16:22.432Z
modifieddate-time
Last modification date of the identity
Example: 2023-01-03T21:16:22.432Z
aliasstring
The identity's alternate unique identifier is equivalent to its Account Name on the authoritative source account schema.
Example: walter.white
emailAddressstringnullable
The email address of the identity
Example: walter.white@example.com
processingStatestringnullable
The processing state of the identity
Possible values: [ERROR, OK, null]
Example: ERROR
identityStatusstring
The identity's status in the system
Possible values: [UNREGISTERED, REGISTERED, PENDING, WARNING, DISABLED, ACTIVE, DEACTIVATED, TERMINATED, ERROR, LOCKED]
Example: LOCKED
managerRef objectnullable
Identity's manager
typestring
DTO type of identity's manager
Possible values: [IDENTITY]
Example: IDENTITY
idstring
ID of identity's manager
Example: 2c4180a46faadee4016fb4e018c20626
namestring
Human-readable display name of identity's manager
Example: Robert Robinson
isManagerboolean
Whether this identity is a manager of another identity
Default value: false
Example: true
lastRefreshdate-time
The last time the identity was refreshed by the system
Example: 2020-11-22T15:42:31.123Z
attributesobject
A map with the identity attributes for the identity
Example: {"uid":"86754","firstname":"Walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"86754","lastSyncDate":1470348809380,"email":"walter.white@example.com","lastname":"White"}
lifecycleState objectnullable
Lifecycle state details that include lifecycle state name and whether this lifecycle state has been set manually
stateNamestringrequired
The name of the lifecycle state
Example: active
manuallyUpdatedbooleanrequired
Whether the lifecycle state has been manually or automatically set
Example: true
]

Example (auto)

[
  {
    "id": "01f04e428c484542a241dc89c303b178",
    "name": "Walter White",
    "created": "2023-01-03T21:16:22.432Z",
    "modified": "2023-01-03T21:16:22.432Z",
    "alias": "walter.white",
    "emailAddress": "walter.white@example.com",
    "processingState": "ERROR",
    "identityStatus": "LOCKED",
    "managerRef": {
      "type": "IDENTITY",
      "id": "2c4180a46faadee4016fb4e018c20626",
      "name": "Robert Robinson"
    },
    "isManager": true,
    "lastRefresh": "2020-11-22T15:42:31.123Z",
    "attributes": {
      "uid": "86754",
      "firstname": "Walter",
      "cloudStatus": "UNREGISTERED",
      "displayName": "Walter White",
      "identificationNumber": "86754",
      "lastSyncDate": 1470348809380,
      "email": "walter.white@example.com",
      "lastname": "White"
    },
    "lifecycleState": {
      "stateName": "active",
      "manuallyUpdated": true
    }
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "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: JWT validation failed: JWT is expired

Example (auto)

{
  "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

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "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: Rate Limit Exceeded

Example (auto)

{
  "message": " Rate Limit Exceeded "
}

500

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

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
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.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

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

Authorization: oauth2

type: Personal Access Token
scopes: idn:identity:read, idn:identity:manage

• go
• powershell
  SailPoint SDK
• python
  SailPoint SDK
• csharp
• curl
• dart
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• r
• ruby
• rust
• shell
• swift

• NATIVE

Request Collapse all

Base URL

https://sailpoint.api.identitynow.com/beta

Auth

Bearer Token

Parameters

filters — query

sorters — query

defaultFilter — query

---CORRELATED_ONLYNONE

count — query

---truefalse

limit — query

offset — query

ResponseClear

Click the Send API Request button above and see the response here!