List Groups - V3

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": ObjectId('5d382063be668052c9cab94e'),
    	"locked": true,
    	"code": "owner",
    	"owner": true,
    	"name": "Owner Group",
    	"description": "this is the owner group that owns the dashboard",
    	"config": {
    	    "allowedPackages": {
    	        "DSBRD": [
       	         "DSBRD_OWNER"
       	     	]
       	 	}
   		 },
    	"tenant": {
       		"id": "5c0e74ba9acc3c5a84a51259",
        	"code": "TES0"
    	}
	  }
   ]
}