Request Password Reset Email
POST /obp/v7.0.0/users/password-reset-url
OBPv6.0.0-resetPasswordUrlAnonymous No role required User
Request a password reset email for a user. No authentication is required.
Authentication is NOT Required.
This endpoint is designed for users who have forgotten their password and cannot log in.
Behavior:
- Looks up the user by username and email
- Generates a unique password reset token
- Creates a reset URL using the portal_external_url property (falls back to API hostname)
- Sends an email to the user with the reset link
Required fields:
- username: The user's username (typically email)
- email: The user's email address (must match username)
The user must exist and be validated before a reset email can be sent.
Email configuration must be set up correctly for email delivery to work.
Note: For security reasons, this endpoint returns a generic success message regardless of whether the user was found, to prevent user enumeration.
User Authentication is Optional. The User need not be logged in.
JSON request body fields (2)
- felixsmith@example.com
- username
- felixsmith
JSON response body fields (1)
- message
- 123456
Example request body
{
"username": "user@example.com",
"email": "user@example.com"
}Example success response
{
"message": "If the account exists, a password reset email has been sent."
}Possible errors (2)
- OBP-10001: Incorrect json format.
- OBP-50000: Unknown Error.