接続方法の選択
Atlas CLI から既存の Atlas アカウントに接続する場合、atlas auth login コマンドの次のいずれかのオプションを使用して認証できます。
オプション | 認証方法 | ユースケース |
|---|---|---|
| Atlas のログイン認証情報と認証トークン | 非プログラムの使用に最適 |
| サービス アカウント | サービス アカウントのプログラムによる使用に最適 |
| APIキー | APIキーを使用したプログラムとしての使用に最適 |
重要
より前の Atlas CLI1.47 バージョンの場合、 APIキーは Atlas CLI構成ファイルにプレーンテキストで保存されます。 APIキーはパスワードのようなものです。構成ファイルが適切に保護されていることを確認してください。 Atlas CLI1.47 + は、認証情報を安全に保存しようとします。
新しい Atlas アカウントを作成するか、クラスターを持たない既存のアカウントにオンボードする方法については、「 Atlas を使い始める 」を参照してください。
使用可能な接続オプションの詳細については、以下のユースケースを選択してください。
atlas auth loginUserAccountAtlas ログイン認証情報と 1 回限りの認証トークンで認証するには、UserAccount コマンドを オプションと併用します。12 オプションでは、手動によるログインと認証トークンの検証が必要になります。このトークンは 時間有効です。 オプションで接続する場合、UserAccount APIキーは任意です。
UserAccount オプションを指定して atlas auth login を実行すると、次のことが可能になります。
必要最小限の設定で接続し
--projectId--orgId、各コマンドで フラグと フラグを指定します。これが、初めてログインを開始する最も簡単な方法です。接続設定をプロファイルに保存します。 プロファイルには、プロジェクト ID、組織 ID、および任意で、今後の Atlas CLI セッションで使用するAPIキーが保存されます。 時間を節約するには、各コマンドで
--projectIdと--orgIdフラグを使用する代わりにプロファイルを指定します。
ServiceAccounts オプションを使用して atlas auth login コマンドを実行すると、Atlas CLI はクライアントIDとシークレットを入力するように要求します。 ServiceAccounts オプションは、 MongoDBリソースを自動化および管理できるため、プログラムとしての使用に適しています。サービス アカウントは OAuth アプリケーションとも呼ばれますが、指定された安全なクライアントIDとシークレットを介してプログラムによるアクセスを許可します。この方法は、ユースケースのスクリプト化や継続的統合または配信ワークフローに適しています。
注意
このプロセスは対話的です。プログラムによる認証の場合は、{{atlas-cli+} を使用する前に、 と の環境変数を設定します。サポートされているすべての環境変数の詳細については、「 Atlas CLIMONGODB_ATLAS_CLIENT_IDMONGODB_ATLAS_CLIENT_SECRET 環境変数 」を参照してください。
このコマンドで認証するには、 API キーを設定する必要があります。
atlas auth loginオプションを指定してAPIKeys コマンドを実行すると、Atlas CLI はAPIキーの入力を要求し、 APIキーを保存するプロファイルを自動的に作成します。APIKeys オプションは、手動ログインやトークン検証を必要としないため、プログラムとして使用するのに適しています。
atlas auth login コマンドを APIKeys オプションとともに使用して接続すると、次のことが可能になります。
必要最小限の設定で接続し
--projectId--orgId、各コマンドで フラグと フラグを指定します。これが、初めてログインを開始する最も簡単な方法です。追加の接続設定をプロファイルに保存します。 プロファイルには、プロジェクト ID、組織 ID、および任意で、今後の Atlas CLI セッションで使用するAPIキーが保存されます。 時間を節約するには、各コマンドで
--projectIdと--orgIdフラグを使用する代わりにプロファイルを指定します。
必要最小限の設定で接続する
ユースケースを選択し、必要最小限の設定で Atlas CLI から接続する手順に従ってください。
前提条件を完了する
ホストの IP アドレスをIP アクセス リストに追加します。
Atlas user認証情報を使用して認証し、組織の所有者がIP 組織のAtlas UI の アクセス リストを IPIP有効にする 場合、この組織でコマンドを実行するには、 アドレスを アクセス リストに追加する必要があります。詳細については、「 Atlas UI の IP アクセス リストが必要 」を参照してください。
始める前に、以下のものがあることを確認してください。
アクティブな Atlas組織。
サービス アカウントが作成および構成されました。詳細については、「 組織へのプログラムによるアクセスの付与 」を参照してください。
クライアントIDとサービス アカウントのシークレット。
実行手順
ユースケースを選択し、手順に従ってAtlas CLI から迅速に接続します。
Atlas CLI に戻り、デフォルトのプロファイル オプションを受け入れます。
ターミナルに戻ります。 正常に接続すると、というメッセージが表示されます。
Successfully logged in as {Your Email Address}.
次のオプションが表示されている場合は、 Enterを押してデフォルトのプロファイル構成を受け入れます。
Default Org IDDefault Project IDDefault Output FormatDefault MongoDB Shell Path
重要
以前に MongoCLI のAPIキーを使用してプロファイルを設定した場合、プロファイルは自動的に 移行されます。 一部の移行済みプロファイルでは、 atlas auth loginで認証中に Atlas CLI コマンドが失敗する可能性があります。 競合が発生した場合にatlas auth loginを実行すると、次のメッセージが表示されます。
There was an error fetching your organizations: Global user is from outside access listed subnets.
競合を修正するには、構成ファイルを開き、デフォルトのプロファイルを削除して、 atlas auth loginを再度実行します。
--projectIdと--orgId フラグを使用して コマンドを発行します。
Atlas CLI セッション中にAtlas CLI コマンドを実行するときは、 --projectIdと--orgIdフラグを使用してプロジェクト ID と組織 ID を指定します。
例
atlas alerts list --projectId 60b3c81153cf986293e2608b
--projectIdと--orgId フラグを使用して コマンドを発行します。
Atlas CLI セッション中にAtlas CLI コマンドを実行するときは、 --projectIdと--orgIdフラグを使用してプロジェクト ID と組織 ID を指定します。
例
atlas alerts list --projectId 60b3c81153cf986293e2608b
--projectIdと--orgId フラグを使用して コマンドを発行します。
Atlas CLI セッション中にAtlas CLI コマンドを実行するときは、 --projectIdと--orgIdフラグを使用してプロジェクト ID と組織 ID を指定します。
例
atlas alerts list --projectId 60b3c81153cf986293e2608b
次のステップへ進む
デフォルトのプロファイルを変更して接続設定を保存するか、別のプロファイルを作成するには、 「 接続設定を保存する 」を参照してください。