List all groups

General Information

Service	API	Method	Data Models	Workflow
urac	/admin/groups	GET	Groups	N/A

Description

This API lists all group records that exist in the tenant that has the external key sent in the request headers.

Input

Type: application/json

This API doesn't require input.

Output

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response

Valid Response

Valid Response Sample

{ 
  result: true,
  data: [
  {
    _id: "5d95da834dcd8a4d1d822ef5",
    code: "AAAA",
    name: "Unit test",
    description: "Added by unit test importer.",
    config: {
        allowedPackages: {
            DSBRD: [
                "DSBRD_DEVOP"
            ]
        },
        allowedEnvironments: {
            DEV: {

            }
        }
    },
    tenant: {
        id: "5d9321f8b40e09438afbd0c9",
        code: "test",
        pin: {
            code: "1235",
            allowed: true
        }
    }
  }
]
}

Invalid Response

Error Response Sample

{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

Code	Description
400	Business logic required data are missing
602	Model error: + %model_error%