接続方法の選択
Atlas CLI から既存の Atlas アカウントに接続する場合、atlas auth login コマンドの次のいずれかのオプションを使用して認証できます。
オプション | 認証方法 | ユースケース |
|---|---|---|
| Atlas のログイン認証情報と認証トークン | 非プログラムの使用に最適 |
| サービス アカウント | サービス アカウントのプログラムによる使用に最適 |
| APIキー | APIキーを使用したプログラムとしての使用に最適 |
重要
Atlas CLI の 1.47 以前のバージョンの場合、API キーは、Atlas CLI の構成ファイル内にプレーンテキストで保存されます。あなたの API キーはパスワードと同じようなものです。構成ファイルを正しく保護するようにしてください。Atlas CLI 1.47+ は、認証情報を安全に保存するために + 回の試行を行います。
新しい Atlas アカウントを作成するか、クラスターを持たない既存のアカウントにオンボードする方法については、「 Atlas を使い始める 」を参照してください。
使用可能な接続オプションの詳細については、以下のユースケースを選択してください。
atlas auth login コマンドに UserAccount オプションを付けて使用し、Atlas ログイン認証情報およびワンタイム認証トークンを使用して認証します。UserAccount オプションでは、手動でのログインと認証トークンの検証が必要です。このトークンは 12 時間有効です。API キーは、UserAccount オプションを使用して接続する場合は任意です。
UserAccount オプションを指定して atlas auth login を実行すると、次のことが可能になります。
Connect with minimum required settings and specify the
--projectIdand--orgIdflags with each command. This is the quickest way to get started for first-time login.
ServiceAccounts オプションを使用して atlas auth login コマンドを実行すると、Atlas CLI はクライアントIDとシークレットを入力するように要求します。ServiceAccounts オプションは、MongoDBリソースを自動化および管理できるため、プログラムとしての使用に適しています。サービス アカウントは OAuth アプリケーションとも呼ばれますが、指定された安全なクライアントIDとシークレットを介してプログラムによるアクセスを許可します。この方法は、ユースケースのスクリプト化や継続的統合または配信ワークフローに適しています。
注意
このプロセスは対話的です。プログラムによる認証の場合は、{{atlas-cli+} を使用する前に、MONGODB_ATLAS_CLIENT_ID と MONGODB_ATLAS_CLIENT_SECRET の環境変数を設定します。サポートされているすべての環境変数の詳細については、Atlas CLI 環境変数を参照してください。
このコマンドで認証するには、 API キーを設定する必要があります。
atlas auth login コマンドを APIKeys オプションとともに実行すると、Atlas CLI は、API キーの入力を促します。そして、API キーを保存するプロファイルを自動的に作成します。APIKeys オプションは、手動でログインしたり、トークンを確認したりする必要がないため、プログラムによる使用に適しています。
atlas auth login コマンドを APIKeys オプションとともに使用して接続すると、次のことが可能になります。
Connect with minimum required settings and specify the
--projectIdand--orgIdflags with each command. This is the quickest way to get started for first-time login.
必要最小限の設定で接続する
ユースケースを選択し、必要最小限の設定で Atlas CLI から接続する手順に従ってください。
前提条件を完了する
Add your host's IP address to the IP access list.
If you authenticate with your Atlas user credentials and your organization's owners enable IP access list for the Atlas UI for an organization, your IP address must be added to the IP access list to run commands in this organization. To learn more, see Require IP Access List for the Atlas UI.
始める前に、以下のものがあることを確認してください。
Atlas CLI がインストールされました。
アクティブな Atlas組織。
A Service Account created and configured. To learn more, see Grant Programmatic Access to an Organization.
クライアント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
次のステップへ進む
デフォルトのプロファイルを変更して接続設定を保存するか、別のプロファイルを作成するには、 「 接続設定を保存する 」を参照してください。