Docs Menu
Docs Home
/
Atlas
/ /

Atlas Administration API 認証

Atlas Administration APIへの認証には、次の 2 つの方法のいずれかを使用できます。

サービス アカウント
API キー

業界標準の OAuth 2.0 プロトコルを クライアント認証情報フローと併用する Atlas で認証を受ける新たな方法。

HTTPダイジェスト認証を使用する Atlas へのレガシー認証方法。

サービス アカウントを使用すると、権限を管理し、アクセス トークンを作成できます。サービス アカウントには、アクセス トークンを作成するためのユーザー名とパスワードとして機能するクライアントIDとシークレットがあります。アクセス トークンを使用すると、は Atlas へのAPIリクエストを行うことができます

APIキーには、公開キーと秘密キーの 2 つの部分があります。この 2 つの部分が、Atlas にAPIリクエストを行う際に、ユーザー名およびパスワードと同じ機能を果たします。

サービスアカウントを作成したら、そのクライアント ID とシークレットを使用してアクセス トークンを生成し、API リクエストを認証します。アクセス トークンは、OAuth 2.0 仕様に従って 1 時間(3600 秒)のみ有効です。アクセス トークンの有効期限が切れると、漏洩したアクセス トークンを時間制限なく使用できるようなリプレイ攻撃を防ぐことができます。

Atlas は、ナンスと呼ばれる一意の値を使用して公開キーと秘密キーをハッシュします。ナンスは HTTP ダイジェスト認証仕様に従って、短期間のみ有効です。これはリプレイ攻撃を防ぐためのもので、ナンスをキャッシュして永久に使用することはできません。

Atlas のロールは、サービスアカウントがアクセス トークンを使用して実行できる操作を制限します。アクセス トークンがエラーなしで API エンドポイントを呼び出せるように、ユーザーの場合と同様にサービスアカウントにロールを付与する必要があります。

Atlas ロールは、API キーが実行できる操作を制限します。API キーで、エラーなく API エンドポイントを呼び出せるようにするには、ユーザーの場合と同様に API キーにロールを付与する必要があります。

Atlas は多くのリソースをプロジェクトにバインドします。多くの API リソース URL/api/atlas/<version>/groups/<GROUP-ID>/ の形式に従います。ここで、<GROUP-ID>プロジェクト ID を指します。これらのリソース用のサービス アカウントはプロジェクトをホストする組織のノードでなければなりません。それ以外の場合、Atlas は 401 エラーで応答します。組織レベルのサービス アカウントにプロジェクトへのアクセス権を付与するには、「プロジェクトへの既存の組織アクセス権の割り当て」を参照してください。

Atlas は多くのリソースをプロジェクトにバインドします。多くの API リソース URL/api/atlas/<version>/groups/<GROUP-ID>/ の形式に従います。ここで、<GROUP-ID>プロジェクト ID を指します。これらのリソース用の API キーはプロジェクトをホストする組織のノードでなければなりません。それ以外の場合、Atlas は 401 エラーで応答します。組織レベルの API キーにプロジェクトへのアクセス権を付与するには、「プロジェクトへの既存の組織アクセス権の割り当て」を参照してください。

各サービスアカウントは 1 つの組織のみに属しますが、その組織内の任意の数のプロジェクトへのアクセスをサービスアカウントに許可できます。

API キーは 1 つの組織のみに属しますが、その組織内の任意の数のプロジェクトに API キーによるアクセスを許可できます。

サービスアカウントまたはそのアクセス トークンを使用して、Atlas UI から Atlas にログインすることはできません。

API キーを使用して Atlas UI 経由で Atlas にログインすることはできません。

Atlas Administration APIへの認証に希望する方法を設定するには、「 組織へのプログラムによるアクセスの付与 」を参照してください。

Tip

戻る

Admin API Overview