Skip to main content

Lists all the identities

GET 

/historical-identities

This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read'

Request

Query Parameters

    starts-with-query string

    This param is used for starts-with search for first, last and display name of the identity

    Example: Ada
    is-deleted boolean

    Indicates if we want to only list down deleted identities or not.

    Example: true
    is-active boolean

    Indicates if we want to only list active or inactive identities.

    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

    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

Responses

List of identities for the customer.

Schema

  • Array [

  • id string

    the identity ID

    displayName string

    the display name of the identity

    firstName stringnullable

    the first name of the identity

    lastName stringnullable

    the last name of the identity

    active boolean

    Default value: true

    indicates if an identity is active or not

    deletedDate stringnullable

    the date when the identity was deleted

  • ]

Loading...