General Information
...
| Service | API | Method |
|---|---|---|
| urac | /admin/listUsers | GET |
Data Model: %Link to Data Model% Users
Workflow: %Link to Architecture Page%
...
| Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| tId | Body or Query | YESNO | 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
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"result": true,
"data": [{
"..."
},
// ...
}]
} |
Invalid Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"result":false,
"errors":{
"codes":[400406],
"details":[
{
"code":400406,
"message":"ProblemInvalid withor thetoken providedhas passwordexpired."
}
]
}
} |
Error Codes
Code | Description | |
|---|---|---|
| 400 | Database Error406 | Invalid or token has expired. |
Example (CURL)
...
Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
> CURL -X POSTGET http://127.0.0.1:4000/...urac/admin/listUsers?tId=5551aca9e179c39b760f7a1a |
Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"result": true,
"data": [{
"_id": "57063608622c47b5c097d19b"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"
}
}]
} |