tenants

Update Workspace Sign-in Settings

Partial update: send only the keys to change; null resets a key to inherit. methods_allowed narrows the sign-in methods offered and accepted (each still has to be set up); the integer keys must sit within the returned limits, and access_ttl_sec, refresh_ttl_sec and max_sessions can only be lowered below the instance's own values. 400 invalid_settings for an unknown key, wrong type or out-of-range value; 400 above_instance_limit for a value above the instance's; 409 lockout when methods_allowed leaves no method set up for the workspace, or none the caller can sign in with; 409 public_workspace for the Public workspace, which always uses the instance's settings. tenant_admin of the workspace, or a platform admin. Audited with before and after values.

patch/tenants/{id}/auth-settings

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/tenants/{id}/auth-settings
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Path parameters

idstring required

tenant id

Request body

access_ttl_secinteger
email_otp_lengthinteger
email_otp_ttl_secinteger
max_sessionsinteger
methods_allowedstring[]
otp_max_attemptsinteger
refresh_ttl_secinteger

Example request

{
  "access_ttl_sec": 3600,
  "email_otp_length": 6,
  "email_otp_ttl_sec": 600,
  "max_sessions": 10,
  "otp_max_attempts": 5,
  "refresh_ttl_sec": 2592000
}

Response

OK

successboolean

Example response

{
  "data": {
    "effective": {
      "access_ttl_sec": 3600,
      "email_otp_length": 6,
      "email_otp_ttl_sec": 600,
      "max_sessions": 10,
      "otp_max_attempts": 5,
      "refresh_ttl_sec": 2592000
    },
    "stored": {
      "access_ttl_sec": 3600,
      "email_otp_length": 6,
      "email_otp_ttl_sec": 600,
      "max_sessions": 10,
      "otp_max_attempts": 5,
      "refresh_ttl_sec": 2592000
    }
  },
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.