Retrieve Multipurpose Email Token
POST/identity/v2/manage/account/emailtoken/:tokentype
Retrieves a multi-purpose Email token for verification, Password reset, and other Email-related actions. Set sendemail to true to also dispatch the Email corresponding to the requested token type.
The request body depends on the tokentype path parameter:
| tokentype | Required body fields | Email link parameter (when sendemail=true) | | --- | --- | --- | | emailverification | email | verificationurl | | addemail | email, type, uid — the UID identifies the account the Email is added to | verificationurl | | forgotpassword | email, or username when Username is the primary identity | resetpasswordurl | | deleteuser | uid | deleteurl | | passwordlesslogin | email or username | verificationurl | | forgotpin | email | resetpinurl | | onetouchlogin | email, clientguid | verificationurl | | autologin | email or username, plus clientguid | verificationurl |
Only the parameter listed for the requested tokentype is read; the others are ignored. The supplied URL must be whitelisted as a callback for the app, otherwise the request is rejected with the matching URL error.
redirecturl and welcomeemailtemplate apply to the onetouchlogin and autologin token types only. redirecturl is also checked against the callback whitelist.
Request
Responses
- 200
- 400
- 401
- 403
OK: The request was successful.
Status Bad Request: The request could not be understood by the server due to malformed syntax.
Status Unauthorized: The request requires User authentication.
Status Forbidden: The client does not have permission to access the resource.