Box · Schema

Allowed collaboration domain

An entry that describes an approved domain for which users can collaborate with files and folders in your enterprise or vice versa.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name	Type	Description
id	string	The unique identifier for this entry
type	string	`collaboration_whitelist_entry`
domain	string	The whitelisted domain
direction	string	The direction of the collaborations to allow.
enterprise	object
created_at	string	The time the entry was created at

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CollaborationAllowlistEntry",
  "title": "Allowed collaboration domain",
  "type": "object",
  "x-box-resource-id": "collaboration_allowlist_entry",
  "x-box-tag": "collaboration_allowlist_entries",
  "description": "An entry that describes an approved domain for which users can collaborate\nwith files and folders in your enterprise or vice versa.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this entry",
      "example": "11446498"
    },
    "type": {
      "type": "string",
      "description": "`collaboration_whitelist_entry`",
      "example": "collaboration_whitelist_entry",
      "enum": [
        "collaboration_whitelist_entry"
      ]
    },
    "domain": {
      "type": "string",
      "example": "example.com",
      "description": "The whitelisted domain"
    },
    "direction": {
      "type": "string",
      "example": "both",
      "description": "The direction of the collaborations to allow.",
      "enum": [
        "inbound",
        "outbound",
        "both"
      ]
    },
    "enterprise": {
      "allOf": [
        {
          "title": "Enterprise",
          "type": "object",
          "description": "A representation of a Box enterprise",
          "properties": {
            "id": {
              "type": "string",
              "description": "The unique identifier for this enterprise.",
              "example": "11446498"
            },
            "type": {
              "type": "string",
              "description": "`enterprise`",
              "example": "enterprise",
              "enum": [
                "enterprise"
              ]
            },
            "name": {
              "description": "The name of the enterprise",
              "example": "Acme Inc.",
              "type": "string"
            }
          }
        },
        {
          "description": "The enterprise this list is applied to"
        }
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The time the entry was created at",
      "example": "2012-12-12T10:53:43-08:00"
    }
  }
}