mongocli IAM 組織の招待状の招待
指定された MongoDB ユーザーを組織に招待します。
このコマンドを使用するには、ユーザー アカウントまたは組織ユーザー管理者ロールの API キーで認証する必要があります。
構文
コマンド構文
mongocli iam organizations invitations invite <email> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
メールアドレス | string | true | 組織に招待するユーザーのメールアドレス。 |
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-h, --help | false | 招待のヘルプ | |
--orgId | string | false | 使用する組織ID。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--role | string | true | 関連付けられている組織のユーザーのロール。 MCLI が受け入れる値については、Atlas API 仕様のロールのアイテム列挙型 https://www.mongodb.com/ja-jp/docs/atlas/reference/api-resources-spec/#operation/createOrganizationInvitation/ )を参照してください。 |
--teamId | string | false | チームを識別する一意な 24 桁のstring 。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 MongoCLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-configuration-file を参照してください。 |
例
# Invite the MongoDB user with the email user@example.com to the organization with the ID 5f71e5255afec75a3d0f96dc with ORG_OWNER access: mongocli iam organizations invitations invite user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json