Help Center/ IAM Identity Center/ API Reference/ API/ User Management/ Sending an Email Containing a Password Reset Link or Generating a One-Time Password
Updated on 2025-08-21 GMT+08:00
View PDF
Share

Sending an Email Containing a Password Reset Link or Generating a One-Time Password

Function

This API is used to send an email containing a password reset link or generate a one-time password for a user. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

POST /v1/identity-stores/{identity_store_id}/users/{user_id}/reset-password

Table 1 Path parameters

Parameter

Mandatory

Type

Description

identity_store_id

Yes

String

Globally unique ID of an identity source.

user_id

Yes

String

Globally unique ID of an IAM Identity Center user in the identity source.

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.
Table 3 Parameters in the request body

Parameter

Mandatory

Type

Description

mode

Yes

String

Password resetting mode: one-time password or email address.

Response Parameters

Status code: 200

Table 4 Parameters in the response body

Parameter

Type

Description

password

String

Password.

Status code: 400

Table 5 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Status code: 403

Table 6 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

encoded_authorization_message

String

Encrypted error message.

Example Request

Sending an email containing a password reset link or generating a one-time password for a user

POST https://{hostname}/v1/identity-stores/{identity_store_id}/users/{user_id}/reset-password

{
  "mode" : "OTP"
}

Example Response

Status code: 200

Successful

{
  "password" : "pass***"
}

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

Error Codes

For details, see Error Codes.

Parent topic: User Management