• Sign up
  • Docs
  • Guides
  • API Reference
  • Sample Code
  • SDKs & Tools
  • Support
  • Developer Changelog
  • Elsewhere
  • Blog
  • Forum
  • Feedback
  • International sites
  • United States (English)
  • 日本 (日本語)
Box Developer Documentation
  • United States (English)
  • 日本 (日本語)
  • Quick Starts
  • Guides
  • API Reference
  • Sample Code
  • SDKs & Tools
  • Support
    • Developer Changelog
    • UnreadMar 14th, 2023

      Box Windows SDK v5.2.0 released

      Featuresdkswindows
    • UnreadMar 8th, 2023

      Box Python SDK v3.7.0 released

      Featuresdkspython
    • UnreadMar 8th, 2023

      Downloading ZIP Archives with Box API

      Featureapi
Log in

API Reference

    • Authorization

    • Resources

    • OAuth 2.0 error

    • Access token

    • Endpoints

    • GET

      Authorize user

    • POST

      Request access token

    • POST

      Refresh access token

    • POST

      Revoke access token

    • Box Sign

    • Resources

    • Sign Request

    • Sign Requests

    • Create a sign request

    • Endpoints

    • GET

      Get sign request by ID

    • GET

      List sign requests

    • POST

      Cancel sign request

    • POST

      Resend sign request

    • POST

      Create sign request

    • Classifications

    • Resources

    • Classification

    • Classification Template

    • Endpoints

    • GET

      List all classifications

    • POST

      Add initial classifications

    • PUT

      Add classification

    • PUT

      Update classification

    • PUT

      Delete classification

    • DEL

      Delete all classifications

    • Classifications on files

    • Endpoints

    • GET

      Get classification on file

    • POST

      Add classification to file

    • PUT

      Update classification on file

    • DEL

      Remove classification from file

    • Classifications on folders

    • Endpoints

    • GET

      Get classification on folder

    • POST

      Add classification to folder

    • PUT

      Update classification on folder

    • DEL

      Remove classification from folder

    • Collaborations

    • Resources

    • Collaboration

    • Collaborations

    • Endpoints

    • GET

      Get collaboration

    • POST

      Create collaboration

    • PUT

      Update collaboration

    • DEL

      Remove collaboration

    • Collaborations (List)

    • Endpoints

    • GET

      List file collaborations

    • GET

      List folder collaborations

    • GET

      List pending collaborations

    • GET

      List group collaborations

    • Collections

    • Resources

    • Collection

    • Collections

    • Endpoints

    • GET

      List all collections

    • GET

      List collection items

    • Comments

    • Resources

    • Comment

    • Comments

    • Comment (Base)

    • Comment (Full)

    • Endpoints

    • GET

      List file comments

    • GET

      Get comment

    • POST

      Create comment

    • PUT

      Update comment

    • DEL

      Remove comment

    • Device pinners

    • Resources

    • Device pinner

    • Device pinners

    • Endpoints

    • GET

      Get device pin

    • GET

      List enterprise device pins

    • DEL

      Remove device pin

    • Domain restrictions (User exemptions)

    • Resources

    • Allowed collaboration domains user exemption

    • Allowed collaboration domains user exemptions

    • Endpoints

    • GET

      List users exempt from collaboration domain restrictions

    • GET

      Get user exempt from collaboration domain restrictions

    • POST

      Create user exemption from collaboration domain restrictions

    • DEL

      Remove user from list of users exempt from domain restrictions

    • Domain restrictions for collaborations

    • Resources

    • Allowed collaboration domain

    • Allowed collaboration domains

    • Endpoints

    • GET

      List allowed collaboration domains

    • GET

      Get allowed collaboration domain

    • POST

      Add domain to list of allowed collaboration domains

    • DEL

      Remove domain from list of allowed collaboration domains

    • Downloads

    • Endpoints

    • GET

      Download file

    • Email aliases

    • Resources

    • Email alias

    • Email aliases

    • Endpoints

    • GET

      List user's email aliases

    • POST

      Create email alias

    • DEL

      Remove email alias

    • Events

    • Resources

    • Event

    • Events

    • Real-time servers

    • Endpoints

    • GET

      List user and enterprise events

    • OPTS

      Get events long poll endpoint

    • File requests

    • Resources

    • File Request

    • Endpoints

    • GET

      Get file request

    • POST

      Copy file request

    • PUT

      Update file request

    • DEL

      Delete file request

    • File version legal holds

    • Resources

    • File version legal hold

    • File version legal holds

    • Endpoints

    • GET

      Get file version legal hold

    • GET

      List file version legal holds

    • File version retentions

    • Resources

    • File version retention

    • File version retentions

    • Endpoints

    • GET

      List file version retentions

    • GET

      Get retention on file

    • File versions

    • Resources

    • File versions

    • Endpoints

    • GET

      List all file versions

    • GET

      Get file version

    • POST

      Promote file version

    • PUT

      Restore file version

    • DEL

      Remove file version

    • Files

    • Resources

    • File

    • Files

    • File (Full)

    • File (Mini)

    • File (Base)

    • Endpoints

    • GET

      Get file information

    • GET

      Get file thumbnail

    • POST

      Copy file

    • PUT

      Update file

    • DEL

      Delete file

    • Folder Locks

    • Resources

    • Folder Lock

    • Folder Locks

    • Endpoints

    • GET

      List folder locks

    • POST

      Create folder lock

    • DEL

      Delete folder lock

    • Folders

    • Resources

    • Folder

    • Folder (Full)

    • Folder (Mini)

    • Folder (Base)

    • Items

    • Endpoints

    • GET

      Get folder information

    • GET

      List items in folder

    • POST

      Create folder

    • POST

      Copy folder

    • PUT

      Update folder

    • DEL

      Delete folder

    • Group memberships

    • Resources

    • Group membership

    • Group memberships

    • Endpoints

    • GET

      List user's groups

    • GET

      List members of group

    • GET

      Get group membership

    • POST

      Add user to group

    • PUT

      Update group membership

    • DEL

      Remove user from group

    • Groups

    • Resources

    • Group

    • Groups

    • Group (Base)

    • Group (Full)

    • Group (Mini)

    • Endpoints

    • GET

      List groups for enterprise

    • GET

      Get group

    • POST

      Create group

    • PUT

      Update group

    • DEL

      Remove group

    • Invites

    • Resources

    • Invite

    • Endpoints

    • GET

      Get user invite status

    • POST

      Create user invite

    • Legal hold policies

    • Resources

    • Legal hold policy

    • Legal hold policies

    • Legal hold policy (Mini)

    • Endpoints

    • GET

      List all legal hold policies

    • GET

      Get legal hold policy

    • POST

      Create legal hold policy

    • PUT

      Update legal hold policy

    • DEL

      Remove legal hold policy

    • Legal hold policy assignments

    • Resources

    • Legal hold policy assignment

    • Legal hold policy assignment (Base)

    • Legal hold policy assignments

    • Endpoints

    • GET

      List legal hold policy assignments

    • GET

      Get legal hold policy assignment

    • GET

      List current file versions for legal hold policy assignment

    • GET

      List previous file versions for legal hold policy assignment

    • POST

      Assign legal hold policy

    • DEL

      Unassign legal hold policy

    • Metadata cascade policies

    • Resources

    • Metadata cascade policy

    • Metadata cascade policies

    • Endpoints

    • GET

      List metadata cascade policies

    • GET

      Get metadata cascade policy

    • POST

      Create metadata cascade policy

    • POST

      Force-apply metadata cascade policy to folder

    • DEL

      Remove metadata cascade policy

    • Metadata instances (Files)

    • Resources

    • Metadata instance

    • Metadata instance (Full)

    • Metadata instance (Base)

    • Metadata instances

    • Endpoints

    • GET

      List metadata instances on file

    • GET

      Get metadata instance on file

    • POST

      Create metadata instance on file

    • PUT

      Update metadata instance on file

    • DEL

      Remove metadata instance from file

    • Metadata instances (Folders)

    • Endpoints

    • GET

      List metadata instances on folder

    • GET

      Get metadata instance on folder

    • POST

      Create metadata instance on folder

    • PUT

      Update metadata instance on folder

    • DEL

      Remove metadata instance from folder

    • Metadata templates

    • Resources

    • Metadata template

    • Metadata templates

    • Endpoints

    • GET

      Find metadata template by instance ID

    • GET

      Get metadata template by name

    • GET

      Get metadata template by ID

    • GET

      List all global metadata templates

    • GET

      List all metadata templates for enterprise

    • POST

      Create metadata template

    • PUT

      Update metadata template

    • DEL

      Remove metadata template

    • Recent items

    • Resources

    • Recent item

    • Endpoints

    • GET

      List recently accessed items

    • Retention policies

    • Resources

    • Retention policies

    • Retention policy

    • Retention policy (Mini)

    • Retention policy (Base)

    • Endpoints

    • GET

      List retention policies

    • GET

      Get retention policy

    • POST

      Create retention policy

    • PUT

      Update retention policy

    • DEL

      Delete retention policy

    • Retention policy assignments

    • Resources

    • Files under retention

    • Retention policy assignment (Base)

    • Retention policy assignment

    • Retention policy assignments

    • Endpoints

    • GET

      List retention policy assignments

    • GET

      Get retention policy assignment

    • GET

      Get files under retention

    • GET

      Get file versions under retention

    • POST

      Assign retention policy

    • DEL

      Remove retention policy assignment

    • Search

    • Resources

    • Metadata query index

    • Metadata query indices

    • Metadata query search results

    • Search Results

    • Search Results (including Shared Links)

    • Search Result (including Shared Link)

    • Metadata filter

    • Endpoints

    • GET

      List metadata query indices

    • GET

      Search for content

    • POST

      Query files/folders by metadata

    • Session termination

    • Resources

    • Session termination message

    • Endpoints

    • POST

      Create jobs to terminate users session

    • POST

      Create jobs to terminate user group session

    • Shared links (Files)

    • Endpoints

    • GET

      Find file for shared link

    • GET

      Get shared link for file

    • PUT

      Add shared link to file

    • PUT

      Update shared link on file

    • PUT

      Remove shared link from file

    • Shared links (Folders)

    • Endpoints

    • GET

      Find folder for shared link

    • GET

      Get shared link for folder

    • PUT

      Add shared link to folder

    • PUT

      Update shared link on folder

    • PUT

      Remove shared link from folder

    • Shared links (Web Links)

    • Endpoints

    • GET

      Find web link for shared link

    • GET

      Get shared link for web link

    • PUT

      Add shared link to web link

    • PUT

      Update shared link on web link

    • PUT

      Remove shared link from web link

    • Shield information barrier reports

    • Resources

    • Shield information barrier report

    • Shield information barrier report (Base)

    • Shield information barrier reference

    • Shield information barrier report details

    • Endpoints

    • GET

      List shield information barrier reports

    • GET

      Get shield information barrier report by ID

    • POST

      Create shield information barrier report

    • Shield information barrier segment members

    • Resources

    • Shield information barrier segment member

    • Shield information barrier segment member (Base)

    • Shield information barrier segment member (Mini)

    • Endpoints

    • GET

      Get shield information barrier segment member by ID

    • GET

      List shield information barrier segment members

    • POST

      Create shield information barrier segment member

    • DEL

      Delete shield information barrier segment member by ID

    • Shield information barrier segment restrictions

    • Resources

    • Shield information barrier segment restriction

    • Shield information barrier segment restriction (Base)

    • Shield information barrier segment restriction (Mini)

    • Endpoints

    • GET

      Get shield information barrier segment restriction by ID

    • GET

      List shield information barrier segment restrictions

    • POST

      Create shield information barrier segment restriction

    • DEL

      Delete shield information barrier segment restriction by ID

    • Shield information barrier segments

    • Resources

    • Shield information barrier segment

    • Endpoints

    • GET

      Get shield information barrier segment with specified ID

    • GET

      List shield information barrier segments

    • POST

      Create shield information barrier segment

    • PUT

      Update shield information barrier segment with specified ID

    • DEL

      Delete shield information barrier segment

    • Shield information barriers

    • Resources

    • Shield information barrier

    • Shield information barrier (Base)

    • Endpoints

    • GET

      Get shield information barrier with specified ID

    • GET

      List shield information barriers

    • POST

      Add changed status of shield information barrier with specified ID

    • POST

      Create shield information barrier

    • Skills

    • Resources

    • Skill webhook payload

    • Skills metadata instance

    • Skill Card

    • Keyword Skill Card

    • Timeline Skill Card

    • Transcript Skill Card

    • Status Skill Card

    • Endpoints

    • GET

      List Box Skill cards on file

    • POST

      Create Box Skill cards on file

    • PUT

      Update Box Skill cards on file

    • PUT

      Update all Box Skill cards on file

    • DEL

      Remove Box Skill cards from file

    • Standard and Zones Storage Policies

    • Resources

    • Storage policy

    • Storage policies

    • Storage policy (Mini)

    • Endpoints

    • GET

      List storage policies

    • GET

      Get storage policy

    • Standard and Zones Storage Policy Assignments

    • Resources

    • Storage policy assignment

    • Storage policy assignments

    • Endpoints

    • GET

      List storage policy assignments

    • GET

      Get storage policy assignment

    • POST

      Assign storage policy

    • PUT

      Update storage policy assignment

    • DEL

      Unassign storage policy

    • Task assignments

    • Resources

    • Task assignment

    • Task assignments

    • Endpoints

    • GET

      List task assignments

    • GET

      Get task assignment

    • POST

      Assign task

    • PUT

      Update task assignment

    • DEL

      Unassign task

    • Tasks

    • Resources

    • Task

    • Tasks

    • Endpoints

    • GET

      List tasks on file

    • GET

      Get task

    • POST

      Create task

    • PUT

      Update task

    • DEL

      Remove task

    • Terms of service

    • Resources

    • Terms of service

    • Terms of services

    • Terms of service (Base)

    • Endpoints

    • GET

      List terms of services

    • GET

      Get terms of service

    • POST

      Create terms of service

    • PUT

      Update terms of service

    • Terms of service user statuses

    • Resources

    • Terms of service user status

    • Terms of service user statuses

    • Endpoints

    • GET

      List terms of service user statuses

    • POST

      Create terms of service status for new user

    • PUT

      Update terms of service status for existing user

    • Transfer folders

    • Endpoints

    • PUT

      Transfer owned folders

    • Trashed files

    • Resources

    • Trashed File

    • Trashed File (Restored)

    • Endpoints

    • GET

      Get trashed file

    • POST

      Restore file

    • DEL

      Permanently remove file

    • Trashed folders

    • Resources

    • Trashed Folder

    • Trashed Folder (Restored)

    • Endpoints

    • GET

      Get trashed folder

    • POST

      Restore folder

    • DEL

      Permanently remove folder

    • Trashed items

    • Endpoints

    • GET

      List trashed items

    • Trashed web links

    • Resources

    • Trashed Web Link

    • Trashed Web Link (Restored)

    • Endpoints

    • GET

      Get trashed web link

    • POST

      Restore web link

    • DEL

      Permanently remove web link

    • Uploads

    • Resources

    • Conflict error

    • Upload URL

    • Endpoints

    • OPTS

      Preflight check before upload

    • POST

      Upload file version

    • POST

      Upload file

    • Uploads (Chunked)

    • Resources

    • Upload part

    • Upload part (Mini)

    • Uploaded part

    • Upload parts

    • Upload session

    • Endpoints

    • GET

      Get upload session

    • GET

      List parts

    • POST

      Create upload session

    • POST

      Create upload session for existing file

    • POST

      Commit upload session

    • PUT

      Upload part of file

    • DEL

      Remove upload session

    • User avatars

    • Resources

    • User avatar

    • Endpoints

    • GET

      Get user avatar

    • POST

      Add or update user avatar

    • DEL

      Delete user avatar

    • Users

    • Resources

    • User

    • Users

    • User (Full)

    • User (Mini)

    • User (Base)

    • Endpoints

    • GET

      List enterprise users

    • GET

      Get current user

    • GET

      Get user

    • POST

      Create user

    • PUT

      Update user

    • DEL

      Delete user

    • Watermarks (Files)

    • Resources

    • Watermark

    • Endpoints

    • GET

      Get watermark on file

    • PUT

      Apply watermark to file

    • DEL

      Remove watermark from file

    • Watermarks (Folders)

    • Endpoints

    • GET

      Get watermark for folder

    • PUT

      Apply watermark to folder

    • DEL

      Remove watermark from folder

    • Web links

    • Resources

    • Web link

    • Web link (Base)

    • Web link (Mini)

    • Endpoints

    • GET

      Get web link

    • POST

      Create web link

    • PUT

      Update web link

    • DEL

      Remove web link

    • Webhooks

    • Resources

    • Webhook (V2) payload

    • Webhook

    • Webhook (Mini)

    • Webhooks

    • Endpoints

    • GET

      List all webhooks

    • GET

      Get webhook

    • POST

      Create webhook

    • PUT

      Update webhook

    • DEL

      Remove webhook

    • Workflows

    • Resources

    • Workflow

    • Workflow (Full)

    • Workflow (Mini)

    • Workflows

    • Endpoints

    • GET

      List workflows

    • POST

      Starts workflow based on request body

    • Zip Downloads

    • Resources

    • Zip download

    • Zip download status

    • Endpoints

    • GET

      Download zip archive

    • GET

      Get zip download status

    • POST

      Create zip download

    • Resources

    • Access token

    • Classification

    • Classification Template

    • Client error

    • Collaboration

    • Allowed collaboration domains

    • Allowed collaboration domain

    • Allowed collaboration domains user exemption

    • Allowed collaboration domains user exemptions

    • Collaborations

    • Collection

    • Collections

    • Comment

    • Comment (Base)

    • Comment (Full)

    • Comments

    • Conflict error

    • Device pinner

    • Device pinners

    • Email alias

    • Email aliases

    • Enterprise (Base)

    • Event

    • Event source

    • Events

    • File

    • File (Base)

    • File (Full)

    • File (Mini)

    • File (Conflict)

    • File Request

    • File version

    • File version (Base)

    • File version (Full)

    • File version (Mini)

    • File version legal hold

    • File version legal holds

    • File version retention

    • File version retentions

    • File versions

    • Files

    • Files under retention

    • Folder

    • Folder (Base)

    • Folder (Full)

    • Folder (Mini)

    • Folder Lock

    • Folder Locks

    • Group

    • Group (Base)

    • Group (Full)

    • Group (Mini)

    • Group membership

    • Group memberships

    • Groups

    • Invite

    • Items

    • Keyword Skill Card

    • Legal hold policies

    • Legal hold policy

    • Legal hold policy (Mini)

    • Legal hold policy assignment

    • Legal hold policy assignment (Base)

    • Legal hold policy assignments

    • Metadata instance

    • Metadata instance (Base)

    • Metadata instance (Full)

    • Metadata cascade policies

    • Metadata cascade policy

    • Metadata field filter (date range)

    • Metadata field filter (float)

    • Metadata field filter (float range)

    • Metadata field filter (multi-select)

    • Metadata field filter (string)

    • Metadata filter

    • Metadata query index

    • Metadata query indices

    • Metadata query search results

    • Metadata template

    • Metadata templates

    • Metadata instances

    • OAuth 2.0 error

    • Real-time server

    • Real-time servers

    • Recent item

    • Recent items

    • Retention policies

    • Retention policy

    • Retention policy (Base)

    • Retention policy (Mini)

    • Retention policy assignment

    • Retention policy assignment (Base)

    • Retention policy assignments

    • Search Result (including Shared Link)

    • Search Results

    • Search Results (including Shared Links)

    • Session termination message

    • Shield information barrier

    • Shield information barrier (Base)

    • Shield information barrier reference

    • Shield information barrier report

    • Shield information barrier report (Base)

    • Shield information barrier report details

    • Shield information barrier segment

    • Shield information barrier segment member

    • Shield information barrier segment member (Base)

    • Shield information barrier segment member (Mini)

    • Shield information barrier segment restriction

    • Shield information barrier segment restriction (Base)

    • Shield information barrier segment restriction (Mini)

    • Sign Request

    • Create a sign request

    • Sign Requests

    • Skill Card

    • Skills metadata instance

    • Skill webhook payload

    • Status Skill Card

    • Storage policies

    • Storage policy

    • Storage policy (Mini)

    • Storage policy assignment

    • Storage policy assignments

    • Task

    • Task assignment

    • Task assignments

    • Tasks

    • Terms of service

    • Terms of service (Base)

    • Terms of service user status

    • Terms of services

    • Terms of service user statuses

    • Timeline Skill Card

    • Transcript Skill Card

    • Trashed File

    • Trashed File (Restored)

    • Trashed Folder

    • Trashed Folder (Restored)

    • Trashed Web Link

    • Trashed Web Link (Restored)

    • Upload part

    • Upload part (Mini)

    • Upload parts

    • Upload session

    • Upload URL

    • Uploaded part

    • User

    • User (Base)

    • User (Full)

    • User (Mini)

    • User avatar

    • Users

    • Watermark

    • Web link

    • Web link (Base)

    • Web link (Mini)

    • Webhook

    • Webhook (Mini)

    • Webhook (V2) payload

    • Webhooks

    • Workflow

    • Workflow (Full)

    • Workflow (Mini)

    • Workflows

    • Zip download

    • Zip download status

Shield information barrier reference

Edit this page

A shield information barrier reference for requests and responses

Shield information barrier (Base) object

A base representation of a shield information barrier object

Response Example

{
  "shield_information_barrier": {
    "id": 11446498,
    "type": "shield_information_barrier"
  }
}
  • Box & Community
  • About Us
  • Platform Twitter
  • Developer Blog
  • Developer Newsletter
  • Changelog
  • GitHub
  • Community GitHub
  • Tooling
  • Node SDK
  • Java SDK
  • Python SDK
  • .NET SDK
  • iOS Content SDK
  • Android Content SDK
  • Box CLI
  • Box Skills Kit
  • Samples
  • Platform Samples
  • Skills Samples
  • Support
  • Support & Community
  • Create a ticket
  • Platform Forum
  • Product Feedback
  • API Status
  • International sites
  • United States (English)
  • 日本 (日本語)
  • ©2023 Box
  • Sitemap
  • Newsletter Unsubscribe
  • Terms of Use
  • Privacy Policy
  • Cookie Notification
  • Code samples provided under Unilicense