Remove User¶

Remove a user from an OU.

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.

Prerequisites¶

The application has been granted the permission “Create or delete user accounts in the OU” permission. Contact the OU administrator to get the permission if necessary.

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.2/user/remove

Request Parameters (Body)¶

Name	Required/Optional	Data Type	Description
userId	Required	String	The user ID. How to get userId >>
organizationId	Required	String	The OU ID. How to get organizationId >>

Response Parameters¶

Name	Data Type	Description
data	Boolean	Whether the user is removed successfully. `true` means the removal was successful, `false` means the removal 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 OU 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
}