Remove Organization Structures¶

Remove organization structures of a user.

Prerequisites¶

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

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.2/structure/removeStructures

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 >>
structureIds	Required	List	The IDs of the organization structures to remove for the user. You can call the Get Structure by User API to obtain the organization structure IDs.

Response Parameters¶

Name	Data Type	Description
data	Boolean	Whether the organization structures are removed successfully. `true` means the removal is 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/structure/removeStructures

method: POST

requestBody:
{"organizationId":"yourOrgId", "userId":"yourUserId","structureIds": ["st1","st2","st3"]}

Return Sample¶

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