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

デベロッパー ポータルでは、複雑な設定なしで、デベロッパー アカウントの作成、ログイン、API を使用するアプリの管理といった機能をポータル ユーザーにすぐに提供できます。以降のセクションで、ポータルの操作方法について詳しく説明します。

ポータルにログインする

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

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

ユーザー認証情報と SAML 認証が両方とも有効な場合の [Sign In] ダイアログ

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

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

統合ポータルでデベロッパー アカウントを作成する

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

ポータル ユーザーは次の手順に従って、統合ポータルでデベロッパー アカウントを作成します。

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

  2. [Sign In] をクリックします。

    [Sign In] ページが表示されます。

  3. [Create Account] をクリックします。

    [Create your account] ページが表示されます。

    [Create your account] ダイアログ

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

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

  5. 利用規約を読み、これに同意します。

  6. [Create Account] をクリックします。

    注: すでに登録されているメール ID を使ってアカウントを作成しようとすると、そのアカウントはすでに存在することを知らせるメッセージが表示され、そのユーザーでログインするよう促されます。

  7. CAPTCHA フォームに入力し、[Verify] をクリックします（表示されている場合）。

    デベロッパー アカウントが作成され、確認メールが送信されます。

    注: メール通知を構成するに従って、確認メールを構成できます。ポータルをリリースする前に、ポータルから送信されるメール通知用に SMTP サーバーを構成することをおすすめします。SMTP サーバーを構成するをご覧ください。

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

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

  9. 統合ポータルにログインします（下記を参照）。

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

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

ポータル ユーザーは次の手順に従ってログインします。

  1. ポータルに移動します。
  2. [Sign In] をクリックします。
  3. メールアドレスとパスワードを入力します。
  4. [Sign In] をクリックします。

パスワードを変更する

組み込み ID プロバイダでパスワードを変更する場合、ポータル ユーザーは次の手順に従います。

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

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

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

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

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

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

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

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

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

SAML ID プロバイダが有効な場合、ポータル ユーザーは次の手順に従い、SAML 認証を使用して統合ポータルにログインします。

  1. ポータルに移動します。
  2. [Sign In] をクリックします。

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

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

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

デベロッパー アカウントの登録とログインは Hybrid でどのように表されるか

デベロッパー アカウントの登録とポータルへのログインは、Hybrid では _apiportal カスタム属性で表されます。

ポータル ユーザーが自己登録すると（組み込み ID プロバイダの場合のみ）、_apiportal カスタム属性がポータル ユーザー構成に追加され、ステータスが unverified に設定されます。このステータスは、そのデベロッパーがまだ一度もポータルにログインしていないことを示します。例: {"status":"unverified","portals":{}}

ポータル ユーザーが初めてポータルにログインすると、_apiportal カスタム属性が更新されてポータル名とアクセス日時が反映され、ステータスが active に設定されます。その後、ポータル ユーザーがポータルにログインするたびにこのカスタム属性が更新され、そのポータルの lastVisit（エポック形式）が再設定されます。例: {"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}

API リファレンス ドキュメントを見る

ポータル ユーザーは次の手順に従って、ポータルに公開されている API リファレンス ドキュメントを閲覧できます。

  1. ポータルに移動します。
  2. 上部のナビゲーション バーにある [APIs] をクリックします。

  3. API リファレンス ドキュメントを見る API カードをクリックします。

    API リファレンス ドキュメントが表示されます。ここで、その API がどのようなものであるかを理解し、API を試すことができます。

  4. API を試すには、認可を受ける必要があります。

    a. 上部のナビゲーション バーにある [Authorize] をクリックします。
    b. 必要な認証情報を入力します。
    c. [Authorize] をクリックします。
    d. [OK] をクリックします。

API リファレンス ドキュメントのレンダリングに使用される OpenAPI 仕様をダウンロードするには、[Download Spec] をクリックします。API リファレンス ドキュメントがどのようにレンダリングされるかについては、API の公開をご覧ください。

アプリを登録する

ポータル ユーザーは次の手順に従って、公開されている API プロダクトを使用するアプリを登録できます。

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

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

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

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

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

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

アプリで使用する API プロダクトを管理する

ポータル ユーザーは、アプリで使用する API プロダクトを管理できます。選択した API プロダクトはアプリ詳細ページに追加されます。API プロダクトの中には、自動的に承認されないものがあります。ステータスが [Pending] の場合は、API の使用申請がまだ承認されていないことを示します。

ポータル ユーザーは次の手順に従って、アプリで使用する API プロダクトをポータルから管理できます。

  1. デベロッパー アカウント プルダウンから [Apps] を選択します。
  2. リスト内のアプリをクリックします。
  3. [APIs] セクションでアクセス切り替えをクリックして、アプリからの API プロダクトへのアクセスを有効または無効にします。
  4. 認証 API の場合は、必要に応じてコールバック URL を追加または編集します。

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

ポータル ユーザーは次の手順に従って、アプリの API キーをポータルから管理できます。

  1. デベロッパー アカウント プルダウンから [Apps] を選択します。
  2. リスト内のアプリをクリックします。
  3. [API Keys] セクションに API キーが表示されます。
  4. API キーのステータスが [Active] であることを確認します。
  5. [Show] をクリックしてシークレットを表示します。
  6. API キーまたはシークレットにカーソルを合わせ、削除アイコン をクリックしてクリップボードにコピーします。

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

ポータル ユーザーは、アプリの API キーを定期的に、または漏洩やセキュリティ侵害の可能性が見つかったときに、ローテーションできます。API キーをローテーションさせると、API プロダクトのエンタイトルメントは元のキーと同じままで、新しい API キーが作成されます。元の API キーは、ユーザーが使用停止にしない限り引き続き有効になります。古い API キーの認証情報が受け入れられないようにするため、アプリの API キーを取り消すに従って古い API キーを取り消す必要があります。

ポータル ユーザーは次の手順に従って、アプリの API キーをポータルからローテーションできます。

  1. デベロッパー アカウント プルダウンから [Apps] を選択します。
  2. リスト内のアプリをクリックします。
  3. [API Keys] セクションで、[Add Key] をクリックします。
  4. ダイアログ ボックスで [Confirm] をクリックして操作を確定します。
  5. 必要に応じて、下記の手順に従って古い API キーを取り消します。

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

前のセクションに従って API キーをローテーションしたとき、元の API キーは、ユーザーが使用停止にしない限り引き続き有効になります。古い API キーの認証情報が受け入れられないようにするため、古い API キーを取り消す必要があります。

ポータル ユーザーは次の手順に従って、アプリの API キーをポータルから取り消すことができます。

  1. デベロッパー アカウント プルダウンから [Apps] を選択します。
  2. アプリの名前をクリックします。
  3. [App Details] タブで、取り消しアイコン をクリックします。

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

    キーのステータスが [Revoked] に変わります。

アプリの詳細を編集する

ポータル ユーザーは次の手順に従って、アプリの詳細を編集できます。

  1. デベロッパー アカウント プルダウンから [Apps] を選択します。
  2. リスト内のアプリをクリックします。
  3. [App Details] タブで [Name] フィールドまたは [Description] フィールドを編集します。
  4. 必要に応じて、API プロダクトを管理します。
  5. [Save] をクリックします。

アプリを削除する

ポータル ユーザーは次の手順に従って、ポータルからアプリを削除できます。

  1. デベロッパー アカウント プルダウンから [Apps] を選択します。
  2. リスト内のアプリをクリックします。
  3. [DELETE] をクリックします。
  4. [Confirm] をクリックして操作を確定します。

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