Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/admin/group/listGET


Data Model: Groups

Workflow: List Groups Flow

Input

...

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": []
}

...

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

...