スタート ガイド

このページの内容は ApigeeApigee ハイブリッドに該当します。

Apigee Edge のドキュメントを表示する。

このページでは、サブスクリプション モデルと従量課金制の組織で Advanced API Security を使用する方法について説明します。

必要なロール

以降のセクションでは、Advanced API Security を使用してタスクを実行するために必要なロールについて説明します。

セキュリティ レポートに必要なロール

次の表に、セキュリティ レポートに関連するタスクを実行するために必要なロールを示します。

セキュリティ レポート タスク 必要なロール
Advanced API Security を有効または無効にする Apigee 組織管理者(roles/apigee.admin)
レポートの作成と表示 Apigee 組織管理者(roles/apigee.admin)
Apigee セキュリティ管理者(roles/apigee.securityAdmin)
レポートを表示する Apigee セキュリティ閲覧者(roles/apigee.securityViewer)
Apigee セキュリティ管理者(roles/apigee.securityAdmin)

リスク評価に必要なロール

次の表に、リスク評価に関連するタスクの実行に必要なロールを示します。

リスク評価タスク 必要なロール
カスタム セキュリティ プロファイルの作成、更新、削除 Apigee セキュリティ管理者(roles/apigee.securityAdmin)
Apigee 組織管理者(roles/apigee.admin)
セキュリティ プロファイルの接続または接続解除 Apigee セキュリティ管理者(roles/apigee.securityAdmin)
Apigee 組織管理者(roles/apigee.admin)
セキュリティ スコアを表示する Apigee セキュリティ管理者(roles/apigee.securityAdmin)
Apigee セキュリティ閲覧者(roles/apigee.securityViewer)
Apigee 組織管理者(roles/apigee.admin)
すべてのセキュリティ プロファイルの一覧表示またはプロファイルの取得 Apigee セキュリティ管理者(roles/apigee.securityAdmin)
Apigee セキュリティ閲覧者(roles/apigee.securityViewer)
Apigee 組織管理者(roles/apigee.admin)

不正行為の検出に必要なロール

次の表に、不正行為の検出に関連するタスクの実行に必要なロールを示します。

不正行為検出タスク 必要なロール
Abuse Detection UI でのインシデントの表示 Apigee セキュリティ管理者(roles/apigee.securityAdmin)
Apigee セキュリティ閲覧者(roles/apigee.securityViewer)
Apigee 組織管理者(roles/apigee.admin)

セキュリティ アクションに必要なロール

次の表に、セキュリティ アクションに関連するタスクの実行に必要なロールを示します。

セキュリティ アクション タスク 必要なロール
セキュリティ アクションの作成 Apigee セキュリティ管理者(roles/apigee.securityAdmin)
Apigee 組織管理者(roles/apigee.admin)
セキュリティ アクションの構成の更新 Apigee セキュリティ管理者(roles/apigee.securityAdmin)
Apigee 組織管理者(roles/apigee.admin)
セキュリティ アクションの表示または一覧表示 Apigee セキュリティ管理者(roles/apigee.securityAdmin)
Apigee セキュリティ閲覧者(roles/apigee.securityViewer)
Apigee 組織管理者(roles/apigee.admin)
適用状況の確認 Apigee セキュリティ管理者(roles/apigee.securityAdmin)
Apigee セキュリティ閲覧者(roles/apigee.securityViewer)
Apigee 組織管理者(roles/apigee.admin)

サブスクリプションを使用する組織の Advanced API Security を管理する

サブスクリプション利用顧客として Advanced API Security を使用するには、Advanced API Security がサブスクリプションの利用資格の一部である必要があります。Apigee の利用資格をご覧ください。Advanced API Security を利用資格に追加するには、Apigee セールスにお問い合わせください。

Advanced API Security が利用資格に含まれていたら、組織で有効にします。

サブスクリプションの Apigee 組織または従量課金制の Apigee 組織のどちらを使用しているかわからない場合は、Apigee 組織管理者にお問い合わせください。

Apigee アドオンの構成を取得する

サブスクリプションを使用する組織の Advanced API Security を有効にするには、まず次の API 呼び出しを使用して、現在の Apigee アドオンの構成を取得する必要があります。これにより、Advanced API Security が有効になっているかどうかも確認できます。

curl "https://apigee.googleapis.com/v1/organizations/ORG" \
  -X GET \
  -H "Content-type: application/json" \
  -H "Authorization: Bearer $TOKEN"

ここで

この呼び出しは、次の行で始まる Apigee アドオン構成のセクションなど、組織に関する基本情報を返します。

"addonsConfig": {

このセクションに次のエントリが含まれているかどうかを確認します。

"apiSecurityConfig": {
          "enabled": true
      }

その場合、Advanced API Security は組織ですでに有効になっています。それ以外の場合は、次に説明するように、有効にする必要があります。

サブスクリプションを使用する組織の Advanced API Security を有効にする

サブスクリプションを使用する組織で Advanced API Security をデフォルトの構成で有効にするには、次のような POST リクエストを発行します。

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": true
      }
      <Other entries of your current add-ons configuration>
    }
  }'

ここで

たとえば、現在のアドオンの構成が以下の場合、

"addonsConfig": {
  "integrationConfig": {
      "enabled":true
  },
  "monetizationConfig": {
      "enabled":true
  }
},

Advanced API Security を有効にするコマンドは次のようになります

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": true
      },
      "integrationConfig": {
          "enabled": true
      },
      "monetizationConfig": {
          "enabled": true
      }
    }
  }'

リクエストを送信すると、次のようなレスポンスが表示されます。

{
  "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/apigee-docs-d",
    "state": "IN_PROGRESS"
  }
}

サブスクリプションを使用する組織の Advanced API Security を無効にする

サブスクリプションを使用する組織で、なんらかの理由で Advanced API Security を無効にする必要がある場合は、次に示すように、POST リクエストを発行してリクエスト本文のアドオン構成を渡します。

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": false
      }
     <Include current add-ons configuration>
    }
  }'

次に、オペレーションが進行中であることを示すレスポンスの例を示します。

{
  "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

詳細については、組織のアドオン API を構成するをご覧ください。

従量課金制を使用する組織の Advanced API Security を管理する

従量課金制をご利用の場合は、Advanced API Security を有料アドオンとして有効にできます。中間または包括的な Apigee 環境用の Advanced API Security アドオンを有効にする方法については、Advanced API Security アドオンを管理するをご覧ください。

サブスクリプションの Apigee 組織または従量課金制の Apigee 組織のどちらを使用しているかわからない場合は、Apigee 組織管理者にお問い合わせください。

次のステップ

Advanced API Security を有効にしたら、次のセクションをご覧ください。