This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-23 00:19 UTC.
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Provides account identification (user name and/or email) and optional UI context (application name, return URL, and URL hash) used to compose the password reset link sent to the user.
Values
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description
emailrequired
string (email)
Email address to which the password reset code/link should be sent.min length 0max length 256
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
appNamerequired
string
Client/application name used for branding the reset experience or selecting templates.min length 1
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
returnUrlrequired
string
URL to redirect the user to after completing the reset process.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
returnUrlHashrequired
string
Optional fragment/hash (e.g., SPA route) to append to the return URL after reset.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
userNamerequired
string
User name of the account requesting a password reset. Useful when email alone is not sufficient to identify the user.nullable
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This model has no documented fields.
Reconnecting to the server
Could not reconnect
This session has ended
Attempt 1
Your work on this page is still here. Retrying keeps it; reloading starts the page again.
The server no longer holds this page's state, so it has to be loaded again.