Skip to main content

Lists all the 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'

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

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

Responses

List of identities for the customer.


Schema array
  • id string

    the identity ID

  • displayName string

    the display name of the identity

  • firstName string

    the first name of the identity

  • lastName string

    the last name of the identity

  • active boolean

    indicates if an identity is active or not

  • deletedDate string

    the date when the identity was deleted

Loading...