General Information
...
| Service | API | Method | Data Models | Workflow |
|---|---|---|---|---|
| urac | /admin/group/adduser | POST |
Data Model: Groups
Workflow: Add Group Flow
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| code | Body | YES | String | Alphanumeric |
| - 20 letters Maximum | Group Code | ||||
| name | Body | YES | String | N/A | Group Name |
| description | Body | YES | String | N/A | Group Description |
| environments | Body | YES |
| Array of Objects | Pattern: "^([A-Za- |
z]+)$ |
Then keys should follow the pattern :
^([A-Za-z0-9]+)$
...
" and Minimum Number of items: 1 | Group Environments | ||||
| packages | Body | YES | Array of Strings | { | Group Packages |
Output
...
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{ "
result": true,
"data": true } |
Invalid Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"result":falsecode: 'FFFF',
"errors"name:{ 'integration',
description: 'integration description',
"codes":[421],
"details":[tenant: { id: '5d9321f8b40e09438afbd0c9', code: 'test' },
config:
{
allowedEnvironments: {
DEV: {},
"code":421, TEST: {}
},
"message"allowedPackages:"Group code{ already
exists. Choose another" client: [Array]
}
},
]
_id: '5d975590397e3419b784ac08'
}
} |
...
Code
...
Description
...
Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
> CURL -X POST http://127.0.0.1:4000/urac/admin/group/add -d {
"code": "silver",
"name": "Silver Group",
"description": "grp description",
"config": {
"allowedPackages": {
"prod": ["pack"]
},
"allowedEnvironments": {
"PROD": {}
}
}
} |
Response
...
| language | js |
|---|---|
| title | Add Group API response |
...
Invalid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"result":false,
"errors":{
"codes":[602],
"details":[
{
"code":602,
"message":"Model error: + %model_error%"
}
]
}
} |
Response schema
Follow this link to check out the response JSON Schema
SOAJS Error Codes
Code | Description |
|---|---|
| 400 | Business logic required data are missing |
| 602 | Model error: + %model_error% |