General Information
...
| Service | API | Method |
|---|---|---|
| urac | /admin/group/list | GET |
Data Model: %Link to Data Model% Groups
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 groups of a specific tenant; else the api returns all the groups in the database |
Output
...
Valid Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"result": true,
"data": {
"..."
}
} |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"result":false,
"errors":{
"codes":[400415],
"details":[
{
"code":400415,
"message":"ProblemUnable withto the provided passwordfind group."
}
]
}
} |
Error Codes
Code | Description | |
|---|---|---|
| 400 | Database Error415 | Unable to find group. |
Example (CURL)
...
Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
> CURL -X POSTGET http://127.0.0.1:4000/.../urac/admin/group/list |
Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"result": true,
"data": [{
"_id": ObjectId('5718a32f0e811ab5a0ca08b5'),
"locked": true,
"code": "owner",
"name": "Owner Group",
"description": "this is the owner group that owns the dashboard",
"tenant": {
"_id": "57063608622c47b5c097d19b5551aca9e179c39b760f7a1a",
"..."code": "DBTN"
}
},
//...]
} |