POST - /admin/group

General Information

Service	API	Method	Data Models	Workflow
urac	/admin/group	POST	Groups

Description

This API adds a group record to the tenant that has the external key sent in the request headers.

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

NO

Array

Array of Strings

Group Environments

packages

Body

YES

Array

Array of Objects

Group Packages

Name	Type	Description
product	String	Product Code
packages	Array of Strings	An array of Package Codes

Output

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response

Valid Response

Valid Response Sample

{ 
  result: true,
  data: { 
  code: 'FFFF',
  name: 'integration',
  description: 'integration description',
  tenant: { id: '5d9321f8b40e09438afbd0c9', code: 'test' },
  config:
   { 
     allowedEnvironments: { 
       DEV: {}, 
       TEST: {} 
     },
     allowedPackages: { 
       client: [Array] 
     } 
   },
  _id: '5d975590397e3419b784ac08' 
 }
}

Invalid Response

Error Response Sample

{
    "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%