Collaboration - Box Dev Docs

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

string

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

type

string

例 collaboration値は常にcollaborationになります。次の値に固定: collaboration

acceptance_requirements_status

object

表示子属性

strong_password_requirement

object

表示子属性

enterprise_has_strong_password_required_for_external_users

boolean

例 trueコンテンツを所有する企業が、コンテンツのコラボレーションに強力なパスワードを要求するかどうか、または外部コラボレータに対して漏えいが確認されたパスワードの検出を適用するかどうか。

user_has_strong_password

boolean

例 trueユーザーのアカウントに対して、強力なパスワードの要求と漏えいが確認されたパスワードの検出が設定されているかどうか。強力なパスワードが要求されていない場合、このフィールドはnullになります。

terms_of_service_requirement

object

表示子属性

is_accepted

boolean

例 trueサービス利用規約に同意済みかどうか。利用規約への同意が必要ない場合、このフィールドはnullです。

terms_of_service

サービス利用規約 (Base)object

コラボレーションが承認される前に同意する必要があるサービス利用規約。利用規約への同意が必要ない場合、このフィールドはnullです。

two_factor_authentication_requirement

object

表示子属性

enterprise_has_two_factor_auth_enabled

boolean

例 trueこのコンテンツを所有する会社が、このコンテンツでのコラボレーションを行うために2要素認証を有効にする必要があるかどうか。

user_has_two_factor_authentication_enabled

boolean

例 trueユーザーが2要素認証を有効にしているかどうか。2要素認証が必要ない場合、このフィールドはnullです。

accessible_by

グループ (Mini)/ユーザー (コラボレーション)object

アクセス権限が付与されるユーザーまたはグループ。

acknowledged_at

string(date-time)

例 2012-12-12T10:55:20-08:00コラボレーションオブジェクトのstatusがacceptedまたはrejectedに変更された日時。

app_item

アプリ項目object

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

created_at

string(date-time)

例 2012-12-12T10:53:43-08:00コラボレーションオブジェクトが作成された日時。

created_by

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

例 [{"id":33224412},{"type":"user"},{"login":"[email protected]"},{"name":"Dylan Smith"}]コラボレーションオブジェクトを作成したユーザー。

expires_at

string(date-time)

例 2012-12-26T10:53:43-08:00コラボレーションの有効期限。有効期限が設定されていない場合はnull。

invite_email

string

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

is_access_only

boolean

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

item

File/Folder/ウェブリンクobject

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

modified_at

string(date-time)

例 2012-12-12T10:53:43-08:00コラボレーションオブジェクトが最後に変更された日時。

role

string

例 editor付与されるアクセスレベル。次の値のいずれか1つ: editor,viewer,previewer,uploader,previewer uploader,viewer uploader,co-owner,owner

status

string

例 acceptedコラボレーション招待のステータス。ステータスがpendingの場合、loginとnameは空の文字列を返します。次の値のいずれか1つ: accepted,pending,rejected

{
  "id": "12345678",
  "type": "collaboration",
  "acceptance_requirements_status": {
    "strong_password_requirement": {
      "enterprise_has_strong_password_required_for_external_users": true,
      "user_has_strong_password": true
    },
    "terms_of_service_requirement": {
      "is_accepted": true,
      "terms_of_service": {
        "id": "11446498",
        "type": "terms_of_service"
      }
    },
    "two_factor_authentication_requirement": {
      "enterprise_has_two_factor_auth_enabled": true,
      "user_has_two_factor_authentication_enabled": true
    }
  },
  "accessible_by": {
    "id": "11446498",
    "type": "user",
    "is_active": true,
    "login": "[email protected]",
    "name": "Aaron Levie"
  },
  "acknowledged_at": "2012-12-12T10:55:20-08:00",
  "app_item": {
    "id": "12345678",
    "type": "app_item",
    "application_type": "hubs"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": [
    {
      "id": 33224412
    },
    {
      "type": "user"
    },
    {
      "login": "[email protected]"
    },
    {
      "name": "Dylan Smith"
    }
  ],
  "expires_at": "2012-12-26T10:53:43-08:00",
  "invite_email": "[email protected]",
  "is_access_only": true,
  "item": {
    "id": "12345",
    "type": "file",
    "content_created_at": "2012-12-12T10:53:43-08:00",
    "content_modified_at": "2012-12-12T10:53:43-08:00",
    "created_at": "2012-12-12T10:53:43-08:00",
    "created_by": {
      "id": "11446498",
      "type": "user",
      "login": "[email protected]",
      "name": "Aaron Levie"
    },
    "description": "Contract for Q1 renewal",
    "etag": "1",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    },
    "item_status": "active",
    "modified_at": "2012-12-12T10:53:43-08:00",
    "modified_by": {
      "id": "11446498",
      "type": "user",
      "login": "[email protected]",
      "name": "Aaron Levie"
    },
    "name": "Contract.pdf",
    "owned_by": {
      "id": "11446498",
      "type": "user",
      "login": "[email protected]",
      "name": "Aaron Levie"
    },
    "parent": {
      "id": "12345",
      "type": "folder",
      "etag": "1",
      "name": "Contracts",
      "sequence_id": "3"
    },
    "path_collection": {
      "entries": [
        {
          "etag": "1",
          "id": "12345",
          "type": "folder",
          "name": "Contracts",
          "sequence_id": "3"
        }
      ],
      "total_count": 1
    },
    "purged_at": "2012-12-12T10:53:43-08:00",
    "sequence_id": "3",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "shared_link": {
      "access": "open",
      "download_count": 3,
      "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
      "effective_access": "company",
      "effective_permission": "can_download",
      "is_password_enabled": true,
      "permissions": {
        "can_download": true,
        "can_edit": false,
        "can_preview": true
      },
      "preview_count": 3,
      "unshared_at": "2018-04-13T13:53:23-07:00",
      "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
      "vanity_name": "my_url",
      "vanity_url": "https://acme.app.box.com/v/my_url/"
    },
    "size": 629644,
    "trashed_at": "2012-12-12T10:53:43-08:00"
  },
  "modified_at": "2012-12-12T10:53:43-08:00",
  "role": "editor",
  "status": "accepted"
}