General Information
| Service | API | Method |
|---|---|---|
| urac | /admin/group/list | GET |
Data Model: Groups
Workflow: List Groups Flow
Input
| Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| tId | Body or Query | NO | 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
Valid Response Sample
{
"result": true,
"data": []
}
Invalid Response
Error Response Sample
{
"result":false,
"errors":{
"codes":[415],
"details":[
{
"code":415,
"message":"Unable to find group."
}
]
}
}
Error Codes
Code | Description |
|---|---|
| 415 | Unable to find group. |
Example (CURL)
Request
Calling List Groups API
> CURL -X GET http://127.0.0.1:4000/urac/admin/group/list
Response
List Groups API response
{
"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": "5551aca9e179c39b760f7a1a",
"code": "DBTN"
}
},
//...]
}
0 Comments