Atlas プロジェクトの招待状
指定された MongoDB ユーザーをプロジェクトに招待します。
このコマンドを使用するには、プロジェクト ユーザー管理者ロールのユーザー アカウントまたは API キーで認証する必要があります。
構文
atlas projects invitations invite <email> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
メールアドレス | string | true | プロジェクトに招待するユーザーのメール アドレス。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-h, --help | false | 招待のヘルプ | |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
--role | string | true | 関連付けられているプロジェクトに対するユーザーのロール。 有効な値は、GROUP_CLUSTER_MANAGER、GROUP_DATA_ACCESS_ADMIN、GROUP_DATA_ACCESS_READ_ONLY、GROUP_DATA_ACCESS_READ_WRITE、GROUP_OWNER、GROUP_READ_ONLY。 |
--teamId | string | false | チームを識別する一意な 24 桁のstring 。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルについては、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
User '<Username>' invited.
例
# Invite the MongoDB user with the email user@example.com to the project with the ID 5f71e5255afec75a3d0f96dc with GROUP_READ_ONLY access: atlas projects invitations invite user@example.com --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json