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.
Returns the full settings object for the current tenant. Settings control security policies, session behavior, risk engine thresholds, and branding.
Tenant SettingsAuth
Get the current tenant's settings.
Status Codes
- Name
200- Type
- HTTP
- Description
- Settings returned
- Name
401- Type
- HTTP
- Description
- Invalid or expired access token
- Name
403- Type
- HTTP
- Description
- Missing settings:read permission
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.
Tenant SettingsAuth
Update tenant settings (deep merge).
Payload Example
{
"password_policy": {
"min_length": 12,
"max_age_days": 60
},
"mfa": {
"enforced": true
},
"session": {
"max_concurrent_sessions": 3
}
}Status Codes
- Name
200- Type
- HTTP
- Description
- Settings updated — full settings returned
- Name
401- Type
- HTTP
- Description
- Invalid or expired access token
- Name
403- Type
- HTTP
- Description
- Missing settings:write permission
- Name
422- Type
- HTTP
- Description
- Invalid setting value (see error details)
Returns the JSON Schema describing all available settings fields, their types, valid ranges, and defaults. Useful for building dynamic settings UIs.
Settings SchemaAuth
Get the settings validation schema.
Status Codes
- Name
200- Type
- HTTP
- Description
- Schema returned
- Name
401- Type
- HTTP
- Description
- Invalid or expired access token
- Name
403- Type
- HTTP
- Description
- Missing settings:read permission
Returns available plans and their feature limits/quotas. Useful for displaying plan comparison or enforcing quota checks.
PlansAuth
Get available plans and their quotas.
Status Codes
- Name
200- Type
- HTTP
- Description
- Plans list returned
- Name
401- Type
- HTTP
- Description
- Invalid or expired access token
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.