Accounts List
GET/accounts
This returns a list of accounts.
Request
Query Parameters
Possible values: <= 250
Default value: 250
Max number of results to return. See V3 API Standard Collection Parameters for more information.
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.
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.
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, sw
identityId: eq, in, sw
name: eq, in, sw
nativeIdentity: eq, in, sw
sourceId: eq, in, sw
uncorrelated: eq
entitlements: eq
origin: eq, in
manuallyCorrelated: eq
identity.name: eq, in, sw
identity.correlated: eq
identity.identityState: eq, in
source.displayableName: eq, in
source.authoritative: eq
source.connectionType: eq, in
Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType
Responses
- 200
- 400
- 401
- 403
- 429
- 500
List of account objects
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
System-generated unique ID of the Object
Name of the Object
Creation date of the Object
Last modification date of the Object
The unique ID of the source this account belongs to
The display name of the source this account belongs to
The unique ID of the identity this account is correlated to
The lifecycle state of the identity this account is correlated to
The identity state of the identity this account is correlated to
The connection type of the source this account is from
The type of the account
attributes
object
nullable
required
The account attributes that are aggregated
The account attributes that are aggregated
Indicates if this account is from an authoritative source
A description of the account
Indicates if the account is currently disabled
Indicates if the account is currently locked
The unique ID of the account generated by the source system
If true, this is a user account within IdentityNow. If false, this is an account from a source system.
Indicates if this account is not correlated to an identity
The unique ID of the account as determined by the account schema
Indicates if the account has been manually correlated to an identity
Indicates if the account has entitlements
identity
object
The identity this account is correlated to
Possible values: [ACCOUNT_CORRELATION_CONFIG
, ACCESS_PROFILE
, ACCESS_REQUEST_APPROVAL
, ACCOUNT
, APPLICATION
, CAMPAIGN
, CAMPAIGN_FILTER
, CERTIFICATION
, CLUSTER
, CONNECTOR_SCHEMA
, ENTITLEMENT
, GOVERNANCE_GROUP
, IDENTITY
, IDENTITY_PROFILE
, IDENTITY_REQUEST
, LIFECYCLE_STATE
, PASSWORD_POLICY
, ROLE
, RULE
, SOD_POLICY
, SOURCE
, TAG
, TAG_CATEGORY
, TASK_RESULT
, REPORT_RESULT
, SOD_VIOLATION
, ACCOUNT_ACTIVITY
, WORKGROUP
]
DTO type
ID of the object to which this reference applies
Human-readable display name of the object to which this reference applies
sourceOwner
object
nullable
The owner of this object.
Possible values: [IDENTITY
]
Type of owner object.
Identity id
Human-readable display name of the owner.
A string list containing the owning source's features
Possible values: [AGGREGATED
, PROVISIONED
, null
]
The origin of the account either aggregated or provisioned
ownerIdentity
object
nullable
The identity who owns this account, typically used for non-human accounts
Possible values: [IDENTITY
]
The type of object being referenced
ID of the identity
Human-readable display name of the identity
ownerGroup
object
nullable
The governance group who owns this account, typically used for non-human accounts
Possible values: [GOVERNANCE_GROUP
]
The type of object being referenced
ID of the governance group
Human-readable display name of the governance group
[
{
"id": "id12345",
"name": "aName",
"created": "2015-05-28T14:07:17Z",
"modified": "2015-05-28T14:07:17Z",
"sourceId": "2c9180835d2e5168015d32f890ca1581",
"sourceName": "Employees",
"identityId": "2c9180835d2e5168015d32f890ca1581",
"cloudLifecycleState": "active",
"identityState": "ACTIVE",
"connectionType": "direct",
"type": "NON_HUMAN",
"attributes": {
"firstName": "SailPoint",
"lastName": "Support",
"displayName": "SailPoint Support"
},
"authoritative": false,
"description": null,
"disabled": false,
"locked": false,
"nativeIdentity": "552775",
"systemAccount": false,
"uncorrelated": false,
"uuid": "slpt.support",
"manuallyCorrelated": false,
"hasEntitlements": true,
"identity": {
"id": "2c918084660f45d6016617daa9210584",
"type": "IDENTITY",
"name": "Adam Kennedy"
},
"sourceOwner": {
"type": "IDENTITY",
"id": "4c5c8534e99445de98eef6c75e25eb01",
"name": "John Cavender"
},
"features": "ENABLE",
"origin": "AGGREGATED",
"ownerIdentity": {
"type": "IDENTITY",
"id": "2c918084660f45d6016617daa9210584",
"name": "Adam Kennedy"
},
"ownerGroup": {
"type": "GOVERNANCE_GROUP",
"id": "8d3e0094e99445de98eef6c75e25jc04",
"name": "GovGroup AX17Z"
}
}
]
Client Error - Returned if the request body is invalid.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
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."
}
]
}
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "JWT validation failed: JWT is expired"
}
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
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
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."
}
]
}
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
- Example (from schema)
Schema
A message describing the error
{
"message": " Rate Limit Exceeded "
}
Internal Server Error - Returned if there is an unexpected error.
- application/json
- Schema
- Example (from schema)
- 500
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
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.
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
The locale for the message text, a BCP 47 language tag.
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.
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 500 response object
{
"detailCode": "500.0 Internal Fault",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "An internal fault occurred."
}
]
}