General Information
| Service | API | Method |
|---|---|---|
| urac | /admin/listUsers | GET |
Data Model: Users
Input
| Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| tId | Body or Query | NO | String | N/A | If set, the api will return the users of a specific tenant; else the api returns all the users in the database |
Output
Valid Response
Valid Response Sample
{
"result": true,
"data": [{
"..."
},
// ...
]
}
Invalid Response
Error Response Sample
{
"result":false,
"errors":{
"codes":[406],
"details":[
{
"code":406,
"message":"Invalid or token has expired."
}
]
}
}
Error Codes
Code | Description |
|---|---|
| 406 | Invalid or token has expired. |
Example (CURL)
Request
Calling List Users API
> CURL -X GET http://127.0.0.1:4000/urac/admin/listUsers?tId=5551aca9e179c39b760f7a1a
Response
List Users API response
{
"result": true,
"data": [{
"_id": "571a2a0e8cc861b98a0b9467",
"locked": true,
"username": "owner",
"firstName": "owner",
"lastName": "owner",
"email": "owner@soajs.org",
"ts": 1461332494711,
"status": "active",
"profile": {},
"groups": ["owner"],
"config": {
"packages": {},
"keys": {}
},
"tenant": {
"id": "5551aca9e179c39b760f7a1a",
"code": "DBTN"
}
}]
}
Add Comment