Employee Identity (EIAM)

Disable Organization

Interface

# Permissions

The Identity Management API is authorized at the application dimension. Before calling the interface, you need to set interface permissions for different applications. For details, please refer to API Permissions.

Permission Code Description
org_all Read and write permissions for organization management interfaces
all Read and write permissions for all interfaces

# Request Specification

PUT https://{your_domain}/api/v2/tenant/organizations/{org_id}/disable

# Request Headers

Parameter Name Chinese Name Required Type Description
Authorization Authorization Yes String Format: Bearer {access_token}
Content-Type Content Type Yes String Fixed value: application/json; charset=utf-8

# Request Body Example

None

# Request Parameters

Parameter Name Chinese Name Required Type Description
org_id Organization ID Yes String Organization ID

# Response Example

Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
    "org_id": "20220412142914549-1E50-B49C521A4"
}

Error Example:
HTTP/1.1 400 Bad Request
{
    "error_code": "ORG.0001",
    "error_msg": "Organization does not exist"
}
1
2
3
4
5
6
7
8
9
10
11
12
13

# Response Parameters

Parameter Name Chinese Name Type Description
org_id Organization ID String Automatically generated by the system

# Error Codes

Status Code Error Code Error Message Handling Measure
400 ORG.0001 Organization does not exist Please check if the organization exists
Organization does not exist
400 ORG.0024 Existing non-disabled child organizations under the current organization cannot be disabled Please check if the child organizations under the current organization are disabled
Existing non-disabled child organizations under the current organization cannot be disabled
400 ORG.0026 Existing non-disabled users in the current organization cannot be disabled Please check if the users under the current organization are disabled
Existing non-disabled users in the current organization cannot be disabled