IDaaS Open Platform
Employee Identity (EIAM)

Disable User

Interface

# Permissions {/permissions/}

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

Permission Code Description
user_all Read and write permissions for user management interfaces
all Read and write permissions for all interfaces

# Request Specification {/request-specification/}

PUT https://{your_domain}/api/v2/tenant/users/{user_id}/disable

# Request Headers {/request-headers/}

Parameter 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 Example {/request-example/}

None

# Request Parameters {/request-parameters/}

Parameter Chinese Name Required Type Description
user_id User ID Yes String The ID of the user to be disabled

# Return Example

Correct Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
  "user_id": "20201028102749564-9082-DC8CD2722"
}

Error Example:
{
  "error_msg": "User does not exist",
  "error_code": "USER.0001"
}
1
2
3
4
5
6
7
8
9
10
11
12

# Return Parameters

Parameter Chinese Name Type Description
user_id User ID String

# Error Codes

Status Code Error Code Error Message Handling Suggestion
400 USER.0001 User does not exist Please check if the corresponding user exists

Enable User