Box Developer Documentation

Enterprise configuration user settings

The enterprise configuration for the user settings category.

true

Indicates whether a configuration is used for a given enterprise.

An enterprise feature setting.

string
eyJlbnRlcnByaXNlSWQiOiIxMTExNDQyNzY3IiwiZmVhdHVyZUlkIjoiY2FudmFzIn0=

The identifier of the enterprise feature setting.

object array

Enterprise feature setting is enabled for only this set of users and groups.

12345

The identifier of the user or group.

user

The type user or group.

Value is one of user,group

true

Whether the feature can be configured.

object array

Enterprise feature setting is enabled for everyone except this set of users and groups.

12345

The identifier of the user or group.

user

The type user or group.

Value is one of user,group

The feature.

string
canvas

The identifier of the feature.

true

Whether the feature is configured.

enabled

The state of the feature.

Determines if Box Sync is restricted for new users.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Determines if new users are exempt from the maximum number of devices specified in the Device Protection settings.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Value indicating if SSO is in testing mode for all users.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Value indicating if SSO is required for all users.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Determines if new users will not be allowed to create folders that can have external collaborators.

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 restricted from granting (limited) access for Box Support for troubleshooting.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Determines if any new groups received for a user upon login through SSO but not present in the enterprise will be auto added to the enterprise.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Determines if a user will be added to enterprise groups received upon user login through SSO.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Determines if a user will be removed from enterprise groups upon user login through SSO.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Determines if new users are given unlimited storage.

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 restricted from changing their username in Account Settings.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

Determines if new users can see all managed users in their contacts when inviting collaborators.

true

Indicates whether a configuration is used for a given enterprise.

true

The value of the enterprise configuration as a boolean.

{"is_used":true,"value":"English (US)"}

Determines the default language for new users.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

Determines the default storage limit for new users. Does not apply if is_unlimited_storage_enabled_for_new_users is true.

true

Indicates whether a configuration is used for a given enterprise.

1234

The value of the enterprise configuration as an integer.

{"is_used":true,"value":"GMT-05:00 America\\/Chicago CDT"}

Determines the default timezone for new users.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

The remaining number of user_tracking_codes that can be created.

true

Indicates whether a configuration is used for a given enterprise.

1234

The value of the enterprise configuration as an integer.

{"is_used":true,"value":"7 days"}

Determines the time frame for any unaccepted invitation to your Box enterprise account to expire.

true

Indicates whether a configuration is used for a given enterprise.

value of configuration

The value of the enterprise configuration as a string.

Properties that are assigned as additional values to users, like employee ID or region.

true

Indicates whether a configuration is used for a given enterprise.

integer (int64)
1234

The ID of the user tracking code.

Employee ID

The name of the user tracking code.

Response Example

{
  "enterprise_feature_settings": [
    {
      "is_used": true,
      "value": {
        "allowlist": [
          {
            "id": "12345",
            "type": "user"
          }
        ],
        "can_configure": true,
        "denylist": [
          {
            "id": "12345",
            "type": "user"
          }
        ],
        "feature": {
          "id": "canvas"
        },
        "id": "eyJlbnRlcnByaXNlSWQiOiIxMTExNDQyNzY3IiwiZmVhdHVyZUlkIjoiY2FudmFzIn0=",
        "is_configured": true,
        "state": "enabled"
      }
    }
  ],
  "is_box_sync_restricted_for_new_users": {
    "is_used": true,
    "value": true
  },
  "is_device_limit_exemption_enabled_for_new_users": {
    "is_used": true,
    "value": true
  },
  "is_enterprise_sso_in_testing": {
    "is_used": true,
    "value": true
  },
  "is_enterprise_sso_required": {
    "is_used": true,
    "value": true
  },
  "is_external_collaboration_restricted_for_new_users": {
    "is_used": true,
    "value": true
  },
  "is_instant_login_restricted": {
    "is_used": true,
    "value": true
  },
  "is_sso_auto_add_groups_enabled": {
    "is_used": true,
    "value": true
  },
  "is_sso_auto_add_user_to_groups_enabled": {
    "is_used": true,
    "value": true
  },
  "is_sso_auto_remove_user_from_groups_enabled": {
    "is_used": true,
    "value": true
  },
  "is_unlimited_storage_enabled_for_new_users": {
    "is_used": true,
    "value": true
  },
  "is_username_change_restricted": {
    "is_used": true,
    "value": true
  },
  "is_view_all_users_enabled_for_new_users": {
    "is_used": true,
    "value": true
  },
  "new_user_default_language": {
    "is_used": true,
    "value": "English (US)"
  },
  "new_user_default_storage_limit": {
    "is_used": true,
    "value": 1234
  },
  "new_user_default_timezone": {
    "is_used": true,
    "value": "GMT-05:00 America\\/Chicago CDT"
  },
  "number_of_user_tracking_codes_remaining": {
    "is_used": true,
    "value": 1234
  },
  "user_invites_expiration_time_frame": {
    "is_used": true,
    "value": "7 days"
  },
  "user_tracking_codes": {
    "is_used": true,
    "value": [
      {
        "id": 1234,
        "name": "Employee ID"
      }
    ]
  }
}