Update User group

PUT

/api/v1/iam/groups/{group_id}/

curl --request PUT \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/iam/groups/{group_id}/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
  --header 'Authorization: Bearer <API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "newtest",
  "created_by": 45961,
  "group_members": [],
  "remove_members": []
}'

Updates the User group details including its name and members.

Parameters

Path Parameters

group_id

required

integer

ID of the User group to update

Query Parameters

project_id

required

integer

Project ID Find your project id here

location

required

string

Allowed values: Delhi Chennai

Deployment region for the resource. Accepted values: Delhi, Chennai.

Mumbai region has been discontinued. Delhi and Chennai are the only supported regions.

Request Body^required

Media typeapplication/json

object

name

required

Updated name of the IAM group

string

created_by

required

ID of the user performing the update

integer

group_members

required

List of member IDs to add

Array<integer>

remove_members

required

List of member IDs to remove

Array<integer>

Example

{
  "name": "newtest",
  "created_by": 45961,
  "group_members": [],
  "remove_members": []
}

Responses

200

Group updated successfully

Media typeapplication/json

object

code

integer

data

string

errors

object

message

string

Example

{
  "code": 200,
  "data": "User group updated successfully",
  "errors": {},
  "message": "Success"
}