GET users
Returns all customer's users.
Request example
curl --request GET "https://api-asm1.apica.io/v3/users?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"
Response body model example and description
[ { "id": 1, "guid": "b8956b89-7114-4b24-82ad-80d1f9239e53", "name": "sample string 3", "full_name": "sample string 4", "phone": "sample string 5", "mobile": "sample string 6", "email": "sample string 7", "approved": true, "locked_out": true, "language_tag": "sample string 10", "roles": [ "sample string 1", "sample string 2", "sample string 3" ] }, { "id": 1, "guid": "54f4414d-c9c1-4fba-97e6-81b87e38716f", "name": "sample string 3", "full_name": "sample string 4", "phone": "sample string 5", "mobile": "sample string 6", "email": "sample string 7", "approved": true, "locked_out": true, "language_tag": "sample string 10", "roles": [ "sample string 1", "sample string 2", "sample string 3" ] }, { "id": 1, "guid": "dd27a548-d8b2-44f0-b7a9-b774db3a96b1", "name": "sample string 3", "full_name": "sample string 4", "phone": "sample string 5", "mobile": "sample string 6", "email": "sample string 7", "approved": true, "locked_out": true, "language_tag": "sample string 10", "roles": [ "sample string 1", "sample string 2", "sample string 3" ] } ]
Name | Type | Description |
---|---|---|
id | Integer |
User ID. |
guid | Guid |
User GUID. |
name | String |
Login Username. |
full_name | String |
Full name. |
phone | String |
Phone. |
mobile | String |
Mobile. |
String |
Email. |
|
approved | Boolean |
Is user allowed to log in and use ASM? Check this to turn the user account off. |
locked_out | Boolean |
Has user been locked out? Will be automatically checked after too many failed logins. |
language_tag | String |
Language and regional settings in format: 'LL - RR', where 'LL' - language code by ISO 639-1 and 'RR' - region code by ISO 3166-1. |
roles | Array |
Roles. |