Skip to main content
API version 2025.0 The enterprise configuration for the security category.
custom_session_duration_groups
object
Groups for custom session duration.
custom_session_duration_value
object
Value indicating duration users from specified groups can remain logged in without activity before being logged out.
enforced_mfa_frequency
object
Managed Users multi-factor authentication frequency. The default authentication frequency is set to 30 days, with authentication time calculated from the most recent successful MFA login.
external_collab_multi_factor_auth_settings
object
External Collaborators multi-factor authentication settings.
failed_login_attempts_to_trigger_admin_notification
object
Number of failed login attempts before the primary admin is notified.
is_custom_session_duration_enabled
object
Enables custom session duration for select users.
is_managed_user_email_change_disabled
object
When enabled, prevents users from changing their primary email address.
is_managed_user_migration_disabled
object
Disables users from being migrated in or out of the enterprise.
is_managed_user_signup_corporate_email_enabled
object
When enabled, admin are emailed when new users are added.
is_managed_user_signup_enabled
object
Determines if users are allowed to sign up on their own.
is_managed_user_signup_notification_enabled
object
Determines if users must sign up with your corporate email.
is_multi_factor_auth_required
object
Determines if multi-factor authentication is required for all managed users.
is_new_user_notification_daily_digest_enabled
object
Depends on is_managed_user_signup_corporate_email_enabled. A true value represents In daily summary emails. A false value represents Immediately.
is_password_change_notification_enabled
object
When enabled, admins are notified when users change passwords in Settings.
is_password_leak_detection_enabled
object
Enables exposed password detection.
is_password_request_notification_enabled
object
When enabled, admins are notified when users request a forget password email.
is_strong_password_for_ext_collab_enabled
object
Requires strong passwords for External Collaborators.
is_weak_password_prevention_enabled
object
When enabled, prevents common words / email address to be used in a password.
Join url for self sign up. Depends on is_managed_user_signup_enabled. Applies if join_url is not used.
join_url
object
Join url for self sign up. Depends on is_managed_user_signup_enabled. Applies if join_link is not used.
keysafe
object
The basic data included in each enterprise configuration response object.
last_password_reset_at
object
The basic data included in each enterprise configuration response object.
multi_factor_auth_type
object
Managed Users multi-factor authentication requirement method type.
password_min_length
object
Minimum number of characters required for passwords.
password_min_numeric_characters
object
Minimum number of numbers required in passwords.
password_min_special_characters
object
Minimum number of symbols required in passwords.
password_min_uppercase_characters
object
Minimum number of upper case characters required in passwords.
password_reset_frequency
object
Determines if users must reset their passwords every specified time period.
previous_password_reuse_limit
object
Number of previous passwords users are prevented from using.
session_duration
object
Value indicating time from the last activity a user can remain logged in without activity before being logged out.
{
  "custom_session_duration_groups": {
    "is_used": true,
    "value": [
      {
        "id": "1234",
        "name": "Group Name"
      }
    ]
  },
  "custom_session_duration_value": {
    "is_used": true,
    "value": "value of configuration"
  },
  "enforced_mfa_frequency": {
    "is_used": true,
    "value": {
      "days": 30,
      "hours": 24
    }
  },
  "external_collab_multi_factor_auth_settings": {
    "is_used": true,
    "value": {
      "allowlist_domains": [
        "example.com"
      ],
      "allowlist_emails": [
        "[email protected]"
      ],
      "denylist_domains": [
        "example.com"
      ],
      "denylist_emails": [
        "[email protected]"
      ],
      "factor_type_settings": "totp",
      "scheduled_at": "2012-12-12T10:53:43-08:00",
      "scheduled_status": "inprogress",
      "state": "enabled"
    }
  },
  "failed_login_attempts_to_trigger_admin_notification": {
    "is_used": true,
    "value": 1234
  },
  "is_custom_session_duration_enabled": {
    "is_used": true,
    "value": true
  },
  "is_managed_user_email_change_disabled": {
    "is_used": true,
    "value": true
  },
  "is_managed_user_migration_disabled": {
    "is_used": true,
    "value": true
  },
  "is_managed_user_signup_corporate_email_enabled": {
    "is_used": true,
    "value": true
  },
  "is_managed_user_signup_enabled": {
    "is_used": true,
    "value": true
  },
  "is_managed_user_signup_notification_enabled": {
    "is_used": true,
    "value": true
  },
  "is_multi_factor_auth_required": {
    "is_used": true,
    "value": true
  },
  "is_new_user_notification_daily_digest_enabled": {
    "is_used": true,
    "value": true
  },
  "is_password_change_notification_enabled": {
    "is_used": true,
    "value": true
  },
  "is_password_leak_detection_enabled": {
    "is_used": true,
    "value": true
  },
  "is_password_request_notification_enabled": {
    "is_used": true,
    "value": true
  },
  "is_strong_password_for_ext_collab_enabled": {
    "is_used": true,
    "value": true
  },
  "is_weak_password_prevention_enabled": {
    "is_used": true,
    "value": true
  },
  "join_link": {
    "is_used": true,
    "value": "value of configuration"
  },
  "join_url": {
    "is_used": true,
    "value": "value of configuration"
  },
  "keysafe": {
    "is_used": true,
    "value": {
      "account_id": "1234",
      "cloud_provider": "",
      "key_id": "1234",
      "keyring_id": "1234",
      "keysafe_enabled": true,
      "location_id": "1234",
      "project_id": "1234"
    }
  },
  "last_password_reset_at": {
    "is_used": true,
    "value": "2012-12-12T10:53:43-08:00"
  },
  "multi_factor_auth_type": {
    "is_used": true,
    "value": "value of configuration"
  },
  "password_min_length": {
    "is_used": true,
    "value": 1234
  },
  "password_min_numeric_characters": {
    "is_used": true,
    "value": 1234
  },
  "password_min_special_characters": {
    "is_used": true,
    "value": 1234
  },
  "password_min_uppercase_characters": {
    "is_used": true,
    "value": 1234
  },
  "password_reset_frequency": {
    "is_used": true,
    "value": "value of configuration"
  },
  "previous_password_reuse_limit": {
    "is_used": true,
    "value": "value of configuration"
  },
  "session_duration": {
    "is_used": true,
    "value": "value of configuration"
  }
}