1. Docs
  2. API Reference
  3. EnvironmentAuthSettingsResponseDto

EnvironmentAuthSettingsResponseDto

Example

JSON
{
  "environment_slug": "string",
  "mfa_required": false,
  "mfa_grace_period_days": 0,
  "mfa_trusted_device_days": 0,
  "mfa_factor_allowlist": [
    "string"
  ],
  "mfa_after_sso": "exempt",
  "webauthn_rp_id": "string",
  "webauthn_origins": [
    "string"
  ],
  "allow_self_signup": false,
  "self_signup_require_captcha": false,
  "login_require_captcha": false,
  "password_login_enabled": false,
  "email_otp_login_enabled": false,
  "self_signup_daily_cap": 0,
  "access_token_ttl_seconds": 0,
  "refresh_token_ttl_days": 0,
  "allowed_web_origins": [
    "string"
  ],
  "sso_return_urls": [
    "string"
  ]
}

Properties

18 properties 8 required

environment_slug string Required

Environment slug the settings belong to

mfa_required boolean Required

Effective MFA enforcement, defaults hydrated

mfa_grace_period_days number Required
mfa_trusted_device_days number Required
mfa_factor_allowlist array of string Required
mfa_after_sso enum Required

What an SSO login owes the MFA gate

Enumexemptrequire
webauthn_rp_id string Required

Relying-party id passkeys under this Environment are bound to, or null when they use Canopy's relying party.

nullable
webauthn_origins array of string Required

Origins allowed to run WebAuthn ceremonies under `webauthn_rp_id`. Empty when the Environment uses Canopy's relying party.

allow_self_signup boolean Optional
self_signup_require_captcha boolean Optional
login_require_captcha boolean Optional
password_login_enabled boolean Optional
email_otp_login_enabled boolean Optional
self_signup_daily_cap number Optional
access_token_ttl_seconds number Optional
refresh_token_ttl_days number Optional
allowed_web_origins array of string Optional
sso_return_urls array of string Optional
Was this page helpful?

Tell us how we can improve this guide.

Canopy