General Information
| Service | API | Method |
|---|---|---|
| urac | /admin/group/add | POST |
Data Model: Groups
Workflow: Add Group Flow
Input
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description | ||
|---|---|---|---|---|---|---|---|
| tId | Body or Query | YES | String | N/A | the Id of the tenant where this group is added | ||
| tCode | Body or Query | YES | String | N/A | the code of the tenant | ||
| code | Body | YES | String | N/A | |||
| 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 : | ||||
| allowedEnvironments | NO | Object | N/A | ||||
| ^([A-Za-z]+)$ | YES | Object | N/A | for 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 |
|---|---|
| 400 | Database connection error |
| 421 | Group code already exists. Choose another |
| 611 | invalid 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"
}
}
0 Comments