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
  • detailLevel string

    Possible values: [SLIM, FULL]

    Determines whether Slim, or increased level of detail is provided for each account in the returned list. FULL is the default behavior.

    Example: FULL
  • 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

Responses

List of account objects


Schema array
    oneOf

  • 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

  • uuid uuid

    Unique ID from the owning source

  • nativeIdentity string

    The native identifier of the account

  • description string

    The description for the account

  • disabled boolean

    Whether the account is disabled

  • locked boolean

    Whether the account is locked

  • manuallyCorrelated boolean

    Whether the account was manually correlated

  • hasEntitlements boolean

    Whether the account has any entitlements associated with it

  • sourceId string

    The ID of the source for which this account belongs

  • identityId string

    The ID of the identity for which this account is correlated to if not uncorrelated

  • attributes object

    A map containing attributes associated with the account

Loading...