Password Reset script includes
-
- UpdatedJan 30, 2025
- 3 minutes to read
- Yokohama
- Password Reset Application
The Password Reset plugin installs script includes that implement password reset processes. To enable you to extend functionality, each base-system script include provides extension points that you can use to invoke "extension scripts" that you customized.
The extension script category refers to the specific types of behavior for an extension script (for example, credential store, verification, identification type, or as a post-processor).
'Enrollment check' script includes
- params.userId: The sys_id of the user being checked (table: [sys_user]).
- params.verificationId: The sys_id of the verification being checked (table: [pwd_verification]).
'Identification form processor' script includes
Identification form processor script includes provide functionality for extending identification processing.
- params.processId: The sys_id of the calling Password Reset process (table: [pwd_process]).
- param request: The form request object. Fields in the form can be accessed with request.getParameter('<element-id>'). The supported request parameter is sysparm_user_id, the user identifier value entered in the form.
Name | Description |
---|---|
PwdIdentifyViaEmail | Verifies a user's identity by checking the email address. |
PwdIdentifyViaUsername | Verifies a user's identity by checking the user name. |
'Enrollment form processor' script includes
Enrollment form processor script includes provide functionality for extending enrollment form processing.
- params.userId: The sys_id of the user trying to enroll (table: [sys_user]).
- params.verificationId: The sys_id of the verification used to enroll (table: [pwd_verification]).
- params.enrollmentId: The sys_id of this enrollment process.
- request: The form request object. Fields in the form can be accessed with request.getParameter('<element-id>').
- gs.getSession().putProperty("result.status",status): Whether the user was successfully enrolled.
- gs.getSession().putProperty("result.message",message): An associated message to be returned to the UI, such as a detailed error message.
- gs.getSession().putProperty("result.value",value): A custom value associated with the enrollment.
Name | Description |
---|---|
PwdEnrollQuestionsProcessor | Handles questions and answers for verification. |
PwdEnrollSampleProcessor | Provides an enrollment processor for sample verification. |
PwdEnrollSMSProcessor | Provides an enrollment processor for SMS verification. |
'User account lookup' script includes
User account lookup script includes return the credential store account_id for a given user.
Name | Description |
---|---|
PwdDefaultUserAccountLookup | Provides a default script for user account lookup from a user_id to the account in a credential store. The default mapping is to use the user name as the account name. |
'Password generator' script includes
Password generator script includes take the following parameter, and return an auto-generated string password.
params.credentialStoreId: The sys_id of the calling Password Reset process (table: [pwd_process]).
Name | Description |
---|---|
PwdDefaultAutoGenPassword | Generates a password from a random word and 4 digits. |
'Verification processor' script includes
If the user identity is verified, the verification processor script includes return
true
.
- params.resetRequestId: The sys_id of the current Password Reset request (table: [pwd_reset_request]).
- params.userId: The sys_id of the user to be verified (table: [sys_user]).
- params.verificationId: The sys_id of the verification (table: [pwd_verification]).
- request: The form request object. Access the fields in the form with request.getParameter('<element-id>').
'Post processor' script includes
Post processor script includes execute custom actions after the Password Reset process has completed.
- params.resetRequestId: The sys_id of the current Password Reset request (table: [pwd_reset_request]).
- params.wfSuccess: A flag indicating whether the workflow completed successfully: True if, and only if, successful.
Name | Description |
---|---|
PwdPostProcessor | Executes actions after the process completes for success, failure, or both conditions. |