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

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

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

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

下記の説明に従ってキーを取り消します。

Edge

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

  1. apigee.com/edge にログインします。
  2. 左側のナビゲーション バーで [Publish] > [Apps] を選択します。
  3. 取り消したいキーの入ったアプリを選択します。
  4. デベロッパー アプリのページで をクリックします。
  5. [Credentials] セクションの [Status] プルダウン メニューで [Revoke] を選択します。

Classic Edge(Private Cloud)

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

  1. http://ms-ip:9000 にログインします。ここで、ms-ip は、Management Server ノードの IP アドレスまたは DNS 名です。
  2. 上部のナビゲーション バーで [Publish] > [Developer Apps] を選択します。
  3. アプリのリストから、取り消したいキーの入ったアプリを選びます。
  4. デベロッパー アプリのページで [Edit] をクリックします。
  5. [Products] セクションで [Revoke] をクリックして、取り消したいサービスのキーを取り消します。

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

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

  1. Apigee Edge のアカウントにログインします。
  2. メインメニューから [Publish] > [Developer apps] を選択します。
  3. アプリのリストから、取り消したいキーの入ったアプリを選びます。
  4. デベロッパー アプリのページで [Edit] をクリックします。
  5. [Products] セクションで [Approve] をクリックしてキーを元に戻します。

Edge API を使った API プロダクトのキーの取り消しと承認

Edge には、用途に応じて API キーの状態を管理する API が用意されています。以下のデベロッパー アプリの JSON 表現では、それぞれの承認 / 取り消しフラグの位置が、次の 3 つのケースについて示されています。

  • (1)デベロッパー アプリ内の特定の API プロダクトのキーの取り消しまたは承認。この API の動作は、上で説明した UI 操作とまったく同じです。Approve or Revoke API Product for a Key for a Developer App をご覧ください。
  • (2)デベロッパー アプリの特定のキーの取り消しまたは承認。キーを取り消すと、アプリがそのキーを使用して API にアクセスできなくなります。取り消されたアプリキーに関連付けられたすべてのアクセス トークンは有効のままですが、Apigee Edge が最初にアプリキーの状態を確認します。状態が "revoked" となっている場合、Apigee Edge は呼び出しを許可しません。Approve or Revoke Specific Key of Developer App をご覧ください。
  • (3)デベロッパー アプリ全体の API キーの状態の取り消しまたは承認。取り消されたアプリは API プロダクトにアクセスできず、Apigee Edge によって管理されている 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)
}