OrganizationPolicyResponseDto

Example

JSON

{
  "organization_id": "string",
  "mfa_required": false,
  "mfa_factor_allowlist": [
    "totp"
  ],
  "mfa_after_sso": "exempt",
  "allowed_sign_in_methods": [
    "password"
  ],
  "require_sso": false,
  "environment": {
    "mfa_required": false,
    "mfa_factor_allowlist": [
      "totp"
    ],
    "mfa_after_sso": "exempt",
    "allowed_sign_in_methods": [
      "password"
    ],
    "require_sso": false
  },
  "effective": {
    "mfa_required": false,
    "mfa_factor_allowlist": [
      "totp"
    ],
    "mfa_after_sso": "exempt",
    "allowed_sign_in_methods": [
      "password"
    ],
    "require_sso": false
  },
  "version": 0,
  "sso_recovery_codes_generation": 0,
  "sso_recovery_codes_remaining": 0,
  "sso_recovery_codes": [
    "string"
  ]
}

Properties

12 properties 7 required

organization_id string Required

The organization this policy belongs to.

mfa_required boolean Optional

nullable

mfa_factor_allowlist array of enum Optional

nullable

mfa_after_sso enum Optional

Enumexemptrequirenullable

allowed_sign_in_methods array of enum Optional

The methods the organization keeps of the Environment's, or null to inherit them all.

nullable

require_sso boolean Required

environment object Required

The Environment's own settings, the floor this organization's policy tightens from.

effective object Required

The policy the organization's members sign in under.

version number Required

Optimistic-concurrency version. 0 until the organization sets a policy of its own.

sso_recovery_codes_generation number Required

Batch number of the organization's SSO recovery codes; 0 while it requires no SSO.

sso_recovery_codes_remaining number Required

Unspent SSO recovery codes in the current batch.

sso_recovery_codes array of string Optional

The SSO recovery codes, present only on the response to the write that turned `require_sso` on. Shown once; stored as hashes.

nullable

Was this page helpful?

Tell us how we can improve this guide.