Skip to content
Kindgi

The workspace's sign-in settings

View as Markdown
GET
/v1/auth/settings
curl --request GET \
  --url https://example.com/v1/auth/settings \
  --header 'Authorization: Bearer <token>'

Whether signing in takes a second factor, and how many people’s keys are still on the deployment’s previous sign-in secret, or on neither. Tenant admins only. Mounted when the deployment keeps second factors (from 0.1.9).

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The settings.

Media typeapplication/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
{
  "secondFactor": {
    "required": true,
    "onPreviousSecret": 1,
    "unusable": 1
  }
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/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
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

403

Section titled “403”

Not a tenant admin.

Media typeapplication/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
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also