Remove User Roles¶

Remove roles of a user.

Prerequisites¶

The application has been granted the permission “Authorize users in this OU”. Contact the OU administrator to get the permission if necessary.

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.2/role/removeRoles

Request Parameters (Body)¶

Name	Required/Optional	Data Type	Description
organizationId	Required	String	The OU ID. How to get organizationld >>
userId	Required	String	The user ID. How to get userId >>
roleIds	Required	List	The IDs of the role to remove for the user.

Response Parameters¶

Name	Data Type	Description
data	Boolean	Whether the role 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, character limits exceeded, and so on.
31403	The application has not been granted the “Authorize users in this OU” permission.
31404	OU not found.

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.2/role/removeRoles

method: POST

requestBody:
{"organizationId":"yourOrgId", "userId":"yourUserId","roleIds": ["role1","role2","role3"]}

Return Sample¶

{
  "code": 0,
  "message": "OK",
  "data": true
}