Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/admin/group/addPOST

...

Workflow: Add Group Flow

Input

...

Type: application/json
or Query
NameSourceMandatoryTypeSpecial FormatDescription
tIdcodeBodyYESStringN/Athe Id of the tenant where this group is added
tCodeBody or QueryYESStringN/Athe code of the tenant
codeBodyYESStringN/AAlphanumeric - String - 20 letters Maximum
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

...

Code Block
languagebash
titleCalling 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": {}
		}
	}
} 

...

Code Block
languagejs
titleAdd 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": true
		},
		"_id": "5cc835c0d7fc2f9c75b9f5ed"
	}
}