{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":48564,"path":"servicenow-platform/password-reset/r_InstalledWithPasswordReset.md","title":"Installed with Password Reset","bundle":null,"doc_type":null,"release":"australia","body":"\n# Installed with Password Reset\n\nTables, roles, business rules, scripts, and workflows are installed with the Password Reset application.\n\n## Password Reset tables\n\n<table id=\"table_Tables\"><thead><tr><th>\n\nTable name\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nPassword Reset Active Answer \\[pwd\\_active\\_answer\\]\n\n</td><td>\n\nSecurity questions and associated answers, in an encrypted state, that users selected while going through the enrollment process.\n\n</td></tr><tr><td>\n\nPassword Reset Active Question \\[pwd\\_active\\_question\\]\n\n</td><td>\n\nSecurity questions that users selected while going through the enrollment process.\n\n</td></tr><tr><td>\n\nPassword Reset Activity Log \\[pwd\\_reset\\_activity\\]\n\n</td><td>\n\nAll Password Reset requests.\n\n</td></tr><tr><td>\n\nPassword Reset Activity Monitor \\[pwd\\_activity\\_monitor\\]\n\n</td><td>\n\nPassword Reset lockout activity.\n\n</td></tr><tr><td>\n\nPassword Reset Credential Store \\[pwd\\_cred\\_store\\]\n\n</td><td>\n\nPassword Reset credential stores that are available.\n\n</td></tr><tr><td>\n\nPassword Reset Credential Store Parameters \\[pwd\\_cred\\_store\\_param\\]\n\n</td><td>\n\nUser-created credential store parameters.\n\n</td></tr><tr><td>\n\nPassword Reset Credential Store Types \\[pwd\\_cred\\_store\\_type\\]\n\n</td><td>\n\nPassword Reset credential store types that are available.\n\n</td></tr><tr><td>\n\nPassword Reset Desktop Access Control\\[pwd\\_access\\_control\\]\n\n</td><td>\n\nPassword Reset Windows Application access control.\n\n</td></tr><tr><td>\n\nPassword Reset Desktop Access Log\\[pwd\\_access\\_log\\]\n\n</td><td>\n\nPassword Reset Windows Application access logs.\n\n</td></tr><tr><td>\n\nPassword Reset Device Enrollment Code \\[pwd\\_dvc\\_enrollment\\_code\\]\n\n</td><td>\n\nDevice enrollment codes that were sent to users during SMS code enrollment.\n\n</td></tr><tr><td>\n\nPassword Reset Devices \\[pwd\\_device\\]\n\n</td><td>\n\nUser SMS devices that are in a state of verified.\n\n</td></tr><tr><td>\n\nPassword Reset Email Verification Code\\[pwd\\_email\\_code\\]\n\n</td><td>\n\nVerification codes that were sent to users via email for password reset or email address enrollment.\n\n</td></tr><tr><td>\n\nPassword Reset Enrollment for Verification \\[pwd\\_enrollment\\]\n\n</td><td>\n\nInformation about user enrollment by verification.\n\n</td></tr><tr><td>\n\nPassword Reset Enrollment Snapshot \\[pwd\\_enrollment\\_snapshot\\]\n\n</td><td>\n\nSnapshot of user enrollment by verification.\n\n This table is used for the reporting purpose.\n\n The Sync Password Reset Enrollment Snapshot Data Monthly scheduled job runs once a month to generate or sync snapshot data in this table. The data, such as sys\\_user creation or deletion, verification to process creation or deletion, and so on, is synchronized.\n\n Password Reset DB listener is used to create or update the data in this table which is managed by the **pwd\\_reset.enable.dbListener** property with default value as true.\n\n If you’re an admin and want to manually sync the data in this table related to an active process, select **Sync Enrollment Snapshot Data** on that Password Reset process.\n\n You can turn off the data synchronization in this table through the DB listener or the monthly scheduled job by setting the **pwd\\_reset.enable.enrollment\\_snapshot** property to false.\n\n **Note:** Initially, an inactive record is created by the DB listener for a user-verification pair. When the users enrol themselves on the Password Reset Enrolment page, the record becomes active in this table.\n\n</td></tr><tr><td>\n\nPassword Reset Extension Type \\[pwd\\_extension\\_type\\]\n\n</td><td>\n\nExtension types that are available.\n\n</td></tr><tr><td>\n\nPassword Reset History\\[pwd\\_history\\]\n\n</td><td>\n\nHistory of passwords that users reset.\n\n</td></tr><tr><td>\n\nPassword Reset Identification Type \\[pwd\\_identification\\_type\\]\n\n</td><td>\n\nPassword Reset identification types that are available.\n\n</td></tr><tr><td>\n\nPassword Reset Process \\[pwd\\_process\\]\n\n</td><td>\n\nPassword Reset processes that are available.\n\n</td></tr><tr><td>\n\nPassword Reset Process Credential Store \\[pwd\\_map\\_proc\\_to\\_cred\\_store\\]\n\n</td><td>\n\nCredential stores and the associated Password Reset processes that the application is using.\n\n</td></tr><tr><td>\n\nPassword Reset Process User Group \\[pwd\\_map\\_proc\\_to\\_group\\]\n\n</td><td>\n\nGroups and the associated Password Reset processes that the application is using.\n\n</td></tr><tr><td>\n\nPassword Reset Process Verification \\[pwd\\_map\\_proc\\_to\\_verification\\]\n\n</td><td>\n\nVerifications and the associated Password Reset processes that the application is using.\n\n</td></tr><tr><td>\n\nPassword Reset Question \\[pwd\\_question\\]\n\n</td><td>\n\nQuestions that the application uses for security question verifications.\n\n</td></tr><tr><td>\n\nPassword Reset Request \\[pwd\\_reset\\_request\\]\n\n</td><td>\n\nInformation about Password Reset requests.\n\n</td></tr><tr><td>\n\nPassword Reset Request Verification\\[pwd\\_map\\_request\\_to\\_verification\\]\n\n</td><td>\n\nPassword reset requests and the associated verification that the application is using.\n\n</td></tr><tr><td>\n\nPassword Reset SMS Verification Code \\[pwd\\_sms\\_code\\]\n\n</td><td>\n\nSMS verification codes that were sent to users for a password reset.\n\n</td></tr><tr><td>\n\nPassword Reset User Lockout \\[pwd\\_user\\_lockout\\]\n\n</td><td>\n\nUsers that are locked out of Password Reset.\n\n</td></tr><tr><td>\n\nPassword Reset Verification \\[pwd\\_verification\\]\n\n</td><td>\n\nVerifications that are available.\n\n</td></tr><tr><td>\n\nPassword Reset Verification Param \\[pwd\\_verification\\_param\\]\n\n</td><td>\n\nUser-created verification parameters.\n\n</td></tr><tr><td>\n\nPassword Reset Verification Type \\[pwd\\_verification\\_type\\]\n\n</td><td>\n\nPassword Reset verification types that are available.\n\n</td></tr></tbody>\n</table>## Password Reset roles\n\n**Note:** Only the user with the following roles can have access to Password Reset tables. The deny unless authenticated ACLs restrict access to the Password Reset tables for any unauthenticated role such as public role user.\n\nFor more information, see [Deny-Unless ACL](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/acl-denial-behavior.md).\n\n<table id=\"table_vqc_jvj_sr\"><thead><tr><th>\n\nRole\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\npassword reset administrator \\[password\\_reset\\_admin\\]\n\n</td><td>\n\nConfigures and maintains Password Reset and Password Change.\n\n</td></tr><tr><td>\n\nservice desk agent \\[password\\_reset\\_service\\_desk\\]\n\n</td><td>\n\nResets passwords on behalf of users, tracks password reset requests, and views logs.\n\n</td></tr><tr><td>\n\ncredentials manager \\[password\\_reset\\_credential\\_manager\\]\n\n</td><td>\n\nDetermines which credential stores are valid for use with Password Reset.\n\n</td></tr></tbody>\n</table>## Password Reset business rules\n\n<table id=\"table_BusinessRules\"><thead><tr><th>\n\nBusiness rule\n\n</th><th>\n\nTable\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nAbort if password history limit exceeds\n\n</td><td>\n\nPassword Reset Credential Store Parameters\\[pwd\\_cred\\_store\\_param\\]\n\n</td><td>\n\nPrevents setting password history limit that exceeds the value of the **password\\_reset.history.limit** property.You can set a password reset history value in the **password\\_reset.history.limit** property. This system property checks the history of previous passwords based on the specified value. By default, the value is 10. But you can set it based on your organizational needs.\n\n**Note:** Currently, this property is applicable only to the ServiceNow credential store.\n\n</td></tr><tr><td>\n\nAdd default parameters QA verification\n\n</td><td>\n\nPassword Reset Verification \\[pwd\\_verification\\]\n\n</td><td>\n\nIf no parameters for Security Question verifications are specified, generates parameters.\n\n</td></tr><tr><td>\n\nAdd default parameters SMS verification\n\n</td><td>\n\nPassword Reset Verification \\[pwd\\_verification\\]\n\n</td><td>\n\nIf there are no parameters specified, generates SMS code verifications parameters.\n\n</td></tr><tr><td>\n\nAdd params personal confirm verification\n\n</td><td>\n\nPassword Reset Verification \\[pwd\\_verification\\]\n\n</td><td>\n\nIf there are no parameters specified, generates personal data confirmation verifications parameters.\n\n</td></tr><tr><td>\n\nAdd params personal verification\n\n</td><td>\n\nPassword Reset Verification \\[pwd\\_verification\\]\n\n</td><td>\n\nIf there are no parameters specified, generates parameters for personal data verification.\n\n</td></tr><tr><td>\n\nCheck unique verifications\n\n</td><td>\n\nPassword Reset Process Verification \\[pwd\\_map\\_proc\\_to\\_verification\\]\n\n</td><td>\n\nPrevents a verification from being assigned multiple times to a specific Password Reset process.\n\n</td></tr><tr><td>\n\nClear parameters for Mock verification\n\n</td><td>\n\nPassword Reset Verification\\[pwd\\_verification\\]\n\n</td><td>\n\nClears parameters for the Mock verification.\n\n</td></tr><tr><td>\n\nDeactivate process with no group\n\n</td><td>\n\nPassword Reset Process User Group \\[pwd\\_map\\_proc\\_to\\_group\\]\n\n</td><td>\n\nDeactivates the process if it does not apply to all users or if the groups associated with it are removed.\n\n</td></tr><tr><td>\n\nDeactivate process with no min ver\n\n</td><td>\n\nPassword Reset Process Verification\\[pwd\\_map\\_proc\\_to\\_verification\\]\n\n</td><td>\n\nDeactivates the process if the verifications associated with the process are less than the minimum value for the process.\n\n</td></tr><tr><td>\n\nDeactivate process with no verification\n\n</td><td>\n\nPassword Reset Process Verification \\[pwd\\_map\\_proc\\_to\\_verification\\]\n\n</td><td>\n\nDeactivates the process if the verifications associated with it are removed.\n\n</td></tr><tr><td>\n\nDelete history passwords if needed\n\n</td><td>\n\nPassword Reset Credential Store\\[pwd\\_cred\\_store\\]\n\n</td><td>\n\nDeletes history passwords if needed.\n\n</td></tr><tr><td>\n\nEnforce password history message\n\n</td><td>\n\nPassword Reset Credential Store\\[pwd\\_cred\\_store\\]\n\n</td><td>\n\nPasses enforce password history related messages to the client side.\n\n</td></tr><tr><td>\n\nGoogle Auth Enabled Check\n\n</td><td>\n\nPassword Reset Process\\[pwd\\_process\\]\n\n</td><td>\n\nDeactivates the process with Google Authenticator verification if the Google authenticator is disabled.\n\n</td></tr><tr><td>\n\nGoogleAuthSysPropertyCheck\n\n</td><td>\n\nPassword Reset Process Verification\\[pwd\\_map\\_proc\\_to\\_verification\\]\n\n</td><td>\n\nDeactivates the process with the Google Authenticator verification if the Google authenticator is disabled.\n\n</td></tr><tr><td>\n\nHandle req\\_enroll validation/default val\n\n</td><td>\n\nPassword Reset Process Verification\\[pwd\\_map\\_proc\\_to\\_verification\\]\n\n</td><td>\n\nHandles requires\\_enrollment and auto\\_enroll values for the process.\n\n</td></tr><tr><td>\n\nInsert/update scheduled job for reminder\n\n</td><td>\n\nPassword Reset Process\\[pwd\\_process\\]\n\n</td><td>\n\nInserts/updates the scheduled job for enrollment reminder.\n\n</td></tr><tr><td>\n\nOrder must be unique\n\n</td><td>\n\nPassword Reset Desktop Access Control\\[pwd\\_access\\_control\\]\n\n</td><td>\n\nEnforces order to be unique.\n\n</td></tr><tr><td>\n\nParameter Names Cannot Be Updated\n\n</td><td>\n\nPassword Reset Verification Param \\[pwd\\_verification\\_param\\]\n\n</td><td>\n\nPrevents parameter name changes.\n\n</td></tr><tr><td>\n\nPassword Reset Activity Monitor\n\n</td><td>\n\nPassword Reset User Lockout \\[pwd\\_user\\_lockout\\]\n\n</td><td>\n\nCreates an event when the number of users locked out of Password Reset during a specific interval exceeds the threshold value.\n\n</td></tr><tr><td>\n\nPassword Reset Validate Auto-generate\n\n</td><td>\n\nPassword Reset Process \\[pwd\\_process\\]\n\n</td><td>\n\nChecks that either **Email/SMS password** or **Display password** is selected when the **Auto-generate password** check box is selected.\n\n</td></tr><tr><td>\n\nPersonal Data Confirm Param Validation\n\n</td><td>\n\nPassword Reset Verification Param \\[pwd\\_verification\\_param\\]\n\n</td><td>\n\nChecks that a column exists in the sys\\_user table for the parameter used in a personal data confirmation verification.\n\n</td></tr><tr><td>\n\nPersonal Data Param Validation\n\n</td><td>\n\nPassword Reset Verification Param \\[pwd\\_verification\\_param\\]\n\n</td><td>\n\nChecks that a column exists in the sys\\_user table for the parameter used in a personal data verification.\n\n</td></tr><tr><td>\n\nPrevent against deletion\n\n</td><td>\n\nPassword Reset Credential Store \\[pwd\\_cred\\_store\\]\n\n</td><td>\n\nChecks whether the credential store is part of an active process before allowing deletion.\n\n</td></tr><tr><td>\n\nPrevent against deletion\n\n</td><td>\n\nPassword Reset Identification Type \\[pwd\\_identification\\_type\\]\n\n</td><td>\n\nIf an identification type is part of an active process, prevents the identification type from being deleted.\n\n</td></tr><tr><td>\n\nPrevent against deletion\n\n</td><td>\n\nPassword Reset Verification \\[pwd\\_verification\\]\n\n</td><td>\n\nIf the verification is part of an active process, prevents it from being deleted.\n\n</td></tr><tr><td>\n\nPrevent against deletion when in use\n\n</td><td>\n\nPassword Reset Credential Store Types\\[pwd\\_cred\\_store\\_type\\]\n\n</td><td>\n\nPrevents deletion when the type is in use.\n\n</td></tr><tr><td>\n\nPrevent against deletion when in use\n\n</td><td>\n\nPassword Reset Verification Type\\[pwd\\_verification\\_type\\]\n\n</td><td>\n\nPrevents deletion when the type is in use.\n\n</td></tr><tr><td>\n\nQueue event if history limit decreases\n\n</td><td>\n\nPassword Reset Credential Store Parameters\\[pwd\\_cred\\_store\\_param\\]\n\n</td><td>\n\nQueues the pwd.credStore.history.limit.decrease event if history limit decreases.\n\n</td></tr><tr><td>\n\nSecurity Questions Param Validation\n\n</td><td>\n\nPassword Reset Verification Param \\[pwd\\_verification\\_param\\]\n\n</td><td>\n\nChecks for valid parameters in security question verifications.\n\n</td></tr><tr><td>\n\nSend SMS code\n\n</td><td>\n\nPassword Reset Device Enrollment Code \\[pwd\\_dvc\\_enrollment\\_code\\]\n\n</td><td>\n\nSends an enrollment code to a device.\n\n</td></tr><tr><td>\n\nSet new record flag\n\n</td><td>\n\nPassword Reset Process \\[pwd\\_process\\]\n\n</td><td>\n\nSets a new record flag for the client to take appropriate action.\n\n</td></tr><tr><td>\n\nSend SMS Verification Code Via Notify\n\n</td><td>\n\nPassword Reset SMS Verification Code\n\n \\[pwd\\_sms\\_code\\]\n\n</td><td>\n\nSends out SMS authentication code via Notify if the Notify plugin is active.\n\n</td></tr><tr><td>\n\nSingle credential store per process\n\n</td><td>\n\nPassword Reset Process Credential Store \\[pwd\\_map\\_proc\\_to\\_cred\\_store\\]\n\n</td><td>\n\nPrevents having more than one credential store per process.\n\n</td></tr><tr><td>\n\nSMS Code Param Validation\n\n</td><td>\n\nPassword Reset Verification Param \\[pwd\\_verification\\_param\\]\n\n</td><td>\n\nChecks for valid parameters in SMS code verifications.\n\n</td></tr><tr><td>\n\nUpdate action based on access conditions\n\n</td><td>\n\nPassword Reset Desktop Access Log\\[pwd\\_access\\_log\\]\n\n</td><td>\n\nUpdates the “action” field of this log record based on the access control conditions.\n\n</td></tr><tr><td>\n\nUpdate proc\\_to\\_cred\\_store\n\n</td><td>\n\nPassword Reset Process \\[pwd\\_process\\]\n\n</td><td>\n\nEnforces a one-to-one relation between a Password Reset process and a credential store.\n\n</td></tr><tr><td>\n\nValidate Process\n\n</td><td>\n\nPassword Reset Process \\[pwd\\_process\\]\n\n</td><td>\n\nVerifies that a Password Reset process is configured correctly.\n\n</td></tr><tr><td>\n\nValidate Pwd Cred Store Name\n\n</td><td>\n\nPassword Reset Credential Store\\[pwd\\_cred\\_store\\]\n\n</td><td>\n\nEnforces the name to be unique.\n\n</td></tr><tr><td>\n\nValidate Pwd Cred Store Type Name\n\n</td><td>\n\nPassword Reset Credential Store Types\\[pwd\\_cred\\_store\\_type\\]\n\n</td><td>\n\nEnforces the name to be unique.\n\n</td></tr><tr><td>\n\nValidate Pwd Extension Type Name\n\n</td><td>\n\nPassword Reset Extension Type\\[pwd\\_extension\\_type\\]\n\n</td><td>\n\nEnforces the name to be unique.\n\n</td></tr><tr><td>\n\nValidate Pwd Identification Type Name\n\n</td><td>\n\nPassword Reset Identification Type\\[pwd\\_identification\\_type\\]\n\n</td><td>\n\nEnforces the name to be unique and not empty.\n\n</td></tr><tr><td>\n\nValidate Pwd Process Name\n\n</td><td>\n\nPassword Reset Process\\[pwd\\_process\\]\n\n</td><td>\n\nEnforces the name to be unique.\n\n</td></tr><tr><td>\n\nValidate Pwd Verification Name\n\n</td><td>\n\nPassword Reset Verification\\[pwd\\_verification\\]\n\n</td><td>\n\nEnforces the name to be unique.\n\n</td></tr><tr><td>\n\nValidate Pwd Verification Type Name\n\n</td><td>\n\nPassword Reset Verification Type\\[pwd\\_verification\\_type\\]\n\n</td><td>\n\nEnforces the name to be unique.\n\n</td></tr><tr><td>\n\nValidate Security Question\n\n</td><td>\n\nPassword Reset Question \\[pwd\\_question\\]\n\n</td><td>\n\nValidates rules for security questions such as no duplicates or empty questions.\n\n</td></tr><tr><td>\n\nVerify Account Lookup Script\n\n</td><td>\n\nPassword Reset Credential Store \\[pwd\\_cred\\_store\\]\n\n</td><td>\n\nChecks whether the account lookup script has the correctly named function.\n\n</td></tr><tr><td>\n\nVerifyAutoEnroll\n\n</td><td>\n\nPassword Reset Verification Type \\[pwd\\_verification\\_type\\]\n\n</td><td>\n\nChecks whether auto-enroll is selected and ensures that an enrollment check script is provided.\n\n</td></tr></tbody>\n</table>## Password Reset UI pages\n\n|Name|Description|\n|----|-----------|\n|$pwd\\_reset|First page of self-service reset process \\(asks for user ID\\).|\n|$pwd\\_reset\\_serviceDesk|First page of service desk assisted reset process \\(asks for user ID\\).|\n|$pwd\\_verify|Second page of reset process \\(asks user to verify identity\\).|\n|$pwd\\_new|Last page of password change process \\(asks for new password\\).|\n|$pwd\\_success|Page that appears when password is reset successfully.|\n|$pwd\\_error|Page that appears on error during reset process.|\n|$pwd\\_confirm|For processes configured to email or SMS password reset URL: After successful verification, this page displays message about sending link to user.|\n|$pwd\\_change|Page for changing password.|\n|$pwd\\_change\\_success|Page that appears when password is changed successfully.|\n|$pwd\\_change\\_error|Page that appears on error during password change process.|\n|$pwd\\_enrollment\\_form\\_container|Enrollment page for all verifications.|\n|$pwd\\_enrollment\\_success|Page that appears when enrollment is successful.|\n|$pwd\\_enroll\\_error|Page that appears when any error happens during enrollment.|\n|$pwd\\_unlock\\_success|Page that appears when locked user is successfully unlocked.|\n|$pwd\\_reset\\_downloads\\_ui|Page for downloading Password Reset Windows Application.|\n\n## Password Reset UI macros\n\n|Name|Description|\n|----|-----------|\n|$pwd\\_csrf\\_validation|CSRF validation for Password Reset Application. If violation is detected, the page will be redirected to the error page.|\n|$pwd\\_display\\_password|Displays a temporary password on the success page if the process is configured to auto-generate.|\n|$pwd\\_enroll\\_email\\_ui and $pwd\\_verify\\_email\\_ui|UI for email enrollment and verification.|\n|$pwd\\_enroll\\_google\\_auth\\_ui and $pwd\\_verify\\_google\\_auth\\_ui|UI for Google Authentication enrollment and verification.|\n|$pwd\\_enroll\\_questions\\_ui|UI for question and answer security validation enrollment.|\n|$pwd\\_enroll\\_questions\\_ui\\_js|JavaScript code that requires server-side data for security question and answer enrollment.|\n|$pwd\\_enroll\\_sample\\_ui|Sample UI macro for enrollment for Mock Verification Type.|\n|$pwd\\_enroll\\_sms\\_ui and $pwd\\_verify\\_sms\\_ui|UI for SMS enrollment and verification.|\n|$pwd\\_enrollment\\_form\\_title|Jelly macro function that prints the title for the enrollment form. A verification ID is mandatory.|\n|$pwd\\_error\\_message|UI for displaying error messages.|\n|$pwd\\_process\\_flow|UI for indicating current stage.|\n|$pwd\\_process\\_footer|JavaScript code to get the footer macro name.|\n|$pwd\\_reset\\_stylesheet|JavaScript code to get the default CSS file ID.|\n|$pwd\\_verify\\_personal\\_data\\_ui and $pwd\\_verify\\_personal\\_data\\_confirmation\\_ui|UI for verifying personal data and for confirming personal data.|\n|$pwd\\_verify\\_questions\\_ui|UI for verifying questions.|\n|$pwd\\_verify\\_simple\\_ui|Input section for a simple verification method. This field is a single input field.|\n\n## UI scripts installed with Password Reset\n\nYou can create a UI script and reference the script from a UI macro or UI page by using a &lt;g:include\\_script&gt; Jelly tag. The following example shows how the $pwd\\_enroll\\_questions\\_ui UI macro can reference the $pwd\\_enroll\\_questions\\_ui script. In the example, \\[UI Script Name\\]+\".jsdbx\" is the name of the script:\n\n```\n<g:include_script src=\"$pwd_enroll_questions_ui.jsdbx\" />\n```\n\nBy referencing an external script, you can maintain separation between client JavaScript code and Jelly code, which simplifies maintenance. You can use the following installed scripts with Password Reset UI macros:\n\n|Name|Description|\n|----|-----------|\n|$pwd\\_csrf\\_common\\_ui\\_script|Common UI script for handling a Cross-site Request Forgery \\(CSRF\\).|\n|$pwd\\_enroll\\_email\\_ui|JavaScript code for the $pwd\\_enroll\\_questions\\_ui UI macro.|\n|$pwd\\_enroll\\_google\\_auth\\_ui|JavaScript code for the $pwd\\_enroll\\_google\\_auth\\_ui UI macro.|\n|$pwd\\_enroll\\_questions\\_ui|JavaScript code for the $pwd\\_enroll\\_questions\\_ui UI macro.|\n|$pwd\\_enroll\\_sample\\_ui|Included sample client JavaScript for the $pwd\\_enroll\\_sample\\_ui UI macro.|\n|$pwd\\_enroll\\_sms\\_ui|SMS enrollment UI script.|\n|$pwd\\_enrollment\\_submit\\_event|UI script for an enrollment submission event.|\n|$pwd\\_util|Utilities for password reset UI pages and UI macros.|\n|$pwdWfManager|Helper class to handle workflow activities and post-processing.|\n\n## Password Reset workflows\n\nThe Password Reset plugin adds workflows that you can use as examples to create custom workflows for Password Reset processes.\n\n|Workflow|Description|\n|--------|-----------|\n|Pwd Reset - AD|Connects to an AD server.|\n|Pwd Reset - Local ServiceNow|Current \\(local\\) instance.|\n|Pwd Reset - Master|Password Reset primary workflow.|\n|Pwd Reset - Mock Fatal|Example workflow to use in Password Reset testing to simulate a fatal error. No retries.|\n|Pwd Reset - Mock Non Fatal|Example workflow to use in Password Reset testing to simulate a non-fatal error.|\n|Pwd Reset - Mock Success|Example workflow to use in Password Reset testing to simulate a successful completion.|\n|Pwd Reset - Remote ServiceNow|Connects to a remote\\(SOAP\\) ServiceNow instance.|\n\n|Workflow|Description|\n|--------|-----------|\n|Pwd Connection Test - AD|Tests connection to an AD server.|\n|Pwd Connection Test - Local SN|Tests connection to local instance.|\n|Pwd Connection Test - Master|Master workflow to test credential store connectivity.|\n|Pwd Connection Test - Mock Failure|Example credential store connection test that simulates a failed connection.|\n|Pwd Connection Test - Mock Success|Example credential store connection test that simulates a successful connection.|\n|Pwd Connection Test - Remote SN|Tests connection to a remote\\(SOAP\\) ServiceNow instance.|\n\n|Workflow|Description|\n|--------|-----------|\n|Pwd Get Lock State - AD|Gets a user account lock state for the AD server.|\n|Pwd Get Lock State - Local SN|Workflow to get a user account lock state for the local instance.|\n|Pwd Get Lock State - Master|Primary workflow to get a user account lock state.|\n|Pwd Get Lock State - Remote SN|Gets a user account lock state for the remote\\(SOAP\\) ServiceNow instance.|\n\n|Workflow|Description|\n|--------|-----------|\n|Pwd Unlock Account – AD|Unlocks a user account for a local instance.|\n|Pwd Unlock Account - Local SN|Workflow to unlock a user account for a local instance.|\n|Pwd Unlock Account - Master|Master workflow to unlock a user account.|\n|Pwd Unlock Account – Remote SN|Unlocks a user account for a remote\\(SOAP\\) ServiceNow instance.|\n\n|Workflow|Description|\n|--------|-----------|\n|Pwd Change - Master|Password change primary workflow.|\n|Pwd Change – Local ServiceNow|Connects to a local instance to change a password.|\n|Pwd Change – AD|Connects to an AD server to change a password.|\n|Pwd Change – Remote ServiceNow|Connects to a remote\\(SOAP\\) ServiceNow instance to change a password.|\n\n## Password Reset notifications\n\n<table id=\"table_a25_cff_wcb\"><thead><tr><th>\n\nName\n\n</th><th>\n\nFired by event name\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nPassword Reset – Send SMS Code\n\n</td><td>\n\npwd.send\\_sms\\_code.trigger\n\n</td><td>\n\nSends out SMS authentication code for verification.\n\n</td></tr><tr><td>\n\n\\[K\\] Password Reset – Send Email Code\n\n</td><td>\n\npwd.send\\_email\\_code.trigger\n\n</td><td>\n\nSends out authentication code via Email for verification.\n\n</td></tr><tr><td>\n\nPassword Reset - Enrollment Reminder\n\n</td><td>\n\npwd.enrollment\\_reminder.trigger\n\n</td><td>\n\nSends emails to remind users to enroll in the required verifications.\n\n</td></tr><tr><td>\n\nPassword Reset - New Password Confirmation\n\n</td><td>\n\npwd.email.trigger\n\n</td><td>\n\nFor the Email/SMS Password process, sends an email or SMS \\(if configured\\) that includes the new password.\n\n</td></tr><tr><td>\n\nPassword Reset - Send Verify Code\n\n</td><td>\n\npwd.send\\_verify\\_code.trigger\n\n</td><td>\n\nSends authentication code to users using email or SMS for password reset or enrollment.**Note:** If the Notify plugin is active, SMS code is sent via Twilio instead of ServiceNow Notification.\n\n</td></tr><tr><td>\n\nPassword Reset URL\n\n</td><td>\n\npassword.reset.url\n\n</td><td>\n\nFor the Email/SMS Password Reset URL process: Sends email or SMS \\(if configured\\) that includes a link to the password reset URL.**Note:** Check the following items if the instance does not send the email notification to the user:\n\n-   Check the System Event \\[sys\\_event\\] table to see if the email was sent.\n-   Verify that the user is subscribed to the notification.\n-   Verify that the Default Self Service password reset process and password reset properties are configured correctly.\n\n</td></tr></tbody>\n</table>## SOAP messages for Password Reset\n\n|SOAP Message|Description|\n|------------|-----------|\n|Change Password|When the Orchestration Add-on plugin is active, the system can use the SOAP protocol to change passwords on remote credential stores such as a remote ServiceNow instance.|\n|Password Reset Request|When the Orchestration Add-on plugin is active, the system can use the SOAP protocol to reset passwords on remote credential stores such as a remote ServiceNow instance.|\n\n## REST API\n\n-   Name: Pwd Reset\n-   API ID: pwd\\_reset\n-   Base API path: /api/now/pwd\\_reset\n\n|Name|Resource path|API Version|Description|\n|----|-------------|-----------|-----------|\n|pwd\\_init|/api/now/v1/pwd\\_reset/init|v1|Initial request to establish session, write logs, and fetch UI messages.|\n|pwd\\_identify|/api/now/v1/pwd\\_reset/identify|v1|Get identification page components.|\n|pwd\\_verify|/api/now/v1/pwd\\_reset/verify|v1|Get verification page components.|\n|pwd\\_new|/api/now/v1/pwd\\_reset/reset|v1|Get resetting password page components.|\n|pwd\\_success|/api/now/v1/pwd\\_reset/success|v1|Get success page components.|\n|pwd\\_failure|/api/now/v1/pwd\\_reset/failure|v1|Get failure page components.|\n\n|Name|Resource path|API Version|Description|\n|----|-------------|-----------|-----------|\n|pwd\\_init|/api/now/v2/pwd\\_reset/init|v2|Initial request to establish session, write logs, and fetch UI messages.|\n|pwd\\_identify|/api/now/v2/pwd\\_reset/identify|v2|Get identification page components.|\n|pwd\\_verify|/api/now/v2/pwd\\_reset/verify|v2|Get verification page components.|\n|pwd\\_new|/api/now/v2/pwd\\_reset/reset|v2|Get reset password page components.|\n|pwd\\_success|/api/now/v2/pwd\\_reset/success|v2|Get success page components.|\n|pwd\\_failure|/api/now/v2/pwd\\_reset/failure|v2|Get failure page components.|\n\n"}}