/
List Groups
List Groups
General Information
Service | API | Method |
---|---|---|
urac | /admin/group/list | GET |
Data Model: Groups
Workflow: List Groups Flow
Input
Type: application/json
Name | Source | Mandatory | Type | Special Format | Description |
---|
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": "5718a32f0e811ab5a0ca08b5", "locked": true, "code": "owner", "name": "Owner Group", "description": "this is the owner group that owns the dashboard", "tenant": { "id": "5551aca9e179c39b760f7a1a", "code": "DBTN" } }, { } ] }
, multiple selections available,
Related content
GET - /admin/group
GET - /admin/group
More like this
Count Users
Count Users
More like this
PUT - /admin/user/groups
PUT - /admin/user/groups
More like this
List Users
List Users
More like this