Box Developerドキュメント
ログイン
最新バージョン

Slack統合マッピングを更新

put
https://api.box.com/2.0
/integration_mappings/slack/:integration_mapping_id

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

Slack統合マッピングを更新します。BoxフォルダIDおよびオプションの更新をサポートします。

このエンドポイントを使用するには、管理者または共同管理者の役割が必要です。

関連するガイド

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
11235432

統合マッピングのID。

リクエスト本文

object本文内

Slackタイプの統合マッピングのBox項目オブジェクトのスキーマ。

string本文内省略可能
"1234567891"

(typeで参照されるタイプの) マッピングされた項目のID。

string本文内省略可能
"folder"

idで参照されるマッピングされた項目のタイプ。

次の値に固定: folder

object本文内

Slackタイプの統合マッピングオプションオブジェクトのスキーマ。

boolean本文内省略可能
true

基になるBox項目に対するチャンネルメンバーのアクセスを自動で管理する必要があるかどうかを示します。チャンネルのタイプによっては、アクセスがコラボレーションまたは共有リンクの作成により管理されます。

レスポンス

application/jsonSlack統合マッピング

更新された統合マッピングオブジェクトを返します。

application/jsonクライアントエラー

誤ったoptionsが指定された場合またはBoxフォルダをこのpartner_itemにマッピングできない場合にbad_requestを返します。エラーコードは以下のとおりです。

  • SERVICE_ACCOUNT_IS_NOT_A_COOWNER_OR_OWNER - サービスアカウントに共同所有者のコラボレーションがないか、サービスアカウントがbox_item_idの所有者ではありません。
  • BOX_FOLDER_EXTERNALLY_OWNED - Boxフォルダは、管理者の企業内で所有されている必要があります。
  • JWT_APP_NOT_AUTHORIZED - JWT承認エラー。
application/jsonクライアントエラー

統合マッピングオブジェクトが見つからなかった場合はnot_foundを返します。

application/jsonクライアントエラー

予期しないクライアントエラー。

put
Slack統合マッピングを更新
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -X -L PUT "https://api.box.com/2.0/integration_mappings/slack/512521" \
     -H "authorization: Bearer <ACCESS_TOKEN>"  \
     -H 'content-type: application/json'  \
     -d'{
         "options": {
            "is_access_management_disabled": true
        }
    }'
TypeScript Gen
await userClient.integrationMappings.updateSlackIntegrationMappingById(
  slackIntegrationMapping.id,
  {
    requestBody: {
      boxItem: new IntegrationMappingBoxItemSlack({ id: folder.id }),
    } satisfies UpdateSlackIntegrationMappingByIdRequestBody,
  } satisfies UpdateSlackIntegrationMappingByIdOptionalsInput,
);
Python Gen
user_client.integration_mappings.update_slack_integration_mapping_by_id(
    slack_integration_mapping.id, box_item=IntegrationMappingBoxItemSlack(id=folder.id)
)
.NET Gen
await userClient.IntegrationMappings.UpdateSlackIntegrationMappingByIdAsync(integrationMappingId: slackIntegrationMapping.Id, requestBody: new UpdateSlackIntegrationMappingByIdRequestBody() { BoxItem = new IntegrationMappingBoxItemSlack(id: folder.Id) });
Node
const mapping = await client.integrationMappings.updateSlackIntegrationMapping({
	box_item: {
		id: '12345',
		type: 'folder'
	},
	options: {
		is_access_management_disabled: true
	}
}, {
	integration_mapping_id: integrationMappingId
});

console.log(
    `Slack integration mapping with id ${mapping.id} was updated`
);

レスポンスの例

{
  "id": "12345",
  "type": "integration_mapping",
  "box_item": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "integration_type": "slack",
  "is_manually_created": true,
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "options": {
    "is_access_management_disabled": true
  },
  "partner_item": {
    "id": "C12378991223",
    "type": "channel",
    "slack_org_id": "E1234567"
  }
}