Box Developer Documentation
Log in

Enterprise configuration security

The enterprise configuration for the security category.

object

Groups for custom session duration.

boolean
true

Indicates whether a configuration is used for a given enterprise.

object array
string
1234

Group ID (numerical).

string
Group Name

Group Name.

object

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

boolean
true

Indicates whether a configuration is used for a given enterprise.

string
value of configuration

The value of the enterprise configuration as a string.

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.

boolean
true

Indicates whether a configuration is used for a given enterprise.

object
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.

object

External Collaborators multi-factor authentication settings.

boolean
true

Indicates whether a configuration is used for a given enterprise.

object

External collab security settings.

string array
["example.com"]

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

string array
["mail@example.com"]

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

string array
["example.com"]

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

string array
["spam@example.com"]

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

string
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.

string
inprogress

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

string
enabled

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

object

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

boolean
true

Indicates whether a configuration is used for a given enterprise.

integer
1234

The value of the enterprise configuration as an integer.

object

Enables custom session duration for select users.

boolean
true

Indicates whether a configuration is used for a given enterprise.

boolean
true

The value of the enterprise configuration as a boolean.

object

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

boolean
true

Indicates whether a configuration is used for a given enterprise.

boolean
true

The value of the enterprise configuration as a boolean.

object

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

boolean
true

Indicates whether a configuration is used for a given enterprise.

boolean
true

The value of the enterprise configuration as a boolean.

object

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

boolean
true

Indicates whether a configuration is used for a given enterprise.

boolean
true

The value of the enterprise configuration as a boolean.

object

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

boolean
true

Indicates whether a configuration is used for a given enterprise.

boolean
true

The value of the enterprise configuration as a boolean.

object

Determines if users must sign up with your corporate email.

boolean
true

Indicates whether a configuration is used for a given enterprise.

boolean
true

The value of the enterprise configuration as a boolean.

object

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

boolean
true

Indicates whether a configuration is used for a given enterprise.

boolean
true

The value of the enterprise configuration as a boolean.

object

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

boolean
true

Indicates whether a configuration is used for a given enterprise.

boolean
true

The value of the enterprise configuration as a boolean.

object

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

boolean
true

Indicates whether a configuration is used for a given enterprise.

boolean
true

The value of the enterprise configuration as a boolean.

object

Enables exposed password detection.

boolean
true

Indicates whether a configuration is used for a given enterprise.

boolean
true

The value of the enterprise configuration as a boolean.

object

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

boolean
true

Indicates whether a configuration is used for a given enterprise.

boolean
true

The value of the enterprise configuration as a boolean.

object

Requires strong passwords for External Collaborators.

boolean
true

Indicates whether a configuration is used for a given enterprise.

boolean
true

The value of the enterprise configuration as a boolean.

object

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

boolean
true

Indicates whether a configuration is used for a given enterprise.

boolean
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_url is not used.

boolean
true

Indicates whether a configuration is used for a given enterprise.

string
value of configuration

The value of the enterprise configuration as a string.

object

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

boolean
true

Indicates whether a configuration is used for a given enterprise.

string
value of configuration

The value of the enterprise configuration as a string.

object

The basic data included in each enterprise configuration response object.

boolean
true

Indicates whether a configuration is used for a given enterprise.

object

Keysafe settings.

string
1234

The account ID.

string

The cloud provider.

string
1234

The key ID.

string
1234

The key ring ID.

boolean
true

Whether KeySafe addon is enabled for the enterprise.

string
1234

The location ID.

string
1234

The project ID.

object

The basic data included in each enterprise configuration response object.

boolean
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.

object

Managed Users multi-factor authentication requirement method type.

boolean
true

Indicates whether a configuration is used for a given enterprise.

string
value of configuration

The value of the enterprise configuration as a string.

object

Minimum number of characters required for passwords.

boolean
true

Indicates whether a configuration is used for a given enterprise.

integer
1234

The value of the enterprise configuration as an integer.

object

Minimum number of numbers required in passwords.

boolean
true

Indicates whether a configuration is used for a given enterprise.

integer
1234

The value of the enterprise configuration as an integer.

object

Minimum number of symbols required in passwords.

boolean
true

Indicates whether a configuration is used for a given enterprise.

integer
1234

The value of the enterprise configuration as an integer.

object

Minimum number of upper case characters required in passwords.

boolean
true

Indicates whether a configuration is used for a given enterprise.

integer
1234

The value of the enterprise configuration as an integer.

object

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

boolean
true

Indicates whether a configuration is used for a given enterprise.

string
value of configuration

The value of the enterprise configuration as a string.

object

Number of previous passwords users are prevented from using.

boolean
true

Indicates whether a configuration is used for a given enterprise.

string
value of configuration

The value of the enterprise configuration as a string.

object

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

boolean
true

Indicates whether a configuration is used for a given enterprise.

string
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"
  }
}