My Applications (マイアプリケーション)

[My Applications (マイアプリケーション)]​ ページでは、API とのコントラクトを保持するアプリケーションのリストを確認できます。各クライアントアプリケーションには、クライアント ID、クライアントシークレット、説明、URL、リダイレクト URI、許可種別があります。

クライアント ID 適用ポリシーによって保護されている API では、クライアントアプリケーションはクライアント ID とクライアントシークレット (省略可能) を提供する必要があります。クライアントアプリケーションが登録されると、クライアント ID とクライアントシークレットのログイン情報が自動的に作成されます。アプリケーションの登録についての詳細は、​「API インスタンスへのアクセス権の要求」​を参照してください。

アプリケーションを検索する

[My Applications (マイアプリケーション)]​ ページに複数のアプリケーションがリストされている場合、検索ボックスを使用して特定のアプリケーションを検索します。アプリケーション名またはアプリケーションの説明を入力して、Enter キーまたは Return キーを押します。検索条件に一致するアプリケーションの数が検索結果のリストに表示されます。

クライアントログイン情報を表示およびコピーする

クライアントアプリケーションの詳細を表示するには、[My Applications (マイアプリケーション)] ページで、リストからアプリケーションをクリックして [Application Details (アプリケーション詳細)] ページを表示します。

クライアントログイン情報は次の方法で表示してコピーできます。

  • [My Applications (マイアプリケーション)] ページで ​[View credentials (ログイン情報を表示)]​ をクリックします。

  • クライアント ID またはクライアントシークレットをクリップボードにコピーするには、[Copy to clipboard (クリップボードにコピー)] アイコンをクリックします。

  • クライアントシークレットを表示するには、[Show Client Secret (クライアントシークレットを表示)] アイコンをクリックします。

  • クライアントシークレットを非表示にするには、[Hide Client Secret (クライアントシークレットを非表示)] アイコンをクリックします。

Application Details (アプリケーション詳細)

クライアントアプリケーションの詳細を表示するには、[My Applications (マイアプリケーション)] ページで、リストからアプリケーションをクリックして [Application Details (アプリケーション詳細)] ページを表示します。

アプリケーションに関する次の詳細を表示できます。

  • Application URL (アプリケーション URL)

    アプリケーションのインターネットアドレスが表示されます。リンクをクリックすると URL に移動します。

  • クライアントログイン情報

    アプリケーションのクライアント ID とクライアントシークレットが表示されます。

  • OAuth 2.0 Redirects URIs (OAuth 2.0 リダイレクト URI)

    アプリケーションのリダイレクト URI のリスト。

  • OAuth 2.0 Grant Type (OAuth 2.0 許可種別)

    アプリケーションの許可種別のリスト。

  • API Contracts (API コントラクト)

    [API contracts (API コントラクト)] セクションで、アプリケーションの API 参照名、環境およびインスタンス、インスタンス URL、SLA 層、アクセス権の要求の状態を確認できます。環境には、Sandbox または開発環境を指定できます。アクセス権の要求の状態には ​pending​、​approved​、または ​failed​ があります。

[Application Details (アプリケーション詳細)] ページでは次のことができます。

  • クライアントシークレットをリセットする。

  • クライアントアプリケーション詳細を編集する。

  • インスタンス URL を表示する。

  • SLA 層を追加する。

  • SLA 層を変更する。

  • クライアントアプリケーションを削除する。

クライアントシークレットをリセットする

アプリケーションのクライアントシークレットを定期的にリセットすることで、ユーザーが組織から去った場合のセキュリティを確保したり、シークレットが誤って権限を持たないユーザーに公開されるのを防止したりできます。

[Application Details (アプリケーション詳細)] ページでは、アプリケーションのクライアントシークレットをリセットできます。現在のクライアントシークレットを使用しているアプリケーションは、登録に使用された API にアクセスできなくなります。

クライアントシークレットをリセットする手順は、次のとおりです。

  1. [Client Credentials (クライアントログイン情報)]​ セクションで、​[Reset client secret (クライアントシークレットをリセット)]​ をクリックします。

  2. [Confirm (確認)]​ をクリックします。

  3. 新しいクライアントシークレットを表示するには、[View (表示)] アイコンをクリックします。

クライアントアプリケーション詳細を編集する

[Application Details (アプリケーション詳細)] ページで、クライアントアプリケーション名、説明、OAuth 2.0 許可種別、OAuth 2.0 リダイレクト URI、SLA 層を編集できます。

  1. [My Applications (マイアプリケーション)]​ セクションで、リスト内のアプリケーション名をクリックします。

  2. [Edit (編集)]​ をクリックします。

  3. [Application Details (アプリケーション詳細)]​ ページで、対応する項目を編集します。

  4. [Save (保存)]​ をクリックします。

インスタンス URL を表示およびコピーする

API のインスタンス URL を表示するには、​[View URL (URL を表示)]​ をクリックします。コピーするには、​[Copy from clipboard (クリップボードからコピー)]​ アイコンをクリックします。

SLA 層を追加する

SLA 層は API Manager で定義され、[Application Details (アプリケーション詳細)] ページに [SLA Tier (SLA 層)] オプションとして表示されます。アプリケーションで SLA 層が表示されない場合は、SLA 層を追加するように要求できます。インスタンスオーナーは層を承認する必要があります。

  1. [My Applications (マイアプリケーション)]​ セクションで、リスト内のアプリケーション名をクリックします。

  2. [API Contracts (API コントラクト)]​ セクションの ​[SLA Tier (SLA 層)]​ 列で、[+ Add (+ 追加)] をクリックします。

  3. [Add SLA Tier (SLA 層を追加)]​ リストで、層のリストから選択します。

  4. [Save (保存)]​ をクリックします。

    アクセス権の要求が承認されると、[Request Access State (アクセス権の要求の状態)] 列に [Approved (承認済み)] 状態が表示され、メンバーにメールが送信されます。

SLA 層を変更する

SLA 層では、アプリケーションで API に対して実行できる要求数を制限できます。許可される要求数は増やすことも減らすこともできます。[Application Details (アプリケーション詳細)] ページで、アプリケーションの SLA 層を変更できます。使用可能な SLA 層は管理者が API マネージャーで設定します。API インスタンスのオーナーは層レベルを変更する要求を承認する必要があります。

クライアントアプリケーションの SLA 層を編集する手順は、次のとおりです。

  1. [My Applications (マイアプリケーション)]​ ページで、リスト内のアプリケーションの名前をクリックします。

  2. 変更する ​[API Contracts (API コントラクト)]​ セクションの ​[SLA Tier (SLA 層)]​ 列で、SLA 層の編集オプションをクリックします。

  3. [Edit SLA Tier (SLA 層を編集)]​ ダイアログで、SLA 層のリストから選択します。

  4. [Save (保存)]​ をクリックします。

  5. [Okay (OK)]​ をクリックして、メッセージを閉じます。

クライアントアプリケーションを削除する

API のコントラクトが不要になった場合、削除できます。アプリケーションを削除すると、API とのコントラクトはなくなり、アクセスできなくなります。もう一度アクセスできるようにするには、再び API へのアクセス権を要求する必要があります。

クライアントアプリケーションを削除する手順は、次のとおりです。

  1. アプリケーションの ​[Application Details (アプリケーション詳細)]​ ページで、​[Delete (削除)]​ をクリックします。

  2. [Delete application (アプリケーションを削除)]​ メッセージで ​[Delete (削除)]​ をクリックします。

    アプリケーションが [My Applications (マイアプリケーション)] ページから削除されます。