Add User to User Group¶

Add users to a user group.

Operation Permissions¶

Applications assigned with the administrator policy in the OU.

Request Format¶

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

Request Parameters (URI)¶

Name	Location (Path/Query)	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The ID of the organization to which the user group belongs to. How to get orgId>>

Request Parameters (Body)¶

Name	Mandatory/Optional	Data Type	Description
user	Mandatory	UserListAdd Struct	The list of users to add. For more information, see UserListAdd Struct.
userGroup	Mandatory	UserGroupListAdd Struct	The user group to add isers to. For more information, see UserGroupListAdd Struct.

UserListAdd Struct ¶

Name	Mandatory/Optional	Data Type	Description
add	Mandatory	String Array	The list of user IDs.

UserGroupListAdd Struct ¶

Name	Mandatory/Optional	Data Type	Description
id	Mandatory	String	The user group ID.

Samples¶

Request Sample¶

url: https://{apigw-address}/enos-iam-service/v2.3/usergroup/append?orgId=yourOrgId
method: POST
request Body:
{
  "user": {
    "add": [
      "userId"
    ]
  },
  "userGroup": {
    "id": "userGroupId"
  }
}

Return Sample¶

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