デベロッパー アプリキーの取り消しと承認

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

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

このトピックでは、UI と API を使って、デベロッパー アプリ内のプロダクト、あるいはデベロッパー アプリの API キーの取り消し、承認を行う方法について説明します。

UI を使用してデベロッパー アプリ内の特定の API プロダクトのキーを取り消す

UI を使用して、特定の API プロダクトに関連付けられたキーを取り消すことが可能です。これにより、キーが再承認されない限り、その API プロダクトに定義されている API リソースにアクセスできなくなります。

Apigee UI を使用してキーを取り消すには:

  1. Apigee UI を開きます。
  2. 左側のナビゲーション バーで [Publish] > [Apps] を選択します。
  3. 取り消すキーが含まれるアプリを選択します。
  4. 編集アイコン 編集アイコンの画像。 をクリックします。
  5. [Credentials] セクションの [Status] プルダウン メニューで [Revoke] を選択します。

UI を使用してデベロッパー アプリ内の特定の API プロダクトのキーを承認する

Apigee UI を使用して、デベロッパー アプリ内で以前に取り消された API プロダクトのコンシューマ キーを承認できます。クライアント アプリは、そのサービスの API を再び使用できるようになります。

API プロダクトキーを承認するには:

  1. Apigee UI を開きます。
  2. メインメニューから、[Publish] > [Apps] を選択します。
  3. アプリのリストから、承認するキーを含むアプリを選択します。
  4. 編集アイコン 編集アイコンの画像。 をクリックします。
  5. [Credentials] セクションの [Status] プルダウン メニューで [Approve] を選択します。

Apigee API を使用して API プロダクトのキーを取り消して承認する

Apigee には、ユースケースに応じて API キーのステータスを管理できる API が用意されています。次のデベロッパー アプリの JSON では、次の 3 つのケースそれぞれの承認 / 取り消しフラグの場所が示されています。

  • （1）は、デベロッパー アプリ内の特定の API プロダクトのキーステータスを示しています。この API の動作は、このトピックの上記で説明した UI 操作とまったく同じです。アプリのコンシューマ キーの承認または取り消しを行うための API をご覧ください。
  • （2）は、デベロッパー アプリキーのキーステータスを示しています。キーを取り消すと、アプリはそのキーを使って API にアクセスできなくなります。取り消されたアプリキーに関連付けられたすべてのアクセス トークンは有効なままですが、Apigee は最初にアプリキーのステータスを確認します。ステータスが「revoked」となっている場合、Apigee は呼び出しを許可しません。デベロッパー アプリの API キーの承認または取り消しを行うための API をご覧ください。
  • （3）は、デベロッパー アプリに関連付けられているすべてのキーのキーステータスを示しています。取り消されたアプリは、API プロダクトにアクセスできず、Apigee が管理する API を呼び出すこともできません。デベロッパー アプリのすべてのキーの承認または取り消しを行うための API をご覧ください。
{
  "accessType": "",
  "appFamily": "default",
  "appId": "6ed3a4d1-4733-439a-80a4-0d71149ec9ad",
  "attributes": [
    {
      "name": "DisplayName",
      "value": "AnotherTestApp"
    },
    {
      "name": "Notes",
      "value": ""
    }
  ],
  "callbackUrl": "",
  "createdAt": 1415728893126,
  "createdBy": "wwitman@apigee.com",
  "credentials": [
    {
      "apiProducts": [
        {
          "apiproduct": "Weather-Product",
          "status": "revoked" // (1)
        }
      ],
      "attributes": [],
      "consumerKey": "giIC9Au6XP82wJ1oxZuQU4L75OdNKLhb",
      "consumerSecret": "SXg8JizqeTA8j3gX",
      "expiresAt": -1,
      "issuedAt": 1415728893154,
      "scopes": [],
      "status": "approved" // (2) 
    }
  ],
  "developerId": "Z2S37rxX2Suzkwtg",
  "lastModifiedAt": 1420682967414,
  "lastModifiedBy": "wwitman@apigee.com",
  "name": "AnotherTestApp",
  "scopes": [],
  "status": "approved" // (3)
}