Box Developer Documentation

Enterprise configuration security

The enterprise configuration for the security category.

Groups for custom session duration.

true

Indicates whether a configuration is used for a given enterprise.

string
1234

Group ID (numerical).

Group Name

Group Name.

Value indicating duration users from specified groups can remain logged in without activity before being logged out.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

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.

true

Indicates whether a configuration is used for a given enterprise.

integer
30

Number of days before the user is required to authenticate again.

integer
24

Number of hours before the user is required to authenticate again.

External Collaborators multi-factor authentication settings.

true

Indicates whether a configuration is used for a given enterprise.

External collab security settings.

["example.com"]

List of domains that are allowed for external collaboration. Applies if state is allowlist.

["mail@example.com"]

List of email addresses that are allowed for external collaboration. Applies if state is allowlist.

["example.com"]

List of domains that are not allowed for external collaboration. Applies if state is denylist.

["spam@example.com"]

List of email addresses that are not allowed for external collaboration. Applies if state is denylist.

totp

Factor type for the external collaborators authentication. Possible values include totp, any, or unknown.

string (date-time)
2012-12-12T10:53:43-08:00

Scheduled at.

inprogress

The status of the scheduling to apply external collaboration security settings. Possible values include in_progress, scheduled, completed, failed, and scheduled_immediate.

enabled

The state of the external collaboration security settings. Possible values include enabled, disabled, allowlist, and denylist.

Number of failed login attempts before the primary admin is notified.

true

Indicates whether a configuration is used for a given enterprise.

1234

The value of the enterprise configuration as an integer.

Enables custom session duration for select users.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

When enabled, prevents users from changing their primary email address.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Disables users from being migrated in or out of the enterprise.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

When enabled, admin are emailed when new users are added.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Determines if users are allowed to sign up on their own.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Determines if users must sign up with your corporate email.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Determines if multi-factor authentication is required for all managed users.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Depends on is_managed_user_signup_corporate_email_enabled. A true value represents In daily summary emails. A false value represents Immediately.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

When enabled, admins are notified when users change passwords in Settings.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Enables exposed password detection.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

When enabled, admins are notified when users request a forget password email.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Requires strong passwords for External Collaborators.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

When enabled, prevents common words / email address to be used in a password.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

object

Join url for self sign up. Depends on is_managed_user_signup_enabled. Applies if join_link is not used.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

object

The basic data included in each enterprise configuration response object.

true

Indicates whether a configuration is used for a given enterprise.

Keysafe settings.

1234

The account ID.

The cloud provider.

1234

The key ID.

1234

The key ring ID.

true

Whether KeySafe addon is enabled for the enterprise.

1234

The location ID.

1234

The project ID.

The basic data included in each enterprise configuration response object.

true

Indicates whether a configuration is used for a given enterprise.

string (date-time)
2012-12-12T10:53:43-08:00

When an enterprise password reset was last applied.

Managed Users multi-factor authentication requirement method type.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

Minimum number of characters required for passwords.

true

Indicates whether a configuration is used for a given enterprise.

1234

The value of the enterprise configuration as an integer.

Minimum number of numbers required in passwords.

true

Indicates whether a configuration is used for a given enterprise.

1234

The value of the enterprise configuration as an integer.

Minimum number of symbols required in passwords.

true

Indicates whether a configuration is used for a given enterprise.

1234

The value of the enterprise configuration as an integer.

Minimum number of upper case characters required in passwords.

true

Indicates whether a configuration is used for a given enterprise.

1234

The value of the enterprise configuration as an integer.

Determines if users must reset their passwords every specified time period.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

Number of previous passwords users are prevented from using.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

Value indicating time from the last activity a user can remain logged in without activity before being logged out.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

Response Example

{
  "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": [
        "mail@example.com"
      ],
      "denylist_domains": [
        "example.com"
      ],
      "denylist_emails": [
        "spam@example.com"
      ],
      "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"
  }
}