Remove User from User Group¶
Remove users from 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/remove
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 belongs to. How to get orgId>> |
Request Parameters (Body)¶
Name |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
user |
Required |
UserListRemove Struct |
The list of users to remove. For more information, see UserListRemove Struct. |
userGroup |
Required |
UserGroupRemove Struct |
The user group to remove users from. For more information, see UserGroupRemove Struct. |
UserListRemove Struct ¶
Name |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
delete |
Required |
String Array |
The list of user IDs to remove. |
UserGroupRemove Struct ¶
Name |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
id |
Required |
String |
The user group ID to remove the users from. |
Samples¶
Request Sample¶
url: https://{apigw-address}/enos-iam-service/v2.3/usergroup/remove?orgId=yourOrgId
method: POST
request Body:
{
"user": {
"delete": [
"userId"
]
},
"userGroup": {
"id": "userGroupId"
}
}
Return Sample¶
{
"fail": false,
"data": true,
"success": true,
"status": 0
}