アプリを登録して API へのアクセスを制御する

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

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

このセクションでは、アプリを登録して API キーを管理する方法について説明します。

概要

アプリを登録して、API にアクセス可能なユーザーを管理します。

API プロバイダは、API をサービス階層にバンドルする 1 つ以上の API プロダクトを作成します。API プロダクトでは、トラフィックとアクセスレベルを非常に細かいレベルで制限できます。API プロダクトを作成するときに、アクセスレベルを一般公開、限定公開、内部のいずれかに設定できます。詳しくは、アクセスレベルをご覧ください。

アプリ登録時に、アプリ デベロッパーが、使用する API プロダクトを選択すると、Apigee は、そのデベロッパーが API プロダクトへのアクセスに使用できる単一の API キーを提供します。アプリ デベロッパーは、各呼び出しの API キーを API プロダクトに含まれる API プロキシに渡します。アプリ デベロッパーが、そのアプリで参照される API プロダクトすべて（または一部）にアクセスできなくなるように、いつでもアプリの API キーを取り消すことができます。

通常、アプリ デベロッパーは、デベロッパー ポータルを使用して API プロダクトを使用するよう登録します。 ポータルを構築して API プロダクトを公開する手順については、ポータルの構築をご覧ください。

その代わりに、Apigee UI または Apigee API を使用してアプリを登録すると、アプリ登録プロセスをより細かく制御できます。たとえば、社内の開発チーム用のアプリを登録する場合や、ポータルにアクセスできないデベロッパーのためにアプリを登録する場合です。

組織管理者であるか、アプリの登録と API キーの管理を行う権限のあるロールを割り当てられている必要があります。

以降のセクションでは、UI と API を使用してアプリを登録し、API キーを管理する方法について説明します。

[Apps] ページの詳細

Apigee UI でアプリを登録して API キーを管理するには、[Apps] ビューを使用します。

Apigee UI を使用して [アプリ] ビューにアクセスするには:

• Cloud コンソールの Apigee UI を使用している場合: [ディストリビューション] > [アプリ] を選択します。
• 従来の Apigee UI を使用している場合: [公開] > [アプリ] を選択します。

[アプリ] ビューでは、次のことができます。

• アプリを登録する
• アプリを表示して編集する
• 認証情報を管理する
• アプリを承認または取り消す
• アプリを削除する
• 名前、デベロッパー、アプリ ID、コンシューマ API キー、またはすべてのコンテンツで、アプリのリストを検索する

アプリの登録

警告: アプリには、少なくとも 1 つの API プロキシやリソースパスが指定されている API プロダクトが 1 つ以上含まれている必要があります。API プロダクトに API プロキシやリソースパスが含まれていない場合、アプリのキーを使用して Apigee 組織内の任意の API プロキシを呼び出せます。ほとんどの場合、いわゆるスケルトンキー（家のどのドアでも開けられるキー）の作成は望まれません。

アプリは次の方法で登録できます。

• アプリ デベロッパー側: アプリ デベロッパーによるポータルの操作方法で説明されているように、アプリ デベロッパーは、ポータル経由でアプリを登録できます。
• 管理者側: 以下の説明に従って、Apigee にアプリを登録できます。キーをアプリ デベロッパーに提供する方法は、ご自身で決定します。

登録されたアプリは次のものに追加されます。

• Apigee 内の登録済みアプリのリスト。デベロッパーの詳細を表示して編集するをご覧ください。
• デベロッパー ポータル内の [Apps] ページ。

Apigee でアプリを登録するには:

1. [アプリ] ページにアクセスします。
• Cloud コンソールの Apigee UI を使用している場合: [ディストリビューション] > [アプリ] を選択します。
• 従来の Apigee UI を使用している場合: [公開] > [アプリ] を選択します。
2. 次の表の説明に従って、[App Details] を指定します。

   フィールド	説明	必須かどうか
   名前	アプリの名前。アプリの作成後、この名前を変更することはできません。この名前は Apigee API の呼び出しで使用されます。	必須
   表示名	Apigee UI とデベロッパー ポータルに表示されるアプリの表示名。	省略可
   デベロッパー	プルダウンからデベロッパー名を選択します。 注: パフォーマンス上の理由から、すべてのデベロッパーがプルダウンに表示されるわけではありません。検索ボックスにデベロッパー名またはメールアドレスの入力を開始すると、入力しているテキストに合わせてプルダウン値が自動的に調整されます。アプリ デベロッパーを登録するもご覧ください。	必須
   コールバック URL	通常は、クライアント アプリに代わって認証コードを受け取るように指定されたアプリの URL を指定します。この値は、一部の API プロダクトでは不要です。	省略可
   注	アプリを説明するメモ。	省略可

3. API キーの有効期限、ステータス、関連付けられた API プロダクトなどの認証情報を指定します。[Credentials] セクションで をクリックし、次の情報を入力します。

   フィールド	説明
   有効期限	有効期間または日付を構成するか、API キーを無期限に設定し、[OK] をクリックします。
   プロダクト	1 つ以上の API プロダクトを API キーに関連付けます。 [Add Product] をクリックします。 リストから 1 つ以上の API プロダクトを選択します。 [Add] をクリックします。 各 API プロダクトの [Status] を [Approved] に設定して承認するか、[Revoked] に設定して取り消します。 さらに API プロダクトを追加するには、上記の手順を繰り返します。

4. カスタム属性を指定します。
   1. [Custom Attributes] セクションで をクリックします。
   2. 名前と値を入力します。
   3. [Add] または [Add & Start another] をクリックします。追加できるカスタム属性の最大数は 18 です。
5. [Create] をクリックします。

アプリに関連付けた API プロダクトで API キーの手動承認が必要とされている場合は、API キーを承認する、または取り消すの説明に従って API キーを承認します。

デベロッパーの登録済みアプリを表示する

特定のデベロッパー用に登録済みのアプリを表示するには、次のいずれかの方法を使用します。

• すべての登録済みアプリを表示して、[Search] プルダウンで [Developer] を選択し、対象のデベロッパーの名前を検索フィールドに入力します。
• すべての登録済みアプリ デベロッパーを表示して、対象のデベロッパーに関連する行をクリックします。

アプリを表示して編集する

注: カスタム属性を編集する前に、既存の属性設定にシステム依存関係がないことを確認してください。

Apigee では、以下のエンティティはアクセスされてから最低 180 秒間、キャッシュに保持されます。

• OAuth アクセス トークン。OAuth v2 ポリシーの ExpiresIn 要素によって、アクセス トークンを 180 秒未満で期限切れにすることはできません。
• 鍵管理サービス（KMS）エンティティ（アプリ、デベロッパー、API プロダクト）。
• OAuth トークンと KMS エンティティのカスタム属性。

アプリを表示して編集するには:

1. [Apps] ページにアクセスします。
2. 表示して編集するアプリの行をクリックします。Apigee によってアプリの詳細が表示されます。
3. アプリを編集するには、[Edit] をクリックします。
4. 次のタスクを 1 つ以上実行します。
   • 名前、コールバック URL、メモなどのアプリの詳細を変更します。
   • 認証情報を管理します。
   • カスタム属性を追加または削除します。追加できるカスタム属性の最大数は 18 です。
   • アプリを承認するか、取り消します。
5. [Save] をクリックします。

認証情報の管理

アプリを編集する際、次の図に示すように、[Credentials] セクションでアプリの認証情報を管理できます。

上の図で示されているように、[Credentials] セクションでは UI を使用して次のタスクを行うことができます。

• API キーとシークレットを表示する
• 関連付けられているすべての API プロダクトまたは個別の API プロダクトについて API キーを承認する、または取り消す。
• アプリ内の API プロダクトを管理する
• 新しい認証情報を生成する

API を使用して認証情報を管理するには、既存のコンシューマ キーとシークレットをインポートするをご覧ください。

注: API プロダクトを作成するときに、そのアクセスレベルを [Internal only] または [Private] に設定することもできます。[Internal only] または [Private] とマークされた API プロダクトは、デベロッパー ポータルではデベロッパーに表示されません。これらのプロダクトにアクセスするには、プロダクトを Apigee API からデベロッパーのアプリに手動で追加します。

API キーとシークレットを表示する

API キーとシークレットを表示するには:

1. [Apps] ページにアクセスします。
2. API キーとシークレットを表示するアプリの行内でクリックします。
3. [Credentials] セクションで、表示する API キーまたはシークレットに関連する [Show] をクリックします。

API キーの承認または取り消し

API プロキシに対して API 呼び出しを行うには、通常、API キーが必要です。Apigee では、API キーが承認済みかつ有効であり、API を含む API プロダクトで定義された条件を満たしている場合にのみ、呼び出しが許可されます。

API プロダクトを管理するの説明に従って、API キーを自動的に承認するように API プロダクトを構成できます。ただし、手動による API キー承認が API プロダクトで必須になっている場合は、手動でキーを承認する必要があります。

すべて、または個別の API プロダクトについて、API キーを取り消すことができます。この場合、API キーとシークレットが無効になり、関連する API プロダクトでそれらを使って API にアクセスできなくなります。取り消した API キーは、いつでも再承認できます。

API キーを承認する、または取り消すには:

1. [Apps] ページにアクセスします。
2. 表示して編集するアプリの行をクリックします。
3. [Edit] をクリックします。
4. 次のいずれかのタスクを行います。
   • API キーに関連付けられているすべての API プロダクトの API キーを承認または取り消すには、その API キーに対応する [Approved] または [Revoked] を選択します。
   • 特定の API プロダクトの API キーを承認または取り消すには、API プロダクトの [Status] 列で [Approved] または [Revoked] を選択します。
5. [Save] をクリックします。

アプリ内の API プロダクトを管理する

アプリ内で API プロダクトを管理するには、次のタスクを行います。

• アプリに API プロダクトを追加する
• アプリから API プロダクトを削除する

アプリに API プロダクトを追加する

アプリに API プロダクトを追加するには:

1. [Apps] ページにアクセスします。
2. 表示して編集するアプリの行をクリックします。
3. [Edit] をクリックします。
4. 次のいずれかのタスクを行います。
   • API プロダクトを新しい API キーに追加するには、 をクリックして新しい認証情報を生成し、有効期限を選択して、その API プロダクトを API キーに追加します。
   • API プロダクトを既存の API キーに追加するには、[Credential] セクションで [Add product] をクリックし、プルダウン リストから API プロダクトを選択します。
5. [Save] をクリックします。

アプリから API プロダクトを削除する

API キーを有効にしたまま、1 つの API プロダクトでその API キー使用を許可しないようにする場合は、関連付けられた認証情報から削除できます。

1. [Apps] ページにアクセスします。
2. 表示して編集するアプリの行をクリックします。
3. [Edit] をクリックします。
4. API プロダクトの隣にある をクリックします。
5. [Save] をクリックします。

削除したプロダクトを再度追加できます。

新しい認証情報の生成

アプリの新しい認証情報を生成できます。たとえば API キーのローテーションを使用する場合、有効期限が切れてローテーションから外れるキーと一部重複する有効期限を持つ新しいキーを生成できます。元の Key-Secret のセキュリティが侵害された場合に、新しい Key-Secret を生成する場合もあります。新しいキーを生成した場合は、既存の API キーは期限が切れるまで、または明示的に取り消すまで機能し続けます。

新しい API キーを生成するには:

1. [Apps] ページにアクセスします。
2. 表示して編集するアプリの行をクリックします。
3. [Edit] をクリックします。
4. [Credentials] セクションで をクリックします。
5. 有効期限を指定し、API プロダクトを追加して、そのステータスを設定します。
6. 必要に応じて、他の API キーを取り消します。
7. [Save] をクリックします。

アプリの承認または取り消し

注: 特定のユーザーに関連付けられているアプリを承認または取り消すことができます。詳しくは、ポータル ユーザーの管理をご覧ください。

アプリを承認または取り消すには、以下の手順を行います。アプリを取り消すと、承認済みの API キーは Apigee への API 呼び出しで使用不可になります。アプリを再度承認すると、承認済みの有効なすべての API キーを API 呼び出しに使用できるようになります。

アプリが他の組織でも登録されている場合は、それらの各組織でアプリを取り消す必要があります。変更がすべてのメッセージ プロセッサで認識されるまでに数分かかることがあります。

アプリを承認する、または取り消すには:

1. [Apps] ページにアクセスします。
2. 表示して編集するアプリの行をクリックします。
3. [Edit] をクリックします。
4. [App Status] フィールドで [Approve] または [Revoke] を選択して、アプリをそれぞれ承認するか、取り消します。
5. [Save] をクリックします。

アプリの削除

アプリを削除すると、そのアプリに関連付けられているすべてのクライアント キーが無効になります。リクエストで無効なキーを使用すると、リクエストは失敗します。

今後、そのデベロッパー アプリを復元することを検討している場合は、削除する代わりに、アプリを取り消すこともできます。

アプリを削除するには:

1. [Apps] ページにアクセスします。
2. 削除するアプリの行にカーソルを合わせます。
3. [Actions] 列にある をクリックします。

注: Apigee では、デベロッパー アプリとその関連成果物の削除は非同期で行われます。デベロッパー アプリは直ちに削除されますが、そのデベロッパー アプリに関連付けられているリソース（アプリキー、アクセス トークンなど）が削除されるまでには数秒から数分の遅れがあります。

API を使用してアプリを登録し、API キーを管理する

Apigee API を使用してアプリの登録と管理を行うには、次の API を使用します。

• Apps API
• Developer apps API
• Developer App Keys API

既存のコンシューマ キーとシークレットのインポートもご覧ください。