メインコンテンツへスキップ
POST
/
collaborations
cURL
curl -i -X POST "https://api.box.com/2.0/collaborations" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "item": {
         "type": "file",
         "id": "11446498"
       },
       "accessible_by": {
         "type": "user",
         "login": "user@example.com"
       },
       "role": "editor"
     }'
{
  "id": "12345678",
  "type": "collaboration",
  "item": {
    "id": "12345",
    "type": "file",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contract.pdf",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    },
    "description": "Contract for Q1 renewal",
    "size": 629644,
    "path_collection": {
      "total_count": 1,
      "entries": [
        {
          "id": "12345",
          "type": "folder",
          "etag": "1",
          "sequence_id": "3",
          "name": "Contracts"
        }
      ]
    },
    "created_at": "2012-12-12T10:53:43-08:00",
    "modified_at": "2012-12-12T10:53:43-08:00",
    "trashed_at": "2012-12-12T10:53:43-08:00",
    "purged_at": "2012-12-12T10:53:43-08:00",
    "content_created_at": "2012-12-12T10:53:43-08:00",
    "content_modified_at": "2012-12-12T10:53:43-08:00",
    "created_by": {
      "id": "11446498",
      "type": "user",
      "name": "Aaron Levie",
      "login": "ceo@example.com"
    },
    "modified_by": {
      "id": "11446498",
      "type": "user",
      "name": "Aaron Levie",
      "login": "ceo@example.com"
    },
    "owned_by": {
      "id": "11446498",
      "type": "user",
      "name": "Aaron Levie",
      "login": "ceo@example.com"
    },
    "shared_link": {
      "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
      "effective_access": "company",
      "effective_permission": "can_download",
      "is_password_enabled": true,
      "download_count": 3,
      "preview_count": 3,
      "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
      "vanity_url": "https://acme.app.box.com/v/my_url/",
      "vanity_name": "my_url",
      "access": "open",
      "unshared_at": "2018-04-13T13:53:23-07:00",
      "permissions": {
        "can_download": true,
        "can_preview": true,
        "can_edit": false
      }
    },
    "parent": {
      "id": "12345",
      "type": "folder",
      "etag": "1",
      "sequence_id": "3",
      "name": "Contracts"
    },
    "item_status": "active"
  },
  "app_item": {
    "id": "12345678",
    "type": "app_item",
    "application_type": "hubs"
  },
  "accessible_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com",
    "is_active": true
  },
  "invite_email": "john@example.com",
  "role": "editor",
  "expires_at": "2012-12-26T10:53:43-08:00",
  "is_access_only": true,
  "status": "accepted",
  "acknowledged_at": "2012-12-12T10:55:20-08:00",
  "created_by": [
    {
      "id": 33224412
    },
    {
      "type": "user"
    },
    {
      "login": "dylan@example.com"
    },
    {
      "name": "Dylan Smith"
    }
  ],
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "acceptance_requirements_status": {
    "terms_of_service_requirement": {
      "is_accepted": true,
      "terms_of_service": {
        "id": "11446498",
        "type": "terms_of_service"
      }
    },
    "strong_password_requirement": {
      "enterprise_has_strong_password_required_for_external_users": true,
      "user_has_strong_password": true
    },
    "two_factor_authentication_requirement": {
      "enterprise_has_two_factor_auth_enabled": true,
      "user_has_two_factor_authentication_enabled": true
    }
  }
}
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
fields
string[]

レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。

​
notify
boolean

実行されたアクションについてのメール通知をユーザーに送信するかどうかを決定します。

Body

application/json
​
item
object
required

コメントを追加する項目。

​
accessible_by
object
required

その項目に対するアクセス権限を付与するユーザーまたはグループ。

​
role
enum<string>
required

付与されるアクセスレベル。

利用可能なオプション:
editor,
viewer,
previewer,
uploader,
previewer uploader,
viewer uploader,
co-owner
Example:

"editor"

​
is_access_only
boolean

trueに設定した場合、コラボレータは共有項目にアクセスできますが、これらの項目は [すべてのファイル] リストに表示されません。また、コラボレータには共有項目のルートフォルダのパスも表示されません。

Example:

true

​
can_view_path
boolean

招待されたユーザーが招待に関連付けられているフォルダへの親パス全体を見ることができるかどうかを示します。招待されたユーザーには親フォルダ内の権限が付与されないため、自身が参加しているコラボレーションに関係しないコンテンツを閲覧することはできません。

これにより、招待されたユーザーの [すべてのファイル] ページの読み込みに必要な時間が有意に増加することに注意してください。can_view_pathが有効になっているコラボレーションの数を1ユーザーあたり1,000に制限することをお勧めします。

can_view_pathをtrueにしてコラボレータを招待できるのは所有者と共同所有者のみ、既存のコラボレーションでcan_view_pathを更新できるのは所有者のみです。

can_view_pathは、フォルダのコラボレーションのみに使用できます。

When you delete a folder with can_view_path=true, collaborators may still see the parent path. For instructions on how to remove this, see Even though a folder invited via can_view_path is deleted, the path remains displayed.

Example:

true

​
expires_at
string<date-time>

コラボレーションの有効期限を設定します。この日付になると、項目から自動的にコラボレーションが削除されます。

この機能が動作するのは、管理コンソールの [Enterprise設定] で [招待したコラボレータを自動的に削除する] の [フォルダの所有者に有効期限の延長を許可する] の設定が有効になっている場合のみです。この設定が有効になっていない場合、コラボレーションに有効期限を設定できず、このフィールドの値によってエラーが返されます。

Example:

"2019-08-29T23:59:00-07:00"

Response

新しいコラボレーションオブジェクトを返します。

アクセス制御リストと同様に、コラボレーションではファイルとフォルダに 対するユーザーおよびグループのアクセス権限が定義されます。コラボレーションオブジェクトは、特定のロールによって定義される権限を含んだファイルまたはフォルダへのアクセス権限をユーザーまたはグループに付与します。

​
id
string
required

このコラボレーションの一意の識別子。

Example:

"12345678"

​
type
enum<string>
required

値は常にcollaborationになります。

利用可能なオプション:
collaboration
Example:

"collaboration"

​
item
コラボレーション項目 · object

アクセスが許可されているファイルまたはフォルダ。コラボレーションのstatusがpendingの場合またはコラボレーションがアプリ項目に作成されている場合 (app_itemフィールド参照)、このフィールドはnullです。

​
app_item
アプリ項目 · object

アクセスが許可されているapp_item。コラボレーションが項目に作成されている場合 (itemフィールド参照) またはapp_itemにアクセスできない場合、このフィールドはnullです。ロールは、app_itemに関連付けられたすべての項目にカスケードされます。

​
accessible_by
コラボレーションのアクセス権限付与者 · object

アクセス権限が付与されるユーザーまたはグループ。 ユーザーのMini版の表示は、ステータスがpendingの場合にのみ返すことができます。 他のリソース内にネストされたときに使用されるユーザーのMini版の表示。

​
invite_email
string | null

登録済みユーザーでない未登録コラボレータを招待するために使用されたメールアドレス。

Example:

"john@example.com"

​
role
enum<string>

付与されるアクセスレベル。

利用可能なオプション:
editor,
viewer,
previewer,
uploader,
previewer uploader,
viewer uploader,
co-owner,
owner
Example:

"editor"

​
expires_at
string<date-time> | null

コラボレーションの有効期限。有効期限が設定されていない場合はnull。

Example:

"2012-12-26T10:53:43-08:00"

​
is_access_only
boolean

trueに設定した場合、コラボレータは共有項目にアクセスできますが、これらの項目は [すべてのファイル] リストに表示されません。また、コラボレータには共有項目のルートフォルダのパスも表示されません。

Example:

true

​
status
enum<string>

コラボレーション招待のステータス。ステータスがpendingの場合、loginとnameは空の文字列を返します。

利用可能なオプション:
accepted,
pending,
rejected
Example:

"accepted"

​
acknowledged_at
string<date-time>

コラボレーションオブジェクトのstatusがacceptedまたはrejectedに変更された日時。

Example:

"2012-12-12T10:55:20-08:00"

​
created_by
ユーザー (コラボレーション) · object

コラボレーションオブジェクトを作成したユーザー。

Example:
[
  { "id": 33224412 },
  { "type": "user" },
  { "login": "dylan@example.com" },
  { "name": "Dylan Smith" }
]
​
created_at
string<date-time>

コラボレーションオブジェクトが作成された日時。

Example:

"2012-12-12T10:53:43-08:00"

​
modified_at
string<date-time>

コラボレーションオブジェクトが最後に変更された日時。

Example:

"2012-12-12T10:53:43-08:00"

​
acceptance_requirements_status
object