Reset Password with Token¶

Reset the password of a user with the token.

Prerequisites¶

The application has been granted the permission “Create or delete user accounts in the OU”. Contact the OU administrator to get the permission if necessary.

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.3/password/reset

Request Parameters (URI)¶

Name	Location (Path/Query)	Required/Optional	Data Type	Description
orgId	Query	Required	String	OU ID. How to get orgId >>

Request Parameters (Body)¶

Name	Required/Optional	Data Type	Description
password	Required	String	The new user password.
token	Required	String	The token to reset the user password.

Response Parameters¶

Name	Data Type	Description
success	Boolean	Whether the password reset was successful. `true` means success, `false` means failure.

Error Codes¶

Error Code	Description
31400	Required parameters are missing, the new password is the same as the old one or do not match OU password rules.
31403	The application does not have the permission “Create or delete user accounts in the OU”.
31404	The OU or user does not exist, the user is not in the OU, or the OU does not acquire the application.
31410	The token is invalid or expired.

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.3/password/reset?orgId=your_org_ID

method: POST
{
  "password": "your_new_password",
  "token": "your_token"
}

Return Sample¶

{
  "code": 0,
  "message": "",
  "data": {
    "success": true
  }
}