API トークンの作成
API トークンには認証情報が含まれており、特定のユーザーまたは組織全体にバインドされます。APIトークンは、セキュリティを確保するために、ユーザーまたは組織に関する識別情報をAPIサーバーに送信して、ユーザーがAPIにアクセスできるかどうかを示します。
他の多くのAPIプロバイダと同様に、Juniper Mistには、認証用のAPIトークンを(HTTPヘッダーに)生成する方法が用意されています。トークンを検討する際、Juniper Mistでは トークン と キー という用語は同じ意味で使用されます。
以下の特性は、ユーザー API トークンに関連しています。
-
API トークンは、割り当てられたユーザーのアカウント権限と同じ権限を引き受けます。
-
Juniper Mistは、90日間連続して使用されていないAPIトークンを自動的に削除します。
-
Juniper Mist APIの基本URI(Uniform Resource Identifier)は
{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 とアカウント ログインが影響を受けます。