Shield information barrier

A standard representation of a shield information barrier object

This resource has a few variations that can be encountered when using the API.

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

id string

example"11446498"

The unique identifier for the shield information barrier

type string

example"shield_information_barrier"

The type of the shield information barrier

Value is always shield_information_barrier

created_at string / date-time

example"2020-06-26T18:44:45.869Z"

ISO date time string when this shield information barrier object was created.

created_byUser (Base) object

The user who created this shield information barrier.

enabled_at string / date-time

example"2020-07-26T18:44:45.869Z"

ISO date time string when this shield information barrier was enabled.

enabled_byUser (Base) object

The user that enabled this shield information barrier.

enterpriseEnterprise (Base) object

The type and id of enterprise this barrier is under.

status string

example"draft"

Status of the shield information barrier

Value is one of draft,pending,disabled,enabled,invalid

updated_at string / date-time

example"2020-07-26T18:44:45.869Z"

ISO date time string when this shield information barrier was updated.

updated_byUser (Base) object

The user that updated this shield information barrier.

Response Example

{
  "id": "11446498",
  "type": "shield_information_barrier",
  "created_at": "2020-06-26T18:44:45.869Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "enabled_at": "2020-07-26T18:44:45.869Z",
  "enabled_by": {
    "id": "11446498",
    "type": "user"
  },
  "enterprise": {
    "id": "1910967",
    "type": "enterprise"
  },
  "status": "draft",
  "updated_at": "2020-07-26T18:44:45.869Z",
  "updated_by": {
    "id": "11446498",
    "type": "user"
  }
}