Hubコラボレーションの管理

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を指定して作成

box hubs:collaborations:create HUB_ID --role viewer --user-id USER_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"
     }'

await client.hubCollaborations.createHubCollaborationV2025R0({
  hub: new HubCollaborationCreateRequestV2025R0HubField({ id: hub.id }),
  accessibleBy: {
    type: 'user',
    id: user.id,
  } satisfies HubCollaborationCreateRequestV2025R0AccessibleByField,
  role: 'viewer',
} satisfies HubCollaborationCreateRequestV2025R0);

client.hub_collaborations.create_hub_collaboration_v2025_r0(
    CreateHubCollaborationV2025R0Hub(id=hub.id),
    CreateHubCollaborationV2025R0AccessibleBy(type="user", id=user.id),
    "viewer",
)

await client.HubCollaborations.CreateHubCollaborationV2025R0Async(requestBody: new HubCollaborationCreateRequestV2025R0(hub: new HubCollaborationCreateRequestV2025R0HubField(id: hub.Id), accessibleBy: new HubCollaborationCreateRequestV2025R0AccessibleByField(type: "user") { Id = user.Id }, role: "viewer"));

try await client.hubCollaborations.createHubCollaborationV2025R0(requestBody: HubCollaborationCreateRequestV2025R0(hub: HubCollaborationCreateRequestV2025R0HubField(id: hub.id), accessibleBy: HubCollaborationCreateRequestV2025R0AccessibleByField(type: "user", id: user.id), role: "viewer"))

client.getHubCollaborations().createHubCollaborationV2025R0(new HubCollaborationCreateRequestV2025R0(new HubCollaborationCreateRequestV2025R0HubField(hub.getId()), new HubCollaborationCreateRequestV2025R0AccessibleByField.Builder("user").id(user.getId()).build(), "viewer"));

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

box hubs:collaborations:create HUB_ID --role editor --login john@example.com

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"
     }'

client.hub_collaborations.create_hub_collaboration_v2025_r0(
    CreateHubCollaborationV2025R0Hub(id=hub.id),
    CreateHubCollaborationV2025R0AccessibleBy(type="user", login="john@example.com"),
    "editor",
)

HUB_ID、USER_ID、およびメールアドレスを実際の値に置き換えます。roleの有効な値は、editor、viewer、co-ownerです。成功したレスポンスでは、新しいオブジェクトが返されます。

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

Hubのすべてのコラボレーションのリストを取得するには、Hub IDを指定してエンドポイントを呼び出します。

box hubs:collaborations 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"

await client.hubCollaborations.getHubCollaborationsV2025R0({
  hubId: hub.id,
} satisfies GetHubCollaborationsV2025R0QueryParams);

client.hub_collaborations.get_hub_collaborations_v2025_r0(hub.id)

await client.HubCollaborations.GetHubCollaborationsV2025R0Async(queryParams: new GetHubCollaborationsV2025R0QueryParams(hubId: hub.Id));

try await client.hubCollaborations.getHubCollaborationsV2025R0(queryParams: GetHubCollaborationsV2025R0QueryParams(hubId: hub.id))

client.getHubCollaborations().getHubCollaborationsV2025R0(new GetHubCollaborationsV2025R0QueryParams(hub.getId()));

省略可能なクエリパラメータはmarkerおよびlimitです。詳細については、マーカーベースのページネーションを参照してください。

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

1つのHubコラボレーションを取得するには、コラボレーションIDを指定してエンドポイントを呼び出します。

box hubs:collaborations:get HUB_COLLABORATION_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"

await client.hubCollaborations.getHubCollaborationByIdV2025R0(hubCollaborationId);

client.hub_collaborations.get_hub_collaboration_by_id_v2025_r0(hub_collaboration_id)

await client.HubCollaborations.GetHubCollaborationByIdV2025R0Async(hubCollaborationId: hubCollaborationId);

client.getHubCollaborations().getHubCollaborationByIdV2025R0(hubCollaborationId);

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

コラボレータの役割を変更するには、HubコラボレーションIDと新しいroleを指定してエンドポイントを呼び出します。

box hubs:collaborations:update HUB_COLLABORATION_ID --role editor

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"
     }'

await client.hubCollaborations.updateHubCollaborationByIdV2025R0(hubCollaborationId, {
  role: 'editor',
} satisfies HubCollaborationUpdateRequestV2025R0);

client.hub_collaborations.update_hub_collaboration_by_id_v2025_r0(hub_collaboration_id, role="editor")

await client.HubCollaborations.UpdateHubCollaborationByIdV2025R0Async(hubCollaborationId: hubCollaborationId, requestBody: new HubCollaborationUpdateRequestV2025R0() { Role = "editor" });

client.getHubCollaborations().updateHubCollaborationByIdV2025R0(hubCollaborationId, new HubCollaborationUpdateRequestV2025R0.Builder().role("editor").build());

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

Hubからコラボレータを削除するには、HubコラボレーションIDを指定してエンドポイントを呼び出します。

box hubs:collaborations:delete HUB_COLLABORATION_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"

await client.hubCollaborations.deleteHubCollaborationByIdV2025R0(hubCollaborationId);

client.hub_collaborations.delete_hub_collaboration_by_id_v2025_r0(hub_collaboration_id)

await client.HubCollaborations.DeleteHubCollaborationByIdV2025R0Async(hubCollaborationId: hubCollaborationId);

client.getHubCollaborations().deleteHubCollaborationByIdV2025R0(hubCollaborationId);

削除に成功した場合、返される本文はありません (HTTP 204)。

ユースケース

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

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

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

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

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

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

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

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

​ユースケース

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

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

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

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

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

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

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

ユースケース