Docs/Account/API/Settings

Settings API

Get and update per-tenant configuration: password policies, MFA enforcement, session limits, risk engine thresholds, branding, email templates, and more. Also retrieve the settings schema and available plans.

Base URL: https://id.vyntech.com.au/api/v1 — Reading settings requires settings:read; updating requires settings:write.

Get Tenant Settings

Returns the full settings object for the current tenant. Settings control security policies, session behavior, risk engine thresholds, and branding.

GET/api/v1/settings🔒 Auth

Get the current tenant's settings.

curl https://id.vyntech.com.au/api/v1/settings \ -H "Authorization: Bearer eyJhbGciOiJFZERTQSIs..."

Update Tenant Settings

Updates one or more settings sections. This is a deep merge — you only need to send the fields you want to change. Unspecified fields retain their current values.

PATCH/api/v1/settings🔒 Auth

Update tenant settings (deep merge).

curl -X PATCH https://id.vyntech.com.au/api/v1/settings \ -H "Authorization: Bearer eyJhbGciOiJFZERTQSIs..." \ -H "Content-Type: application/json" \ -d '{ "password_policy": {"min_length": 12, "max_age_days": 60}, "mfa": {"enforced": true}, "session": {"max_concurrent_sessions": 3} }'

Request Body

{
  "password_policy": {
    "min_length": 12,
    "max_age_days": 60
  },
  "mfa": {
    "enforced": true
  },
  "session": {
    "max_concurrent_sessions": 3
  }
}

Get Settings Schema

Returns the JSON Schema describing all available settings fields, their types, valid ranges, and defaults. Useful for building dynamic settings UIs.

GET/api/v1/settings/schema🔒 Auth

Get the settings validation schema.

curl https://id.vyntech.com.au/api/v1/settings/schema \ -H "Authorization: Bearer eyJhbGciOiJFZERTQSIs..."

Get Plans

Returns available plans and their feature limits/quotas. Useful for displaying plan comparison or enforcing quota checks.

GET/api/v1/plans🔒 Auth

Get available plans and their quotas.

curl https://id.vyntech.com.au/api/v1/plans \ -H "Authorization: Bearer eyJhbGciOiJFZERTQSIs..."

Quota values: A value of -1 means unlimited. When a tenant exceeds a quota, the relevant create/register endpoints will return 402 Payment Required with a message indicating which limit was hit.

What's Next

Public Endpoints →

Branding, password policy, OIDC discovery — no auth required.

Tenant Settings Guide →

In-depth guide on configuring every tenant setting.

Plans & Quotas Guide →

Understand plan limits and how to handle quota errors.

Tenants API →

Create and manage tenants.