Password Reset extension scripts
-
- UpdatedJan 30, 2025
- 7 minutes to read
- Yokohama
- Password Reset Application
Password Reset extension scripts
Extension scripts allow you to extend Password Reset functionality in credential store, verification, or identification types.
Password Reset extension script includes
Each script include is associated with a specific category, which is available in the appropriate field of a Password Reset form.
'Enrollment Check' script include category
Script include category | Description | Method signature | Input fields | Output fields |
---|---|---|---|---|
Enrollment Check | Checks whether a user is enrolled for a given verification. | process(params) | Parameters:
|
Returns: (boolean) true, if the user is enrolled in the specified verification; otherwise, false. |
This Enrollment Check example signals that the user is enrolled if both expected parameters are supplied. The code would be contained in the Script field of an extension script named SampleEnrollmentCheck:
'Enrollment Form Processor' script include category
Script include category | Description | Method signature | Input fields | Output fields |
---|---|---|---|---|
Enrollment Form Processor | Checks whether all necessary information has been collected from the user. Stores the information so it can be used for verification when the user resets their password. | process(params) | Parameters:
The following information should be added to the state of the enrollment
process:
|
Returns: (boolean) true, if the user is enrolled in the specified verification; otherwise, false. |
This example processes an enrollment form submission successfully if the user-submitted response was success. The code would be contained in the Script field of an extension script named SampleEnrollmentProcessor:
'Identification Form Processor' script include category
Script include category | Description | Method signature | Input fields | Output fields |
---|---|---|---|---|
Identification Form Processor | Processes an identification form request. | processForm(params, request) | Parameters:
|
Returns: the sys_id of the user that corresponds to the requested input. Returns null, if no user was found. |
This example attempts to identify the user within the sys_user table given a user name submitted from the identification form. The code would be contained in the Script field of an extension script named PwdIdentifyViaUsername:
'Password Generator' script include category
Script include category | Description | Method signature | Input fields | Output fields |
---|---|---|---|---|
Password Generator | Returns an auto-generated password. | process(params) | Parameters:params.processId - The sys_id of the calling Password Reset process (table: pwd_process). | Returns: (String) an auto-generated password. |
This example randomly generates a password from a base word and numbers. The base word is selected depending on the credential store. The code would be contained in the Script field of an extension script named SamplePasswordGenerator:
'Post Reset' script include category
Script include category | Description | Method signature | Input fields | Output fields |
---|---|---|---|---|
Post Reset | Performs additional operations after the completion of the Password Reset process. | process(params) | Parameters:
|
Returns: void |
This example adds failed reset requests to the system log. The code would be contained in the Script field for an extension script named PwdPostProcessor':
'User Account Lookup' script include category
Script include category | Description | Method signature | Input fields | Output fields |
---|---|---|---|---|
User Account Lookup | Gets the credential store account ID for a given user. | process(params) | Parameters:params.userId - The sys_id of the user being checked (table: sys_user). | Returns: (String) the credential store account ID for the given user. |
This example gets the credential store account for a user. This code would be contained in the Script field of an extension script named SampleUserAccountLookupExtension:
'Verification Form Processor' script include category
Script include category | Description | Method signature | Input fields | Output fields |
---|---|---|---|---|
Verification Form Processor | Processes a verification form request and indicates whether the user was verified or not. | processForm(params, request) | Parameters:
|
Returns: (boolean) true, if the user is verified; otherwise, false. |
This example shows a verification processor that returns true only if the user sent ok in the input field; otherwise, it returns false. The code would be contained in the Script field of an extension script named SampleVerificationFormProcessor:
On this page
- Password Reset extension script
includes
- 'Enrollment Check' script include category
- 'Enrollment Form Processor' script include category
- 'Identification Form Processor' script include category
- 'Password Generator' script include category
- 'Post Reset' script include category
- 'User Account Lookup' script include category
- 'Verification Form Processor' script include category