Update User Group


Update user group information.

Operation Permissions

Applications assigned with the administrator policy in the OU.

Request Format

POST https://{apigw-address}/enos-iam-service/v2.3/usergroup/modify

Request Parameters (URI)

Name

Location (Path/Query)

Required/Optional

Data Type

Description

orgId

Query

Required

String

The ID of the OU to which the user group belongs to. How to get orgId>>

Request Parameters (Body)

Name

Required/Optional

Data Type

Description

id

Required

String

The user group ID.

name

Required

String

The user group name.

desc

Optional

String

The user group description.

Samples

Request Sample

url: https://{apigw-address}/enos-iam-service/v2.3/usergroup/modify?orgId=yourOrgId
method: POST
request Body:
{
  "id": "userGroupId",
  "name": "Admin group",
  "desc": "Group for admins"
}

Return Sample

{
  "fail": false,
  "data": true,
  "success": true,
  "status": 0
}