Get a list of public identities

Get a list of public identities

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

  alias: eq, sw

  email: eq, sw

  firstname: eq, sw

  lastname: eq, sw

  Example: firstname eq "John"
• add-core-filters boolean

  If true, only get identities which satisfy ALL the following criteria in addition to any criteria specified by filters:

  • Should be either correlated or protected.
  • Should not be "spadmin" or "cloudadmin".
  • uid should not be null.
  • lastname should not be null.
  • email should not be null.
• sorters comma-separated

  Sort results using the standard syntax described in V3 API Standard Collection Parameters

  Sorting is supported for the following fields: name

  Example: name

Responses

• 200
• 400
• 401
• 403
• 429
• 500

---

A list of public identity objects.

application/json

• Schema
• Example (from schema)
• Example

---

Schema array

• id string

  Identity id

• name string

  Human-readable display name of identity.

• alias string

  Alternate unique identifier for the identity.

• email string

  Email address of identity.

• status string

  The lifecycle status for the identity

• manager object

  An identity reference to the manager of this identity

  type string

  Possible values: [ACCOUNT_CORRELATION_CONFIG, ACCESS_PROFILE, ACCESS_REQUEST_APPROVAL, ACCOUNT, APPLICATION, CAMPAIGN, CAMPAIGN_FILTER, CERTIFICATION, CLUSTER, CONNECTOR_SCHEMA, ENTITLEMENT, GOVERNANCE_GROUP, IDENTITY, IDENTITY_PROFILE, IDENTITY_REQUEST, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY]

  An enumeration of the types of DTOs supported within the IdentityNow infrastructure.

  id string

  Identity id

  name string

  Human-readable display name of identity.

• attributes object[]

  The public identity attributes of the identity

  key string

  The attribute key

  name string

  Human-readable display name of the attribute

  value string

  The attribute value

[
  {
    "id": "2c9180857182305e0171993735622948",
    "name": "Alison Ferguso",
    "alias": "alison.ferguso",
    "email": "[email protected]",
    "status": "Active",
    "manager": {
      "type": "IDENTITY",
      "id": "2c9180a46faadee4016fb4e018c20639",
      "name": "Thomas Edison"
    },
    "attributes": [
      {
        "key": "country",
        "name": "Country",
        "value": "US"
      }
    ]
  }
]

[
  {
    "id": "2c9180857182305e0171993735622948",
    "name": "Alison Ferguso",
    "alias": "alison.ferguso",
    "email": "[email protected]",
    "status": "Active",
    "manager": {
      "type": "IDENTITY",
      "id": "2c9180a46faadee4016fb4e018c20639",
      "name": "Thomas Edison"
    },
    "attributes": [
      {
        "key": "phone",
        "name": "Phone",
        "value": "5125551234"
      },
      {
        "key": "country",
        "name": "Country",
        "value": "US"
      }
    ]
  },
  {
    "id": "2c9180a46faadee4016fb4e018c20639",
    "name": "Thomas Edison",
    "alias": "thomas.edison",
    "email": "[email protected]",
    "status": "Active",
    "manager": {
      "type": "IDENTITY",
      "id": "2c918086676d3e0601677611dbde220f",
      "name": "Mister Manager"
    },
    "attributes": [
      {
        "key": "phone",
        "name": "Phone",
        "value": "5125554321"
      },
      {
        "key": "country",
        "name": "Country",
        "value": "US"
      }
    ]
  }
]

Client Error - Returned if the request body is invalid.

application/json

• Schema
• Example (from schema)

---

Schema

• detailCode string

  Fine-grained error code providing more detail of the error.

• trackingId string

  Unique tracking id for the error.

• messages object[]

  Generic localized reason for error

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

  text string

  Actual text of the error message in the indicated locale.

• causes object[]

  Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

  text string

  Actual text of the error message in the indicated locale.

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

• Schema
• Example (from schema)

---

Schema

• error

  A message describing the error

{
  "error": "JWT validation failed: JWT is expired"
}

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

• Schema
• Example (from schema)
• 403

---

Schema

• detailCode string

  Fine-grained error code providing more detail of the error.

• trackingId string

  Unique tracking id for the error.

• messages object[]

  Generic localized reason for error

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

  text string

  Actual text of the error message in the indicated locale.

• causes object[]

  Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

  text string

  Actual text of the error message in the indicated locale.

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

• Schema
• Example (from schema)

---

Schema

• message

  A message describing the error

{
  "message": " Rate Limit Exceeded "
}

Internal Server Error - Returned if there is an unexpected error.

application/json

• Schema
• Example (from schema)
• 500

---

Schema

• detailCode string

  Fine-grained error code providing more detail of the error.

• trackingId string

  Unique tracking id for the error.

• messages object[]

  Generic localized reason for error

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

  text string

  Actual text of the error message in the indicated locale.

• causes object[]

  Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

  locale string

  The locale for the message text, a BCP 47 language tag.

  localeOrigin string

  Possible values: [DEFAULT, REQUEST]

  An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

  text string

  Actual text of the error message in the indicated locale.

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...