Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

APIトークンの作成

API トークンには認証情報が含まれており、特定のユーザーまたは組織全体にバインドされます。APIトークンは、セキュリティを確保するために、ユーザーまたは組織に関する識別情報をAPIサーバーに送信して、ユーザーがAPIにアクセスできるかどうかを示します。

他の多くのAPIプロバイダと同様に、Juniper Mistには、認証用のAPIトークンを(HTTPヘッダーに)生成する方法が用意されています。トークンを検討する際、Juniper Mistでは トークンキー という用語は同じ意味で使用されます。

以下の特性は、ユーザー API トークンに関連しています。

  • API トークンは、割り当てられたユーザーのアカウント権限と同じ権限を引き受けます。

  • Juniper Mistは、90日間連続して使用されていないAPIトークンを自動的に削除します。

  • Juniper Mist APIの基本Uniform Resource Identifier(URI)は {api_endpoint}/api/v1/です。

    メモ:

    {api_endpoint} の代わりに、グローバルリージョンの API エンドポイントを使用する必要があります。 「API エンドポイントとグローバルリージョン」を参照してください。

Juniper Mistには、2種類のAPIトークンがあります。
  • 組織トークン

    • トークンは Mist 組織の下で保持されます。
    • トークンは特定のユーザーにバインドされていないため、アクセスは組織へのユーザーのアクセスに依存しません。
    • 異なる権限を持つことができる N 組織トークンをサポートします。
    • トークンは、その特定の組織に対してのみ使用できます。
    • レート制限は、個々のトークンによって行われます。たとえば、OrgToken1 が 5000 回の API 呼び出しを消費し、レート制限に達した場合、OrgToken2 は影響を受けません。
  • ユーザートークン

    • トークンは特定のユーザー アカウントに保持されます。
    • トークンは特定のユーザーにバインドされるため、アクセスは組織へのユーザーのアクセスと直接相関します。
    • トークンは、ユーザーがアクセスできる任意のマネージド サービス プロバイダー (MSP) または組織に使用できます。
    • ユーザー アカウントと同じ特権を持つ N 個のトークンをサポートします。
    • レート制限は、ユーザーに関連付けられているアカウントによって行われます。たとえば、UserToken1 が 5000 回の API 呼び出しを消費し、レート制限に達した場合、GUI への UserToken2 とアカウント ログインが影響を受けます。

組織トークンの作成

  1. Juniper Mistポータルの左側のメニューから、[組織]>[設定]に移動します。
  2. [API トークン] セクションまで下にスクロールし、[トークンの作成] をクリックします。
  3. トークンのアクセス許可を定義します。

  4. [生成] をクリックします。
    • [生成] をクリックすると、ウィンドウの上部に、キーを保存する必要があることを知らせるメッセージが表示されます。

  5. [キー] フィールドの横にあるコピー ボタンをクリックしてキーをコピーし、安全に保管できるようにどこかに保管します。
    メモ:

    切り捨てられていないキー全体が表示されるのは、作成時だけです。完全なキーを二度と表示することはできません。キーを置き忘れた場合は、新しいキーを作成する必要があります。

  6. ウィンドウの下部にある [完了] をクリックします。
  7. ページの右上隅にある [保存] をクリックします。

REST API エクスプローラーを使用したユーザートークンの作成

  1. Juniper Mistポータルにログインします(REST API Explorerを使用する前に、Mistポータルにログインしている必要があります)。
  2. 新しいブラウザー ウィンドウを開き、REST API エクスプローラーに URL を貼り付けます。 {api_endpoint}/api/v1/self/apitokens
    メモ:

    {api_endpoint} の代わりに、グローバルリージョンの API エンドポイントを使用する必要があります。 「API エンドポイントとグローバルリージョン」を参照してください。

    REST API Explorer は、トークンを制御するための API ページです。ここでは、トークンとトークン情報を作成、読み取り、更新、および削除できます。このページには、最初に、作成済みのトークンが表示されます。

    このページでは、自分や他のユーザーがブラウザーから直接 API 呼び出しを行うこともできます。 [メディアの種類: アプリケーション/json ] が既に既定として選択されている場合、トークンの一覧を表示するために GET 要求が実行されます。切り捨てられたキーは、以前に作成されたトークンに対して表示されます。

  3. [POST] ボタンをクリックしてトークンを作成します。

    メモ:

    Juniper Mist APIは、キーの作成後、実際のトークン(キー)をどこにも完全に表示することはありません。このページから離れて戻ってくると、キーは切り捨てられたバージョンで表示されます。このキーはパスワードとして扱い、安全な場所に保管する必要があります。このキーを紛失した場合は、新しいキーを作成する必要があります。

    受信した応答は、次の例のようになります。