Password reset service
- Uffe Svensson
The password reset service is an optional extension to User Admin. The service allow a users whom have forgot their password request a password reset.
The workflow is the following:
The user enters the password reset url, which by default is “weave/password_reset”
The user enter its email address into the form and submit. If the email address is linked to a register user, an email with instructions is sent to that email. Otherwise, the user will be informed that the entered email address is not valid.
An email is sent to the user’s email address with a password reset link. The link is only valid for a limited time.
Following the link, the user may enter a new password for its user account. If the password is valid, the user account password is updated
An confirmation email is sent to the user to inform that a password reset have been completed.
Namespace
urn:se.viamap.useradmin.password.reset#1.0
Tags
reset
Properties
Name | Type | Required | Cardinality | Default | Description |
url | string | no | 0..1 | “/password_reset“ | The url where this servlet should be registered. |
from | string/object | yes | 0..1 |
| The email address of the sender. May be a string or set as an object. If set as an object, there should be two properties entered; name and email. The name is the name displayed to the recipient and the email the email to send from. Example: <from>
<name>My Organization</name>
<email>no-reply@example.com</email>
</from> |
expire | integer | no | 0..1 | 3600 (1 hour) | Time in seconds for how long a password reset ticket should be available, starting from the initial request. |
cleanupInterval | integer | no | 0..1 | 30 | Time in seconds for how long expired tickets should be cleared. |
renewLimit | integer | no | 0..1 | 10 | Time in seconds for how long time must have passed before a new password request can be issued while there already exist an active request. |
emailQueueInterval | integer | no | 0..1 | 30 | Time in seconds for the interval between email send batch. |
maxMessagesPerInterval | integer | no | 0..1 | 10 | Max number of emails that should be sent with each email batch. |
maxMessagesInQueue | integer | no | 0..1 | 30 | Max number of messages allowed in email queue. |
maxMessagesAttempts | integer | no | 0..1 | 3 | Number of time a message may fail to be sent before giving up. Default is 3. |
resources | reset:resouces | no | 0..n |
| Set language resources or override defualt values |
reset:resources
Properties
Name | Type | Required | Cardinality | Description |
|---|---|---|---|---|
lang | string | no | 0..1 | Language tag for target, ie. sv, nb, en, en-us. Leave blank to override default. Note, language tags should be unique for resources. |
entry | reset:resources:entry | yes | 1..n | Entries for the resource |
reset:resources:entry
Properties
Name | Type | Required | Cardinality | Description |
|---|---|---|---|---|
id | string | yes | 1..1 | Id of the resource |
value | string | yes | 1..1 | The value for the resource |
ID | Default value | Description |
|---|---|---|
main.label | Reset your password | The label of the main password reset page |
main.instructions | Enter your user account's email address and we will send you a password reset link. | The instructions of the main password reset page |
main.instructions.submitted | An email have been sent to you with a link to reset your password. | The instructions of the main password reset page after it have been submitted |
main.submit.button | Send password reset email | The text of the submit button of the main password reset page |
main.error | That address is not a verified email address or has been deactivated | Default error message when email submission failed |
main.page.header | Forgot your password? | Page header of the main password reset page |
main.login.button | Go to Login page | Login button text of the main password reset page |
main.email | Enter your email address | Email input label of the main password reset page |
email.subject | Please reset your password | The subject of password reset email |
email.content | We received a request to reset the password on your account. You can use the following link to reset your password: ${tokenurl} If you don’t use this link within 1 hour, it will expire. To get a new password reset link, visit ${url} Thanks | The content of password reset email. Email content support parameters to be replaced: ${url} - the url to the password reset page ${tokenurl} - the url to the password reset page including token |
email.error | Password reset email could not be sent. Please contact support. | Default error message to display when an email could not be sent |
email.success.subject | Your password was reset | Subject of confirmation email |
email.success.content | Hello, We wanted to let you know that your password was reset. If you did not perform this action, you can recover access by entering your email address into the form at ${url} Please do not reply to this email with your password. We will never ask for your password, and we strongly discourage you from sharing it with anyone. | Content of confirmation email. Email content support parameters to be replaced: ${url} - the url to the password reset page ${tokenurl} - the url to the password reset page including token |
password.label | Reset your password | Label of the password entry page |
password.instructions | Enter your new password below | Instruction of the password entry page |
password.instructions.submitted | Your password have been changed. | Instruction of the password entry page once submission is completed |
password.submit.button | Change your password | Text of the submit button of the password entry page |
password.password.label | Enter you new password | Password input label of the password entry page |
password.passwordConfirm.label | Confirm you new password | Password confirmation input label of the password entry page |
password.error | Your password could not be updated | Default error message of the password entry page |
password.error.expired | This link has expired. | Ticket expiration message of the password entry page |
password.error.invalid | Invalid password. Try again. | Invalid password message of the password entry page |
password.error.match | The passwords does not match. | Unmatched password message of the password entry page |
password.page.header | Reset your password | Page header of the password entry page |
password.login.button | Go to Login page | Login button text of the password entry page |