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

Shieldリストを更新

put
https://api.box.com/2.0
/shield_lists/:shield_list_id

Shieldリストを更新します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

リクエストヘッダー

stringヘッダー内必須

Version header.

次の値に固定: 2025.0

パスパラメータ

stringパス内必須
90fb0e17-c332-40ed-b4f9-fa8908fbbb24

Shieldリストを表す一意の識別子。ShieldリストのIDは、企業のShieldリストをすべて取得するエンドポイントからのレスポンスで確認できます。

リクエスト本文

Shieldリストのコンテンツ (国) / Shieldリストのコンテンツ (ドメイン) / Shieldリストのコンテンツ (メールアドレス) / Shieldリストのコンテンツ (IP) object本文内

このShieldリストの要素の種類を指定し、要素自体を含めます。公開APIで統合のShieldリストを更新することはできません。

string本文内省略可能
"A list of things that are shielded"

Shieldリストの説明 (省略可)。

string本文内必須
"My Shield List"

Shieldリストの名前。

レスポンス

application/jsonShieldリスト

Shieldリストオブジェクトを返します。

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

Shieldリストが見つかりませんでした。

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

この名前のShieldリストがすでに存在します。

put
Shieldリストを更新
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

Box SDKのバージョン戦略の詳細については、 **こちら**を確認してください。


Node/TypeScript v10
await client.shieldLists.updateShieldListByIdV2025R0(shieldListCountry.id, {
  name: shieldListCountryName,
  description: 'Updated description',
  content: new ShieldListContentCountryV2025R0({
    type: 'country' as ShieldListContentCountryV2025R0TypeField,
    countryCodes: ['US'],
  }),
} satisfies ShieldListsUpdateV2025R0);
Python v10
client.shield_lists.update_shield_list_by_id_v2025_r0(
    shield_list_country.id,
    shield_list_country_name,
    ShieldListContentCountryV2025R0(
        type=ShieldListContentCountryV2025R0TypeField.COUNTRY, country_codes=["US"]
    ),
    description="Updated description",
)
.NET v10
await client.ShieldLists.UpdateShieldListByIdV2025R0Async(shieldListId: shieldListCountry.Id, requestBody: new ShieldListsUpdateV2025R0(name: shieldListCountryName, content: new ShieldListContentCountryV2025R0(type: ShieldListContentCountryV2025R0TypeField.Country, countryCodes: Array.AsReadOnly(new [] {"US"}))) { Description = "Updated description" });
Java v10
client.getShieldLists().updateShieldListByIdV2025R0(shieldListCountry.getId(), new ShieldListsUpdateV2025R0.Builder(shieldListCountryName, new ShieldListContentCountryV2025R0.Builder(Arrays.asList("US")).type(ShieldListContentCountryV2025R0TypeField.COUNTRY).build()).description("Updated description").build())

レスポンスの例

{
  "id": "90fb0e17-c332-40ed-b4f9-fa8908fbbb24",
  "type": "shield_list",
  "content": {
    "type": "country",
    "country_codes": [
      "US",
      "PL"
    ]
  },
  "created_at": "2025-01-13T15:31:01.896Z",
  "description": "A list of things that are shielded",
  "enterprise": {
    "id": "1910967",
    "type": "enterprise"
  },
  "name": "Shield List Name",
  "updated_at": "2025-01-13T15:31:01.896Z"
}