Developers
Access and sign-up8

Update authentication settings

PATCH/settings/authentication

Updates the authentication settings. Only the fields included in the request are changed: setting a field to null clears its configured value and restores the default, and omitted fields are left unchanged. Images are referenced by the ID of a file that belongs to the account.

Secrets such as recaptcha.secret and google_login.client_secret are write-only. Changes take effect at the next login; active sessions are not terminated.

To avoid overwriting a newer version, send the ETag returned by the retrieve operation in the If-Match header. The header is optional; when it is omitted, the update is applied to the current revision.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

If-Match?string

Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. * matches the current revision. Any other value fails with 400 and the if_match_invalid error code. When omitted, the update is applied to the current revision.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/settings/authentication" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "access_screens": {      "accent_color": "string",      "background": {        "image": {          "file_id": "string",          "url": "string"        },        "position": "string",        "size": "string"      },      "form_position": "string",      "logo": {        "file_id": "string",        "url": "string"      },      "logo_align": "string",      "model": "classico",      "phrase": "string",      "theme": "string"    },    "admin_two_factor_available": true,    "defaults": {},    "effects": {      "sessions": "next_login"    },    "google_login": {      "client_id": "string",      "configured": true,      "enabled": true    },    "max_devices": 1,    "object": "settings",    "password": {      "configured": true,      "field": "email",      "rules": {        "digits": 0,        "letters": 0,        "lowercase": 0,        "min_length": 0,        "special_chars": 0,        "uppercase": 0      },      "strong": true    },    "propagation": {},    "recaptcha": {      "configured": true,      "enabled": true,      "site_key": "string"    },    "replica": {},    "revision": "string"  }}

Retrieve authentication settings GET

Returns the authentication settings of the account: password rules, reCAPTCHA, two-factor authentication for administrators, Google sign-in, the device limit, and the layout of the access screens. Secrets are never returned; the `configured` fields indicate whether they have been set. The response includes an `ETag` representing the current revision of these settings; changes to other settings groups do not affect it. Send this value in the `If-Match` header when updating these settings to avoid overwriting a newer version.

Retrieve registration settings GET

Returns the registration settings of the account: public sign-up, domain restrictions, whether a document is required, and the highlight applied to users with free access. The response includes an `ETag` representing the current revision of these settings; changes to other settings groups do not affect it. Send this value in the `If-Match` header when updating these settings to avoid overwriting a newer version.