Get a list of public identities
GET {{baseUrl}}/public-identities
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | number | Max number of results to return. | |
| See V3 API Standard Collection Parameters for more information. | |||
offset | number | 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. |
| 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 |
| 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| string | | Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: name |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"id":"2c9180857182305e0171993735622948","name":"Alison Ferguso","alias":"alison.ferguso","email":"alison.ferguso@acme-solar.com","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":"thomas.edison@acme-solar.com","status":"Active","manager":{"type":"IDENTITY","id":"2c918086676d3e0601677611dbde220f","name":"Mister Manager"},"attributes":[{"key":"phone","name":"Phone","value":"5125554321"},{"key":"country","name":"Country","value":"US"}]}]