ポータル ユーザーによるポータルの操作

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

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

すぐに使用できるデベロッパー ポータルにより、ポータル ユーザーがユーザー アカウントの作成、ログイン、API を使用するアプリの管理を行えるようになります。

以降のセクションでは、ポータル ユーザーによるポータルの操作方法について説明します。

ポータルにログインする

以下のセクションでは、ポータル ユーザーがユーザー認証情報（組み込み ID プロバイダ）または SAML（ベータ版）を使用して統合ポータルにログインする方法について説明します。

組み込み ID プロバイダと SAML ID プロバイダの両方を有効にしている場合、ポータル ユーザーは好みのログイン方法を選択できます。

ユーザー認証情報を使用してポータルにログインする（組み込み ID プロバイダ）

注: ログインページは、会社のロゴを変更することしかできません（ユーザー アカウントの作成とログイン エクスペリエンスの構成を参照）。

組み込み ID プロバイダが有効になっている場合、ポータル ユーザーは、次のセクションで説明するように、ユーザー認証情報（ユーザー名とパスワード）を使用して統合ポータルにログインできます。

• 統合ポータルにユーザー アカウントを作成する
• 統合ポータルにログインする
• パスワードを変更する

統合ポータルでユーザー アカウントを作成する

組み込み ID プロバイダを使用する場合は、ポータル ユーザーが API を使用する前に、統合ポータルにユーザー アカウントを作成する必要があります。

重要なポイント: アプリ デベロッパー アカウント情報の保存場所もご覧ください。

ポータル ユーザーに代わり Edge 管理 UI を使用して手動でユーザー アカウントを作成することは可能（アプリ デベロッパーの登録を参照）ですが、統合ポータルのユーザー アカウントと Edge のデベロッパー レコードの同期を確保するという点で、この方法はおすすめしません。

ポータル ユーザーは次の手順にそって、統合ポータルにアカウントを作成します。

1. ポータルに移動します。

2. [ログイン] をクリックします。

   [ログイン] ページが表示されます。

3. [アカウントを作成] をクリックします。

   [アカウントを作成] ページが表示されます。

   

   注: アカウント作成ページには、カスタム登録フィールドを追加できます（アカウント作成ページにカスタム登録フィールドを追加するを参照）。

4. フォームに入力します。

   すべての必須フィールドに値を入力する必要があります。パスワードは 8 文字以上とし、数字、英小文字、英大文字、特殊文字をそれぞれ 1 文字以上含める必要があります。

5. 利用規約を確認し、同意します。

6. [アカウントを作成] をクリックします。
   

   注: すでに登録されているメール ID を使用してアカウントを作成しようとすると、そのアカウントがすでに存在していることを知らせるメッセージが表示され、代わりにポータル ユーザーがログインするように促されます。
   1. キャプチャ フォームに入力し、[確認] をクリックします（表示された場合）。

   ユーザー アカウントが作成され、確認メールが送信されます。

   注: メール通知を構成するに記載のとおり、確認メールは構成することが可能です。Apigee では、ポータルを立ち上げる前に、ポータルから送信されるメール通知に使用する SMTP サーバーを構成することをおすすめします（SMTP サーバーを構成するを参照）。

7. 10 分以内に確認メールのリンクをクリックして、登録プロセスを完了します。

   10 分以内にリンクをクリックしなかった場合は、同じ手順をもう一度繰り返してアカウントを作成し、再度確認メールを受け取る必要があります。

8. 統合ポータルにログインします（後述）。

統合ポータルにログインする

組み込み ID プロバイダを使用する場合、ポータル ユーザーは、統合ポータルに登録して承認された後、認証情報（ユーザー名とパスワード）を使用してログインします。

注:

• 24 時間操作を行わないと、セッションは期限切れになり、ポータル ユーザーは自動的にログアウトされます。そうなった場合は、再度ログインする必要があります。
• ユーザー アカウントの手動アクティベーションを必須とするように統合ポータルを構成した場合、ポータル ユーザーがログインできるようになるには、ユーザー アカウントを手動で有効にする必要があります。現時点では、ログインできるようになる前に登録を手動で有効にする必要があることは、ポータル ユーザーに通知されません。手動アクティベーションを構成した場合は、新しいユーザー アカウントのアクティベーションを速やかに行うことをおすすめします。
• 直接 [ログイン] ページに移動するには、次の URL を使用します。
  https://portal-url/login

ポータル ユーザーは、次のようにログインします。

1. ポータルに移動します。
2. [ログイン] をクリックします。
   [ログイン] ページが表示されます。
   
3. メールアドレスとパスワードを入力します。
4. [ログイン] をクリックします。

パスワードを変更する

組み込み ID プロバイダを使用する場合、ポータル ユーザーは次のようにパスワードを変更します。

1. ポータルに移動します。
2. [ログイン] をクリックします。
3. [パスワードの再設定] をクリックします。
4. パスワードを再設定するアカウントのメールアドレスを入力します。

5. [Send Reset Password Link] をクリックします。

   パスワードを再設定するためのリンクがメールで送信されます。

   注: SMTP サーバーを構成するには、SMTP サーバーを構成するをご覧ください。

6. 確認メールにあるリンクをクリックします。

7. 新しいパスワードを入力し、それを確認します。

   パスワードは 8 文字以上とし、数字、英小文字、英大文字、特殊文字をそれぞれ 1 文字以上含める必要があります。

8. [Create New Password] をクリックします。

SAML 認証を使用してポータルにログインする（ベータ版）

注: これは、SAML ID プロバイダのベータ版リリースです。

注: ログインページは、会社のロゴを変更することしかできません（ユーザー アカウントの作成とログイン エクスペリエンスの構成を参照）。

SAML ID プロバイダが有効になっている場合、ポータル ユーザーは、以下のように SAML 認証を使用して統合ポータルにログインします。

1. ポータルに移動します。
2. [ログイン] をクリックします。

3. [login with SAML] をクリックします。

   SAML プロバイダにリダイレクトされます。

4. 確認画面が表示されたら、SAML ID プロバイダの認証情報を入力します。

注: 24 時間操作を行わないと、セッションは期限切れになり、ポータル ユーザーは自動的にログアウトされます。そうなった場合は、再度ログインする必要があります。

API リファレンス ドキュメントを表示する

ポータル ユーザーは、ポータルに公開されている API リファレンス ドキュメントを、以下のように表示できます。

1. ポータルに移動します。

2. 上部のナビゲーション バーにある [API] をクリックします。
   [API] ページが表示されます。次に例を示します。
   
   

3. 必要に応じ API のリストは、左のペインにあるツールを使用して、カテゴリ、タイトル、説明でフィルタします。

4. API リファレンス ドキュメントを表示するには、API カードをクリックします。
   API リファレンス ドキュメントが表示されます。

ポータル ユーザーは、API について学ぶこと、API を試すこと、API リファレンス ドキュメントのレンダリングに使用されるドキュメントをダウンロードすることができます。API リファレンス ドキュメントがどのようにレンダリングされるかについては、API の公開をご覧ください。

デベロッパー チーム（ベータ版）を使用してアプリに対する責任を共有する

注: チーム機能のベータ版リリースに登録している必要があります。

デベロッパー チームは、ポータル ユーザーが他のポータル ユーザーとアプリの責任を共有できるようにします。以下のセクションでは、デベロッパー チームの作成方法と管理方法について説明します。

重要なポイント: デベロッパー ポータルを閲覧する際、デベロッパー チームは単に「チーム」と呼ばれます。

デベロッパー チームのロールについて

次の表では、デベロッパー チームのメンバーに割り当て可能なロールを示します。

注: デベロッパー チームのメンバーであれば、デベロッパー チームのオーナーでない限り、自分のロールにかかわらず、どのデベロッパー チームからも自身を削除できます。

ロール	説明
アプリ管理者	デベロッパー チームのメンバーとデベロッパー チームの詳細の読み取り専用権限。 アプリに対する読み取りおよび書き込み権限。
オーナー	デベロッパー チームのメンバー、デベロッパー チームの詳細、アプリに対する完全な読み取りおよび書き込み権限。
閲覧者	デベロッパー チームのメンバー、デベロッパー チームの詳細、アプリに対する読み取り専用権限。

[チーム] ページを表示する

[チーム] ページには、自身がメンバーになっているデベロッパー チームが表示されます。

[チーム] ページにアクセスするには:

1. ポータルにログインします。
2. ポータルのユーザー アカウント プルダウンから [チーム] を選択します。

[チーム] ページが表示され、次のことができます。

• 自身がメンバーとなっているデベロッパー チームの名前、ロール、メンバーのリスト、チームの作成日などを表示する
• デベロッパー チームを追加する
• デベロッパー チームの行をクリックして、デベロッパー チームのメンバーとロールを編集する、自身をデベロッパー チームから削除する、チームを削除する

デベロッパー チームを追加する

注: ポータル ユーザーは、自分が所属するデベロッパー チームを [チーム] ページで確認できます。ベータ版リリースでは、ポータル ユーザーがデベロッパー チームに追加されたときに通知は送信されません。

デベロッパー チームを追加するには:

1. ポータルにログインします。
2. ポータルのユーザー アカウント プルダウンから [チーム] を選択します。
3. [+ 新しいチーム] をクリックします。
4. 名前と説明を入力します。

5. デベロッパー チームにメンバーを追加するには、[+ 別のメンバーを追加] をクリックして、ポータル ユーザーのメールアドレスを入力し、デベロッパー チームのロールを選択します。

   さらにメンバーを追加するには、これを繰り返します。

   注:

   • チームを作成したユーザーは、自動的にそのデベロッパー チームのオーナーとして追加されます。
   • ユーザーは、最大 16 のデベロッパー チームでメンバーになれます。

6. デベロッパー チームからメンバーを削除するには、削除するメンバーの横にある をクリックします。

7. [作成] をクリックします。

デベロッパー チームのメンバーとロールを編集する

デベロッパー チームのメンバーとロールを編集するには:

1. ポータルにログインします。
2. ポータルのユーザー アカウント プルダウンから [チーム] を選択します。
3. 自身がオーナーで、編集するデベロッパー チームの行をクリックします。

4. 以下の操作を 1 つ以上行います。

   • 名前、説明、メインの連絡先を編集する。
   • デベロッパー チームのメンバーを追加または削除する。
   • デベロッパー チーム メンバーのロールを更新する。
     注:

     • デベロッパー チームには、オーナーが少なくとも 1 人必要です。
     • ユーザーは、最大 16 のデベロッパー チームでメンバーになれます。

5. [保存] をクリックします。

自身をデベロッパー チームから削除する

注: デベロッパー チームのメンバーであれば、デベロッパー チームのオーナーでない限り、デベロッパー チームのロールにかかわらず、どのデベロッパー チームからも自身を削除できます。

自身をデベロッパー チームから削除するには:

1. ポータルにログインします。
2. ポータルのユーザー アカウント プルダウンから [チーム] を選択します。
3. 自身を削除するデベロッパー チームの行をクリックします。
4. [Leave Team] をクリックします。

デベロッパー チームを削除する

注: デベロッパー チームを削除すると、そのデベロッパー チームが所有しているアプリもすべて削除されます。

デベロッパー チームを削除するには:

1. ポータルにログインします。
2. ポータルのユーザー アカウント プルダウンから [チーム] を選択します。
3. 削除するデベロッパー チームの行をクリックします。
4. [] をクリックします。
5. [確認] をクリックして削除を確定します。

アプリを登録する

デベロッパー アプリとデベロッパー チーム アプリは、以降のセクションで説明するように操作して登録します。

デベロッパー アプリを登録する

重要なポイント: ポータル ユーザーがデベロッパー アプリを登録すると、[デベロッパー] ページで、ユーザー アカウント情報が Edge と同期され利用できるようになります。アプリ デベロッパー アカウント情報の保存場所をご覧ください。

ポータル ユーザーは、次のように操作して、公開した API を使用するアプリを登録できます。

1. ユーザー アカウントのプルダウンから、[アプリ] を選択します。
2. [+ 新しいアプリ] をクリックして新しいアプリを作成します。
3. [新しいアプリ] ダイアログで、アプリの名前と説明を入力します。

4. [API Catalog] セクションで、1 つ以上の API を選択します。

   カタログ内の API は、コールバック URL を必要とする認証 API か、公開 API に分類されています。アプリを作成するには、少なくとも 1 つの API を選択する必要があります。

5. [Authenticated APIs] セクションで API を選択した場合は、コールバック URL を入力します。

   詳細については、コールバック URL についてをご覧ください。

6. [作成] をクリックします。

デベロッパー チーム アプリを登録する

注: この手順は、チームの機能のベータ版リリースに登録している場合にのみ適用されます。ベータ版では、アプリを作成した後にアプリのオーナー権限を委譲することはできません。

デベロッパー チームのメンバーは、下の手順に沿って、公開した API を使用するデベロッパー チームのアプリを登録できます。

注: デベロッパー チームの新しいエンティティは、メンバーがチームのアプリを登録するまで Edge に追加されません。デベロッパー チームの情報が保存されている場所（ベータ版）をご覧ください。

各手順の詳細は、以下をご覧ください。

• ポータル ユーザーがチームを追加して管理する方法については、デベロッパー チーム（ベータ版）を使用してアプリの責任を共有するをご覧ください。
• API プロバイダがデベロッパー チームを表示、管理する方法については、デベロッパー チーム（ベータ版）の管理をご覧ください。

デベロッパー チーム アプリを登録するには:

1. ユーザー アカウントのプルダウンから [チーム] を選択します。
2. アプリを登録するデベロッパー チームの行をクリックします。
3. [+ 新しいアプリ] をクリックして新しいアプリを作成します。
4. [新しいアプリ] ダイアログで、アプリの名前と説明を入力します。

5. [オーナー] プルダウン リストからアプリのオーナーを選択します。

   デフォルトでは、デベロッパー チームがアプリのオーナーになります。必要な場合は、プルダウン メニューから別のデベロッパー チームや自身をオーナーとして選択します。

   注: ベータ版リリースでは、アプリを作成した後にアプリのオーナー権限を委譲することはできません。

6. [API Catalog] セクションで、1 つ以上の API を選択します。

   カタログ内の API は、コールバック URL を必要とする認証 API か、公開 API に分類されています。アプリを作成するには、少なくとも 1 つの API を選択する必要があります。

7. [Authenticated APIs] セクションで API を選択した場合は、コールバック URL を入力します。

   詳細については、コールバック URL についてをご覧ください。

8. [作成] をクリックします。

アプリ内の API を管理する

API プロデューサーとして API を公開し、ポータル ユーザーが API プロダクトを使用できるようにします。

ポータル ユーザーは、アプリが使用する API を管理します。使用する API は、アプリ詳細ページに追加されます。API の中には、自動的に承認されないものがあります。[承認待ち] のステータスは、API へのアクセスをリクエストされているが、まだ許可されていないことを示します。

注: 現在、公開されていない API は表示されません。この問題は今後のリリースで修正される予定です。

ポータル ユーザーが非公開または内部専用の API へのアクセスを無効にすると、API はアプリから削除され、ポータル管理者が手動で再追加する必要があります（アプリの登録による API へのアクセス管理を参照）。

ポータル ユーザーは、次のように操作して、ポータルからアプリ内の API を管理できます。

1. ユーザー アカウントのプルダウンから、[アプリ] を選択します。
2. リスト内のアプリをクリックします。
3. [API] セクションで、 または をクリックして、アプリから API へのアクセスをそれぞれ有効または無効にします。
4. 認証済み API の場合は、必要に応じてコールバック URL を追加または編集します。

アプリ用の API キーとシークレットを表示する

ポータル ユーザーは、次のように操作して、ポータルからアプリの API キーを管理できます。

1. ユーザー アカウントのプルダウンから、[アプリ] を選択します。
2. リスト内のアプリをクリックします。
3. [API キー] セクションに API キーが表示されます。
4. API キーのステータスが [有効] であることを確認します。
   API キーの承認が必要で、まだ承認されていない場合、ステータスは [承認待ち] と表示されます。
5. [Show secret] をクリックしてシークレットを表示します。
6. API キーまたはシークレットにカーソルを合わせ、 をクリックしてクリップボードにコピーします。

注: ユーザー アカウントまたはアプリのいずれかが、無効化または取り消された場合は、ユーザー アカウントかアプリが再度有効化または再承認されるまで API キーは有効になりません。詳細については、デベロッパーのアクティブ化と非アクティブ化およびアプリの承認または取り消しをご覧ください。

アプリの API キーをローテーションする

ポータル ユーザーは、アプリの API キーを定期的にローテーションすることや、漏洩やセキュリティ侵害の可能性がに応じてローテーションすることができます。ポータル ユーザーが API キーをローテーションすると、元のキーと同じ API 利用資格で新しい API キーが作成されます。元の API キーは、使用停止に移行する間も有効なまま残ります。古い API キーは、取り消して認証情報を受け付けないようにする必要があります（アプリの API キーを取り消すを参照）。

ポータル ユーザーは、以下のように操作して、ポータルからアプリの API キーをローテーションできます。

1. ユーザー アカウントのプルダウンから、[アプリ] を選択します。
2. リスト内のアプリをクリックします。
3. [API キー] セクションで、[キーを追加] をクリックします。
4. ダイアログ ボックスで、[確認] をクリックして操作を確定します。
5. 必要に応じ、下の手順に沿って古い API キーを取り消します。

アプリの API キーを取り消す

前のセクションで説明したとおり、ポータル ユーザーが API キーをローテーションした場合、その API キーは、使用停止に移行する間も、引き続き有効です。その API キーの認証情報を受け付けないようにするには、API キーを取り消す必要があります。

ポータル ユーザーは、以下のように操作して、ポータルからアプリの API キーを取り消すことができます。

1. ユーザー アカウントのプルダウンから、[アプリ] を選択します。
2. アプリの名前をクリックします。
3. [API キー] セクションで、取り消す API キーに対応する [アクション] 列の をクリックします。

4. [確認] をクリックして操作を確定します。

   キーのステータスが [取り消し済み] に更新されます。

アプリの詳細を編集する

ポータル ユーザーは、次のように操作して、アプリの詳細を編集できます。

1. ユーザー アカウントのプルダウンから、[アプリ] を選択します。
2. リスト内のアプリをクリックします。
3. [アプリの詳細] タブで、[名前] フィールドまたは [説明] フィールドを編集します。
4. 必要に応じて、アプリ内の API を管理します。
5. [保存] をクリックします。

アプリを削除する

ポータル ユーザーは、次のように操作して、ポータルからアプリを削除できます。

1. ユーザー アカウントのプルダウンから、[アプリ] を選択します。
2. リスト内のアプリをクリックします。
3. [削除] をクリックします。
4. [確認] をクリックして操作を確定します。

アプリが削除され、アプリのリストから消されます。