Wiki
Clone wikiNumera.LibrisAPI / identity.search
Home > API Reference Documentation > identity.search
identity.search
The identity.search
action is used to search the identities the current user has access to. This will only work for users with the role of Agent Supervisor or above.
Input Parameters
Property | Required | Description |
---|---|---|
active | no | Set to true to only return users with a role > 0 |
realm | no | Filter the results based on a realm |
Output
The identities will be placed into an identities[]
array in the result. Each identity can have the following properties documented here.
Possible Status Codes
Status Code | Reason | Description |
---|---|---|
1000 | NO_REALM | If the current user is not a Superuser, a realm must be defined on the user account. If you receive this error, contact Numera support. |
Updated