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にアクセスできるかどうかを示し、セキュリティを確保します。

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

Juniper Mistには、API トークンには 2 つのタイプがあります。
  • 組織トークン

    組織トークンは、組織の作業を自動化するアプリケーションを構築する場合に便利です。複数のユーザーがアプリケーションにアクセスする必要があるため、認証に同じ組織トークンを使用します。

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

    ユーザー トークンは、スクリプトを実行するときなど、自分自身で認証する必要がある場合に便利です。

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

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

APIトークンは、MistポータルまたはREST API Explorerを使用して作成できます。

Mistポータルで組織トークンを作成するCreate an Organization Token in the Portal

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

  4. 生成」をクリックします。
  5. キー」フィールドの横にあるコピー・ボタンをクリックし、保管のためにどこかに保管します。
    手記:

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

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

Mistポータルでユーザートークンを作成する

API ユーザー トークンは、Mist ポータルの [マイ アカウント] ページから生成できます。

APIユーザートークンを生成するには:

  1. Juniper Mist ポータルの右上隅にある [Juniper Mist アカウント] アイコンをクリックし、[マイ アカウント] をクリックします。
  2. 「APIトークン」セクションで、「トークンの作成」をクリックします。組織でシングルサインオンを有効にしている場合、APIユーザートークンを作成することはできません。
  3. トークンの名前を入力し、「生成」をクリックします。生成されたキーはユーザー API トークンです。
  4. キー」フィールドの横にあるコピーボタンをクリックします。

    完全なキーを再び見ることができないため、保管のためにキーをどこかに保管してください。キーを置き忘れた場合は、新しいキーを作成する必要があります。

  5. 完了」をクリックします。
    手記:

    ユーザー・トークンを削除する必要がある場合は、「 マイ・プロファイル 」ページの「APIトークン」セクションでトークンをクリックし、「トークンの編集」ページで 「削除 」をクリックします。

REST API Explorer を使用したユーザーまたは組織のトークンの作成

  1. Juniper Mist ポータルにログインします。
    手記:

    REST API Explorer を使用するには、ポータルにログインする必要があります。

  2. 新しいブラウザウィンドウを開き、URLを貼り付けます:{api-host}/api/v1/self/apitokens
    手記:

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

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

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

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

    応答は次の例のようになります。

  4. キー(トークン)をコピーし、保管のために保管します。
    手記:

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