Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Information

...

ServiceAPIMethod
urac/admin/group/listGET


Data ModelGroups

WorkflowList Groups Flow

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
tIdBody or QueryNOStringN/AIf 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
languagejs
titleValid Response Sample
{
	"result": true,
	"data": []
}

...


Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[415],
        "details":[
            {
                "code":415,
                "message":"Unable to find group."
            }
        ]
    }
}



Error Codes

 



Code
Description
415Unable to find group.


Example (CURL)

...

Request

Code Block
languagebash
titleCalling List Groups API
 > CURL -X GET http://127.0.0.1:4000/urac/admin/group/list

...

Code Block
languagejs
titleList Groups API response
{
	   "result": true,
	   "data": [
      {
	
         "_id": ObjectId('5718a32f0e811ab5a0ca08b5'),
	"5718a32f0e811ab5a0ca08b5",
         "locked": true,
	
         "code": "owner",
	
         "name": "Owner Group",
	
         "description": "this is the owner group that owns the dashboard",
	
         "tenant": {
		            "id": "5551aca9e179c39b760f7a1a",
		
            "code": "DBTN"
	}
},
//...
         }
      },
      {
         
      }
   ]
}