Skip to main content

List Identities

GET 
/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]

    Default value: CORRELATED_ONLY

    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.

    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.

    Example: true
    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.

    Example: 0

Responses​

List of identities.

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

    alias string

    Alternate unique identifier for the identity

    emailAddress stringnullable

    The email address of the identity

    processingState stringnullable

    Possible values: [ERROR, OK, null]

    The processing state of the identity

    identityStatus string

    Possible values: [UNREGISTERED, REGISTERED, PENDING, WARNING, DISABLED, ACTIVE, DEACTIVATED, TERMINATED, ERROR, LOCKED]

    The identity's status in the system

    managerRef objectnullable

    Identity's manager.

    type string

    Possible values: [IDENTITY]

    DTO type of identity's manager.

    id string

    ID of identity's manager.

    name string

    Human-readable display name of identity's manager.

    isManager boolean

    Default value: false

    Whether this identity is a manager of another identity

    lastRefresh date-time

    The last time the identity was refreshed by the system

    attributes object

    A map with the identity attributes for the identity

    lifecycleState objectnullable

    Lifecycle state details that include lifecycle state name and whether this lifecycle state has been set manually

    stateName stringrequired

    The name of the lifecycle state

    manuallyUpdated booleanrequired

    Whether the lifecycle state has been manually or automatically set

  • ]
Loading...