List of all Users and Group Enrollments
The ListUsers function is used by administrators to return an array of all users and their group enrollments.
GET/Remote/ListUsers
EXAMPLE REQUEST
https://my.maplarge.com/Remote/ListUsers?mluser=user@domain.com&mltoken=token
*Either a token or password can be used in any request where authentication is required.
RETURNS
{ "id": "8120195bafcc41e9b12e9def218ff2a9", "hash": null, "success": true, "isCached": false, "authorized": true, "errors": [], "timestamp": 1420568624, "data": null, "users": { "8336": { "id": 8336, "name": "Admin345", "email": "test@test.com", "tags": [ "mobile", "test" ], "groups": [ 8335 ], "groupcount": 1, "isLoggedIn": false }, "8341": { "id": 8341, "name": "Test Admin", "email": "test@mpsandbox.com", "tags": [ "" ], "groups": [ 8340 ], "groupcount": 1, "isLoggedIn": false }, "8343": { "id": 8343, "name": "mppost", "email": "mppost@mpsandbox.com", "tags": [ "" ], "groups": [ 8342 ], "groupcount": 1, "isLoggedIn": false } } }
ACTION SPECIFIC RESPONSE PARAMETERS
| Parameter | Type | Description |
|---|---|---|
| users | mixed[] | List of all users and their meta data. |
| users[].id | long | ID of the user. |
| users[].name | string | Full name of the User. |
| users[].email | string | Email of the user. |
| users[].tags[] | string | Tags associated with user. |
| users[].groups[] | int | User's group enrollment returned as array of group IDs |
| users[].groupcount | int | Group enrollment count |
| users[].isLoggedIn | boolean | User is logged in: true or false |