Edit Group - V3

General Information

Service	API	Method
urac	/admin/group/edit	PUT

Data Model: Groups

Workflow: Edit Group Flow

Input

Type: application/json

Name	Source	Mandatory	Type	Special Format	Description
gId	Query	YES	String	N/A	The Group ID
name	Body	YES	String	N/A
description	Body	YES	String	N/A

Name			Source	Mandatory	Type	Special Format	Description
gId			Query	YES	String	N/A	The Group ID
name			Body	YES	String	N/A
description			Body	YES	String	N/A
config			Body	YES	Object	N/A
	allowedPackages			YES	Object	N/A
		^([A-Za-z0-9]+)$		YES	Array of strings		Then keys should follow the pattern : ^([A-Za-z0-9]+)$ The key is the product code. The strings inside the array are the package codes.
	allowedEnvironments			NO	Object	N/A
		^([A-Za-z]+)$		NO	Object	N/A	The environment code with empty object for now

Output

Valid Response

Valid Response Sample

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

Invalid Response

Error Response Sample

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

Error Codes

Code	Description
417	Invalid group id provided
418	Unable to edit Group.

Example (CURL)

Request

Calling Edit Group API

 > CURL -X POST http://127.0.0.1:4000/urac/admin/group/edit?gId=5 -d '{
	"name": "Some Group",
	"description": "group description",
	"config": {
		"allowedPackages": {
			"prod": ["pack"]
		},
	"allowedEnvironments": {
			"PROD": {}
		}
	}
}'

Response

Edit Group API response

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

Edit Group - V3

Input

Output

Valid Response

Invalid Response

Error Codes

Example (CURL)

Request

Response

0 Comments