Box · Schema

Shield information barrier

A standard representation of a shield information barrier object

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
id string The unique identifier for the shield information barrier
type string The type of the shield information barrier
enterprise object The `type` and `id` of enterprise this barrier is under.
status string Status of the shield information barrier
created_at string ISO date time string when this shield information barrier object was created.
created_by object The user who created this shield information barrier.
updated_at string ISO date time string when this shield information barrier was updated.
updated_by object The user that updated this shield information barrier.
enabled_at string ISO date time string when this shield information barrier was enabled.
enabled_by object
View JSON Schema on GitHub

JSON Schema

box-shieldinformationbarrier-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ShieldInformationBarrier",
  "title": "Shield information barrier",
  "type": "object",
  "x-box-resource-id": "shield_information_barrier",
  "x-box-tag": "shield_information_barriers",
  "x-box-variants": [
    "base",
    "standard"
  ],
  "x-box-variant": "standard",
  "description": "A standard representation of a\nshield information barrier object",
  "properties": {
    "id": {
      "type": "string",
      "example": "11446498",
      "description": "The unique identifier for the shield information barrier"
    },
    "type": {
      "type": "string",
      "description": "The type of the shield information barrier",
      "example": "shield_information_barrier",
      "enum": [
        "shield_information_barrier"
      ]
    },
    "enterprise": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Enterprise--Base"
        }
      ],
      "description": "The `type` and `id` of enterprise this barrier is under."
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "pending",
        "disabled",
        "enabled",
        "invalid"
      ],
      "description": "Status of the shield information barrier",
      "example": "draft"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2020-06-26T18:44:45.869Z",
      "description": "ISO date time string when this\nshield information barrier object was created."
    },
    "created_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Base"
        }
      ],
      "description": "The user who created this shield information barrier."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2020-07-26T18:44:45.869Z",
      "description": "ISO date time string when this shield information barrier was updated."
    },
    "updated_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Base"
        }
      ],
      "description": "The user that updated this shield information barrier."
    },
    "enabled_at": {
      "type": "string",
      "format": "date-time",
      "example": "2020-07-26T18:44:45.869Z",
      "description": "ISO date time string when this shield information barrier was enabled."
    },
    "enabled_by": {
      "allOf": [
        {
          "$ref": "#/components/schemas/User--Base"
        },
        {
          "description": "The user that enabled this shield information barrier."
        }
      ]
    }
  }
}