Remove Organization Structures¶
Remove an organization structure of the user without logging in to Application Portal.
Operation Permissions¶
In Application Portal, the application must be granted the “Authorize users in this OU” permission.
Request Format¶
POST https://{apigw-address}/app-portal-service/v2.2/structure/removeStructures
Request Parameters (Body)¶
Name |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|
organizationId |
Mandatory |
String |
The organization ID. How to get organizationld>> |
userId |
Mandatory |
String |
The user ID. |
structureIds |
Mandatory |
List |
The ID of the organization structure to remove for the user. |
Response Parameters¶
Name |
Data Type |
Description |
---|---|---|
data |
Boolean |
|
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 |
Organization 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
}
Java SDK Sample¶
public class AppPortalSdkTest{
@Test
public void removeOrganizationStructures() {
ArrayList<String> StructureIds = new ArrayList<>();
StructureIds.add("st1");
StructuresRemoveRequest structuresRemoveRequest = new StructuresRemoveRequest("your_org_id", "your_user_id",StructureIds);
Response response = Poseidon.config(PConfig.init().appKey("your_access_key").appSecret("your_secret_key").debug())
.url("https://{apigw-address}").getResponse(structuresRemoveRequest, Response.class);
System.out.println("List organization res: " + JSON.toJSONString(response));
assertNotNull("Response should not be null", structuresRemoveRequest);
assertNotNull("Response data should not be null", response.data);
}
}