メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

Box Hubコラボレーションでは、Hubへのアクセス権限と役割を制御できます。ユーザーID、グループID、またはメールアドレス (ユーザーの場合) を指定してユーザーやグループを招待できます。役割はeditor、viewer、およびco-ownerとなります。Hubでのコラボレーションに招待できるのは、Boxアカウント (どのプランでも可) を持つユーザーのみです。
Box Hubs endpoints require the box-version: 2025.0 header. If you omit this header, the API returns a 400 error with the message Missing required box-version header. Supported API versions: [2025.0]. For more information, see Box API versioning strategy.

​
Hubコラボレーションを作成

ユーザーまたはグループをHubに追加するには、エンドポイントを呼び出し、以下を指定します。
  • Hubの参照 (HUB_ID)
  • コラボレータのIDおよびタイプ (accessible_byフィールド)
  • Hubに付与されるアクセスレベル (roleフィールド)

​
ユーザーIDを指定して作成

curl -i -X POST "https://api.box.com/2.0/hub_collaborations" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "box-version: 2025.0" \
     -H "Content-Type: application/json" \
     -d '{
       "hub": {
         "type": "hubs",
         "id": "HUB_ID"
       },
       "accessible_by": {
         "type": "user",
         "id": "USER_ID"
       },
       "role": "viewer"
     }'

​
ユーザーのメールアドレス (ログイン) を指定して作成

curl -i -X POST "https://api.box.com/2.0/hub_collaborations" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "box-version: 2025.0" \
     -H "Content-Type: application/json" \
     -d '{
       "hub": {
         "type": "hubs",
         "id": "HUB_ID"
       },
       "accessible_by": {
         "type": "user",
         "login": "john@example.com"
       },
       "role": "editor"
     }'
HUB_ID、USER_ID、およびメールアドレスを実際の値に置き換えます。roleの有効な値は、editor、viewer、co-ownerです。成功したレスポンスでは、新しいオブジェクトが返されます。

​
Hubコラボレーションのリストを取得

Hubのすべてのコラボレーションのリストを取得するには、Hub IDを指定してエンドポイントを呼び出します。 
curl -i -X GET "https://api.box.com/2.0/hub_collaborations?hub_id=HUB_ID" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "box-version: 2025.0"
省略可能なクエリパラメータはmarkerおよびlimitです。詳細については、マーカーベースのページネーションを参照してください。

​
IDを指定してHubコラボレーションを取得

1つのHubコラボレーションを取得するには、コラボレーションIDを指定してエンドポイントを呼び出します。 
curl -i -X GET "https://api.box.com/2.0/hub_collaborations/HUB_COLLABORATION_ID" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "box-version: 2025.0"

​
Hubコラボレーションを更新

コラボレータの役割を変更するには、HubコラボレーションIDと新しいroleを指定してエンドポイントを呼び出します。 
curl -i -X PUT "https://api.box.com/2.0/hub_collaborations/HUB_COLLABORATION_ID" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "box-version: 2025.0" \
     -H "Content-Type: application/json" \
     -d '{
       "role": "editor"
     }'

​
Hubコラボレーションを削除

Hubからコラボレータを削除するには、HubコラボレーションIDを指定してエンドポイントを呼び出します。 
curl -i -X DELETE "https://api.box.com/2.0/hub_collaborations/HUB_COLLABORATION_ID" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "box-version: 2025.0"
削除に成功した場合、返される本文はありません (HTTP 204)。

​
ユースケース

  • オンボーディングの自動化: HRISに新入社員を追加すると、「ウェルカムHub」を作成し、適切な役割を持つコラボレータとして追加します。
  • グループベースのアクセス: を使用して適切なグループを検索し、そのグループをコラボレータとして追加して、すべてのメンバーがアクセスできるようにします。