Accounts List

GET 
/accounts

This returns a list of accounts.

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, 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
recommendation.method: eq, in, isnull
Example: identityId eq "2c9180858082150f0180893dbaf44201"
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, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType
Example: id,name

Responses

200

List of account objects

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

sourceId stringrequired

The unique ID of the source this account belongs to

sourceName stringnullablerequired

The display name of the source this account belongs to

identityId string

The unique ID of the identity this account is correlated to

cloudLifecycleState stringnullable

The lifecycle state of the identity this account is correlated to

identityState stringnullable

The identity state of the identity this account is correlated to

connectionType stringnullable

The connection type of the source this account is from

isMachine boolean

Indicates if the account is of machine type

recommendation

object

nullable

Indicates that the account is currently classified to be one type but is recommended to be a different one

type stringrequired

Possible values: [HUMAN, MACHINE]

Recommended type of account.

method stringrequired

Possible values: [DISCOVERY, SOURCE, CRITERIA]

Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria.

attributes

object

nullable

required

The account attributes that are aggregated

property name* anynullable

The account attributes that are aggregated

authoritative booleanrequired

Indicates if this account is from an authoritative source

description stringnullable

A description of the account

disabled booleanrequired

Indicates if the account is currently disabled

locked booleanrequired

Indicates if the account is currently locked

nativeIdentity stringrequired

The unique ID of the account generated by the source system

systemAccount booleanrequired

If true, this is a user account within IdentityNow. If false, this is an account from a source system.

uncorrelated booleanrequired

Indicates if this account is not correlated to an identity

uuid stringnullable

The unique ID of the account as determined by the account schema

manuallyCorrelated booleanrequired

Indicates if the account has been manually correlated to an identity

hasEntitlements booleanrequired

Indicates if the account has entitlements

identity

object

The identity this account is correlated to

type DtoType (string)

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, MACHINE_IDENTITY, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY, WORKGROUP]

DTO type

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

sourceOwner

object

nullable

The owner of the source this account belongs to.

type DtoType (string)

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, MACHINE_IDENTITY, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY, WORKGROUP]

DTO type

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

features stringnullable

A string list containing the owning source's features

origin stringnullable

Possible values: [AGGREGATED, PROVISIONED, null]

The origin of the account either aggregated or provisioned

ownerIdentity

object

nullable

The identity who owns this account, used only for machine accounts

type DtoType (string)

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, MACHINE_IDENTITY, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY, WORKGROUP]

DTO type

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

• ]

Example (from schema)

[
  {
    "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",
    "isMachine": true,
    "recommendation": {
      "type": "MACHINE",
      "method": "DISCOVERY"
    },
    "attributes": {
      "firstName": "SailPoint",
      "lastName": "Support",
      "displayName": "SailPoint Support"
    },
    "authoritative": false,
    "description": null,
    "disabled": false,
    "locked": false,
    "nativeIdentity": "552775",
    "systemAccount": false,
    "uncorrelated": false,
    "uuid": "{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}",
    "manuallyCorrelated": false,
    "hasEntitlements": true,
    "identity": {
      "id": "2c918084660f45d6016617daa9210584",
      "type": "IDENTITY",
      "name": "Adam Kennedy"
    },
    "sourceOwner": {
      "id": "2c918084660f45d6016617daa9210584",
      "type": "IDENTITY",
      "name": "Adam Kennedy"
    },
    "features": "ENABLE",
    "origin": "AGGREGATED",
    "ownerIdentity": {
      "id": "2c918084660f45d6016617daa9210584",
      "type": "IDENTITY",
      "name": "Adam Kennedy"
    }
  }
]

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...