PUT - /admin/groups/environments

General Information

Service	API	Method	Data Model	Workflow
urac	/admin/groups/environments	PUT	Groups

Description

This API updates the environments of all the groups in groups array sent in the request body.

Input

Type: application/json

Name

Source

Mandatory

Type

Special Format

Description

environments

Body

YES

Array

Array of Strings

Group Environments

groups

Body

YES

Object

Includes one of id or code arrays

Groups object

One of the following should exist under the groups object:

Name	Mandatory	Type	Special Format	Description
ids	YES	Array	Array of Strings	User ID
codes	YES	Array	Array of Strings	Username

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: true
}

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%