Get Group

General Information

Service	API	Method

Service	API	Method
urac	/admin/group	GET

Data Model: Groups

Workflow:

Input

Type: application/json

Name	Source	Mandatory	Type	Special Format	Description

Name	Source	Mandatory	Type	Special Format	Description
id	Query	YES	String	N/A	the group id

Output

Valid Response

Valid Response Sample

{
	"result": true,
	"data": {
		"..."	
	}
}

Invalid Response

Error Response Sample

{
    "result":false,
    "errors":{
        "codes":[411],
        "details":[
            {
                "code":417,
                "message":"invalid group id provided"
            }
        ]
    }
}

Error Codes

Code	Description

Code	Description
405	Unable to find User. Please try again.
411	invalid user id provided

Example (CURL)

Request

Calling Get User API

> CURL -X GET http://127.0.0.1:4000/urac/admin/group?id=5718a32f0e811ab5a0ca08b3

Response

Get User API response

{
    "result": true,
    "data": {
		_id: ObjectId("5c9d3b2bf0f3739acce59de4"),
		locked: true,
		code: "owner",
		name: "Owner Group",
		description: "this is the owner group that owns the dashboard",
		config: {
			allowedPackages: {
				DSBRD: [
					"DSBRD_OWNER"
				]
			}
		},
		tenant: {
			id: "5c0e74ba9acc3c5a84a51259",
			code: "DBTN"
		}
	}
}