> For the complete documentation index, see [llms.txt](https://docs.fortifiedid.se/password-reset/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fortifiedid.se/password-reset/modules/passwordreset/properties.md).

# Properties

This section includes the main parameters for the PasswordReset module.

### File location

The file containing the properties is called `pwdreset.json` and is located in `<installation path>\pwdreset\config\modules`, where the installation path depends on the operating system and installation setup.

### Configuration

{% tabs %}
{% tab title="Properties" %}

<table><thead><tr><th width="215">Name</th><th width="240">Description</th><th width="207.640625" align="center">Default value</th><th data-type="checkbox">Mandatory</th></tr></thead><tbody><tr><td><code>name</code></td><td>Must be set to <em>PasswordReset</em></td><td align="center"><code>PasswordReset</code></td><td>true</td></tr><tr><td><code>http_port</code></td><td>Port</td><td align="center"><code>8080</code></td><td>false</td></tr><tr><td><code>http_context</code></td><td>The context under which the application is served.</td><td align="center"><code>/pwdreset</code></td><td>false</td></tr><tr><td><code>webroot_dir</code></td><td>Where to load web resources from.</td><td align="center"><code>web</code></td><td>false</td></tr><tr><td><code>http_auth_redirect_url</code></td><td>Where to send the user for authentication.</td><td align="center"><code>/pwdreset/authn/login</code></td><td>false</td></tr><tr><td><code>logout_endpoint_url</code></td><td>Sets the post-logout destination for Password Reset. When the application runs behind AuthN, this value takes precedence over the AuthN SAMLSP <code>logout_location</code>. Click <a href="https://docs.fortifiedid.se/information-endpoint">link</a> for more info.</td><td align="center"><code>/pwdreset/logged_out/</code></td><td>false</td></tr><tr><td><code>overlay_dir</code></td><td>Where to load the overlaid resources from.</td><td align="center">N/A</td><td>false</td></tr><tr><td><code>pipe_id</code></td><td>Pipe to execute.</td><td align="center">N/A</td><td>true</td></tr><tr><td><code>rules</code></td><td>Array containing the rules parameters. Used for a single policy configuration.</td><td align="center"><code>[]</code></td><td>false</td></tr><tr><td><code>rule_policies</code></td><td>Array containing named password rule policies. The active policy is selected from the session parameter <code>password_policy</code>. One policy must have <code>default: true</code>.</td><td align="center"><code>[]</code></td><td>false</td></tr></tbody></table>
{% endtab %}

{% tab title="Example" %}

```json
{
  "name" : "PasswordReset",
  "config" : {
    "http_listener" : "default",
    "pipe_id" : "pwdreset",
    "overlay_dir" : "${system.customer_home}/overlay/",
    "logout_endpoint_url" : "${globals.logout_endpoint_url}",
    "rule_policies" : "@include:rules/rules.json"
  }
}
```

{% endtab %}
{% endtabs %}
