Remove User
Remove a user from an OU without logging in to Application Portal. If the user only belongs to one OU, the user and the associated user data (including the username and the registered email address) will be permanently deleted.
Operation Permissions
In Application Portal, the application must be granted the “Create or delete user accounts in the OU” permission.
Request Parameters (Body)
Name |
Mandatory/Optional |
Data Type |
Description |
userId |
Mandatory |
String |
The user name. |
organizationId |
Mandatory |
String |
The OU ID. How to get organizationId>> |
Response Parameters
Name |
Data Type |
Description |
data |
Boolean |
true indicates that removal of the user was successful, false indicates that removal of the user failed. |
Error Codes
Code |
Description |
31400 |
Errors such as incorrect parameters, empty parameters, and so on. |
31403 |
The application has not been granted the “Create or delete user accounts in the OU” permission. |
31404 |
Errors such as organization not found, user not found, and so on. |
Samples
Request Sample
url: https://{apigw-address}/app-portal-service/v2.2/user/remove
method: POST
requestBody:
{"userId":"yourUserId", "organizationId":"yourOrgId"}
Return Sample
{
"code": 0,
"message": "OK",
"data": true
}