# Require a second factor at sign-in PATCH /v1/auth/settings ```sh curl --request PATCH \ --url https://example.com/v1/auth/settings \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "secondFactor": { "required": true } }' ``` Covers signing in by the deployment’s own ways in (the emailed link, and providers like Google, Microsoft and GitHub). Signing in through the workspace’s own identity provider is exempt: it owns MFA there. A site’s people sign in through the site, which owns their second factor, so the setting doesn’t apply to them. Once required, a session made without a second factor ends at its next request, and signing in to the console with an API token is refused. API keys aren’t covered: keep them to service accounts, and rotate them. From a session, turning it on takes a session made with your own second factor (`409 second-factor-enroll-first`): it would end yours. Audited. Tenant admins only. Mounted when the deployment keeps second factors (from 0.1.9). ## Authorizations - **[bearerAuth](https://docs.kindgi.com/v0.1.9/reference/api.md#bearerauth)** ## Parameters ### Header Parameters **Idempotency-Key** string \>= 1 characters Caller-supplied idempotency key, scoped to the caller: the same key from someone else in the tenant is their own request (from 0.1.5). Retries with the same key return the original response byte-identical (per `docs/API-ROUTE-CONVENTIONS.md` §3.1). A retry sent while the first request still runs is answered `409 idempotency-key-in-flight` with `Retry-After`, on a runtime whose store holds keys (from 0.1.5); retry after it, and you get the first request’s answer. An answer that carries a secret (a new API key or public run token, a session token, a generated signing secret) isn’t kept: a retry gets `409 idempotency-key-replay-withheld`, with the first request’s status and when it succeeded (from 0.1.5). ## Request Bodyrequired application/json Require a second factor at sign-in, or stop requiring one. object **secondFactor** required object **required** required boolean ##### Examplegenerated ```json { "secondFactor": { "required": true } } ``` ## Responses ### 200 The settings, after. application/json The workspace’s sign-in settings. object **secondFactor** required object **required** required Signing in by the deployment’s own ways in takes a second factor. Signing in through the workspace’s own identity provider is exempt: it owns MFA there. A site’s people sign in through the site, which owns their second factor, so the setting doesn’t apply to them. API keys aren’t covered. boolean **onPreviousSecret** required People whose key is still kept under the deployment’s previous sign-in secret: each moves to the current one at their next code. Keep the previous secret configured until this is 0. integer **unusable** required People whose key opens under neither secret: they need a recovery code, or an admin to remove it. integer ##### Examplegenerated ```json { "secondFactor": { "required": true, "onPreviousSecret": 1, "unusable": 1 } } ``` ### 400 Malformed request body. application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 401 Missing / malformed / expired / revoked bearer token. application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 403 Not a tenant admin. application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 409 Turned on from a session made without a second factor (`second-factor-enroll-first`), or an idempotency conflict. application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 413 The request body is over the API’s limit (`request-too-large`; `details.maxBytes` says how much). application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ### 500 Server error (unmapped domain code or framework crash). application/json object **error** required object **code** required Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3). string **message** required string **details** Optional, kind-specific. object **_key_** additional properties any **requestId** required Server-assigned request id; also echoed via `X-Request-Id` header. string ##### Examplegenerated ```json { "error": { "code": "example", "message": "example", "details": {}, "requestId": "example" } } ``` ## See also - [`GET /v1/auth/settings`: The workspace's sign-in settings](https://docs.kindgi.com/v0.1.9/reference/api/operations/authsettingsget.md) - [Error code `request-too-large`](https://docs.kindgi.com/v0.1.9/reference/errors.md#request-too-large) - [Error code `second-factor-enroll-first`](https://docs.kindgi.com/v0.1.9/reference/errors.md#second-factor-enroll-first) - [Every error code](https://docs.kindgi.com/v0.1.9/reference/errors.md)