Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

General Information


ServiceAPIMethod
urac/admin/group/addPOST


Data Model: Groups

Workflow: Add Group Flow

Input


NameSourceMandatoryTypeSpecial FormatDescription
tIdBody or QueryYESStringN/Athe Id of the tenant where this group is added
tCodeBody or QueryYESStringN/Athe code of the tenant
codeBodyYESStringN/A
nameBodyYESStringN/A
descriptionBodyYESStringN/A
configBodyYESObjectN/A

allowedPackages
YESObjectN/A


^([A-Za-z0-9]+)$
YESArray of strings

Then keys should follow the pattern : 
^([A-Za-z0-9]+)$



allowedEnvironments
NOObjectN/A


^([A-Za-z]+)$
YESObjectN/Afor it is just an empty object


Output


Valid Response

Valid Response Sample
{
	"result": true,
	"data": true
}


Invalid Response

Error Response Sample
{
    "result":false,
    "errors":{
        "codes":[421],
        "details":[
            {
                "code":421,
                "message":"Group code already exists. Choose another"
            }
        ]
    }
}



Error Codes



Code
Description
400Database connection error
421Group code already exists. Choose another
611invalid tenant id provided


Example (CURL)


Request

Calling Add Group API
 > CURL -X POST http://127.0.0.1:4000/urac/admin/group/add?tId=5551aca9e179c39b760f7a1a&tCode=DBTN -d {
	"code": "silver",
	"name": "Silver Group",
	"description": "grp description",
	"config": {
		"allowedPackages": {
			"prod": ["pack"]
		},
		"allowedEnvironments": {
			"PROD": {}
		}
	}
} 

Response

Add Group API response
{
	"result": true,
	"data": {
		"code": "ADMIN",
		"name": "Administration",
		"description": "This is the admin group etc...",
		"config": {
			"allowedPackages": {
				"MOBI": ["MOBI_BASIC"]
			}
		},
		"tenant": {
			"id": "5cadea196d44342107efe52c",
			"code": "TEST"
		},
		"_id": "5cc835c0d7fc2f9c75b9f5ed"
	}
}
  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.