List Users
Get all ACS users
Returns a list of all ACS users.
/acs/users/list
OK
Request
To filter the list of returned ACS users by a specific access control system, user identity, user identity phone number, or user identity email address, include one or more of the acs_system_id
, user_identity_id
, user_identity_phone_number
, or user_identity_email_address
parameters, respectively, in the request body. If you omit these parameters, the response includes all ACS users in your workspace.
Request Body Parameters
Parameter | Type | Description |
---|---|---|
| String (UUID) Optional | ID of the user identity for which you want to retrieve all ACS users |
| String Optional | Phone number of the user identity for which you want to retrieve all ACS users, in E.164 format (for example, |
| String Optional | Email address of the user identity for which you want to retrieve all ACS users |
| String (UUID) Optional | ID of the access control system for which you want to retrieve all ACS users |
Sample Request
Response
Returns an acs_users
array, in which each returned acs_user
contains the following properties:
Property | Description |
---|---|
| ID of the ACS user |
| Display name for the ACS user |
| Full name of the ACS user |
| Email address of the ACS user (for backward compatibility) |
| Email address of the ACS user |
| Phone number of the ACS user in E.164 format (for example, |
| ID of the access control system that contains the ACS user |
| ID of the workspace that contains the ACS user |
| Date and time at which the ACS user was created |
| Indicates whether the ACS user is currently suspended |
|
|
| ID of the user identity associated with the ACS user |
| Full name of the user identity associated with the ACS user |
| Email address of the user identity associated with the ACS user |
| Phone number of the user identity associated with the ACS user in E.164 format (for example, |
Sample Response
Last updated