Request Reset Password by email

Location /api/apps/{appID}/users/{accountType}:{address}/password/reset

This resource allows to do a request to reset the password of the user using the email of the user as notification method for the process.

Authorization

header

Required: Yes

/api/apps/{appID}/users/{accountType}:{address}/password/reset

Description

Send an email with a link for resetting the password to the user.

Note

This request requires empty body.

Headers

Name Required? type Description

Authorization Yes string Authorization can be of type Basic or Bearer.

Set a Base64-encoded string of AppID and AppKey concatenated with a colon (APP_ID:APP_KEY).
The header should look like:
Authorization: Basic czZCaGRSa3F0Mzo3RmpmcDBaQnIxS3REUmJuZlZkbUl3

The header should look like:
Authorization: Bearer ht5fpHQAyrPPwLftK1rAqllv5WNVPCnYfPiCvPocFuQ

Responses

204

Content-Type (None)

The email has been sent successfully.

Note This response has no contents.

404

Content-Type application/vnd.kii.UserNotFoundException+json

The user was not found.

Contents

Name	Type	Description
errorCode	string	Error code "USER_NOT_FOUND".
message	string	The error message.
field	string	The field used for searching the user. This can be the userID or address field.
value	string	The field value used for searching the user.
appID	string	The ID of the application.

409

Content-Type application/vnd.kii.OperationNotAllowedException+json

The user did not have a password.

Contents

Name	Type	Description
errorCode	string	Error code "OPERATION_NOT_ALLOWED".
message	string	The error message.

409

Content-Type application/vnd.kii.InvalidStatusException+json

The user did not have a verified email address.

Contents

401

Content-Type application/vnd.kii.UserDisabledException+json

The user was disabled.

Contents