IDaaS Open Platform
Employee Identity (EIAM)

Reset User Password

Interface

# 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 Description

PUT https://{your_domain}/api/v2/tenant/users/{user_id}/rest-password?send_mode=EMAIL

# 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 Example

None

# Request Parameters

Parameter Name Chinese Name Required Type Description
user_id User ID Yes String Target User ID
send_mode New Password Notification Method Yes String Fixed value (SMS,EMAIL)

# Response Example

Success 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

# Response Parameters

Parameter Name Chinese Name Type Description
user_id User ID String Target User ID

# Error Codes

Status Code Error Code Error Message Handling Measures
400 USER.0001 User does not exist Please check if the corresponding user exists
User does not exist
400 USER.0011 Mobile number cannot be empty Please check if the mobile number field in the input parameters is empty
Mobile number cannot be empty
400 USER.0012 Email cannot be empty Please check if the email field in the input parameters is empty
Email cannot be empty
400 MSG.0001 Message sending failed Message sending failed, please check the message gateway configuration
Message sending failed
400 MSG.0004 The message sending mode does not meet the verification rules Please check if the message sending mode in the input parameters meets the verification rules
The message sending mode does not meet the verification rules

Please go ahead and paste the Markdown content you need translated.

Disable User