Skip to main content

Accounts List

This returns a list of accounts.
A token with ORG_ADMIN authority is required to call this API.

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

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

  • 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

    identityId: eq

    name: eq, in

    nativeIdentity: eq, in

    sourceId: eq, in

    uncorrelated: eq

    Example: identityId eq "2c9180858082150f0180893dbaf44201"
Responses

List of account objects


Schema array
  • id string

    System-generated unique ID of the Object

  • name string

    Name of the Object

  • created date-time

    Creation date of the Object

  • modified date-time

    Last modification date of the Object

  • sourceId string

    The unique ID of the source this account belongs to

  • sourceName string

    The display name of the source this account belongs to

  • identityId string

    The unique ID of the identity this account is correlated to

  • attributes object

    The account attributes that are aggregated

  • authoritative boolean

    Indicates if this account is from an authoritative source

  • description string

    A description of the account

  • disabled boolean

    Indicates if the account is currently disabled

  • locked boolean

    Indicates if the account is currently locked

  • nativeIdentity string

    The unique ID of the account generated by the source system

  • systemAccount boolean

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

  • uncorrelated boolean

    Indicates if this account is not correlated to an identity

  • uuid string

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

  • manuallyCorrelated boolean

    Indicates if the account has been manually correlated to an identity

  • hasEntitlements boolean

    Indicates if the account has entitlements

Loading...