# Replace the environment's end-user auth settings

<div class="api-op" data-api-operation>
<div class="api-op__main">

<p class="api-endpoint"><span class="method method-put">PUT</span> <code>/v1/user_management/settings</code></p>

<dl class="api-facts"><div><dt>Scope</dt><dd><code>users:write</code></dd></div><div><dt>Auth</dt><dd>Secret key (<code>sk_…</code>)</dd></div><div><dt>Since</dt><dd>1.0</dd></div></dl>

## Headers

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">OhAuthCat-Version</code> <span class="api-field__type">string</span></p>
Minor version; defaults to the environment's pin.
</li>
</ul>

## Request body

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">app_name</code> <span class="api-field__type">string or null</span></p>

<p class="api-field__chips">max length 100</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">methods</code> <span class="api-field__type">array of string</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">min items 1</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">password_min_length</code> <span class="api-field__type">integer</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">min 8 · max 64</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">password_history</code> <span class="api-field__type">integer</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">min 0 · max 24</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">password_check_breached</code> <span class="api-field__type">boolean</span> <span class="api-field__required">Required</span></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">password_require_character_types</code> <span class="api-field__type">boolean</span></p>
Passwords must contain at least one uppercase letter, one lowercase letter, one number and one symbol (any character that is not a letter or digit; Unicode-aware, and a letter of a script without case counts as both upper and lower case). On by default for every environment (D191). A password that lacks one is refused with `password_invalid`, `param: password` and one `details` item per missing type (`problem`: `missing_uppercase`, `missing_lowercase`, `missing_number` or `missing_symbol`). Omitted on update means true.

<p class="api-field__chips">default <code>true</code></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">bind_browser</code> <span class="api-field__type">boolean</span> <span class="api-field__required">Required</span></p>
Email codes and reset links work only in the browser that asked for them.
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">mfa_policy</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">one of <code>off</code>, <code>optional</code>, <code>required</code></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">linking_rule</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>
Whether a social sign-in may join an existing user, and only on an email the provider asserts is verified.

<p class="api-field__chips">one of <code>verified_email</code>, <code>never</code></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">session_absolute_seconds</code> <span class="api-field__type">integer</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">min 300 · max 7776000</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">session_idle_seconds</code> <span class="api-field__type">integer</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">min 300 · max 7776000</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">require_name</code> <span class="api-field__type">boolean</span></p>
Sign-up on the hosted pages asks for a first and last name. Absent reads as false.
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">native_app_origins</code> <span class="api-field__type">array of string</span></p>
Native apps whose passkey ceremonies are accepted on the hosted sign-in relying party, as android:apk-key-hash:&lt;base64url SHA-256 of the signing certificate&gt; or ios:&lt;team id&gt;.&lt;bundle id&gt;. Absent reads as none.

<p class="api-field__chips">max items 20</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">android_apps</code> <span class="api-field__type">array of AndroidAppLink</span></p>
Android package names for the sign-in host's /.well-known/assetlinks.json (passkeys and sign-in credentials shared with the app). Each apk_key_hash must also be listed in native_app_origins as android:apk-key-hash:&lt;hash&gt;. Absent reads as none.

<p class="api-field__chips">max items 20</p>
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">200</span> <span>OK <span class="api-field__type">UserManagementSettings</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">400</span> <span>Invalid request. Codes: <a href="/errors/parameter_invalid/">parameter_invalid</a>, <a href="/errors/parameter_missing/">parameter_missing</a>, <a href="/errors/version_unsupported/">version_unsupported</a> and resource-specific codes from the catalogue. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">401</span> <span>Codes: <a href="/errors/authentication_required/">authentication_required</a>, <a href="/errors/api_key_invalid/">api_key_invalid</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">403</span> <span>Codes: <a href="/errors/api_key_scope_missing/">api_key_scope_missing</a>, <a href="/errors/ip_not_allowed/">ip_not_allowed</a>, <a href="/errors/plan_limit_reached/">plan_limit_reached</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">404</span> <span>Code: <a href="/errors/resource_not_found/">resource_not_found</a> (also returned for other tenants' IDs); a path no endpoint serves answers <a href="/errors/route_not_found/">route_not_found</a>. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">429</span> <span>Code: <a href="/errors/rate_limited/">rate_limited</a>. Retry-After is set. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">503</span> <span>Code: <a href="/errors/service_unavailable/">service_unavailable</a>. Retry-After is set; writes are paused. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--neutral">default</span> <span>Any other error, including <a href="/errors/internal_error/">internal_error</a>. Every code is in the error catalogue. <span class="api-field__type">Error</span></span></li>
</ul>

Errors share one shape; see the [error code catalogue](/errors/).

</div>
<div class="api-op__code">

**curl**

```sh wrap
curl -X PUT \
  "https://api.ohauthcat.com/v1/user_management/settings" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "methods": [
    "password"
  ],
  "password_min_length": 8,
  "password_history": 0,
  "password_check_breached": true,
  "bind_browser": true,
  "mfa_policy": "off",
  "linking_rule": "verified_email",
  "session_absolute_seconds": 300,
  "session_idle_seconds": 300
}'
```

**Node**

```javascript wrap
const response = await fetch(
  "https://api.ohauthcat.com/v1/user_management/settings",
  {
    method: "PUT",
    headers: {
      Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      methods: ["password"],
      password_min_length: 8,
      password_history: 0,
      password_check_breached: true,
      bind_browser: true,
      mfa_policy: "off",
      linking_rule: "verified_email",
      session_absolute_seconds: 300,
      session_idle_seconds: 300,
    }),
  },
);
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.put(
    "https://api.ohauthcat.com/v1/user_management/settings",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
    json={
        "methods": [
            "password",
        ],
        "password_min_length": 8,
        "password_history": 0,
        "password_check_breached": True,
        "bind_browser": True,
        "mfa_policy": "off",
        "linking_rule": "verified_email",
        "session_absolute_seconds": 300,
        "session_idle_seconds": 300,
    },
)
data = response.json()
```

```json title="Response 200" wrap
{
  "app_name": "example_app_name",
  "methods": ["password"],
  "password_min_length": 8,
  "password_history": 0,
  "password_check_breached": true,
  "password_require_character_types": true,
  "bind_browser": true,
  "mfa_policy": "off",
  "linking_rule": "verified_email",
  "session_absolute_seconds": 300,
  "session_idle_seconds": 300,
  "require_name": true,
  "native_app_origins": ["example_native_app_origin"],
  "android_apps": [
    {
      "package_name": "example_package_name",
      "apk_key_hash": "example_apk_key_hash"
    }
  ]
}
```

</div>
</div>
