Atlas 組織の招待状

項目一覧

構文

Arguments
オプション
継承されたオプション
出力
例

指定された MongoDB ユーザーを組織に招待します。

このコマンドを使用するには、ユーザーアカウントまたは組織ユーザー管理者ロールの API キーで認証する必要があります。

構文

コマンド構文

atlas organizations invitations invite <email> [options]

Arguments

名前	タイプ	必須	説明
メールアドレス	string	true	組織に招待するユーザーのメールアドレス。

オプション

名前	タイプ	必須	説明
-f, --file	string	false	招待設定を定義する任意のJSON構成ファイルへのパス。 Atlas CLI の招待構成ファイルの詳細については、「 https://XXX 」を参照してください。 -- role、 -- teamId と相互に排他的です。
-h, --help		false	招待のヘルプ
--orgId	string	false	使用する組織ID。このオプションは、構成ファイルまたは環境変数の設定を上書きします。
-o, --output	string	false	出力形式。有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。完全な出力を表示するには、 -o JSONオプションを使用します。
--role	string	false	関連付けられている組織のユーザーのロール。有効な値は、ORG_OWNER、ORG_MEMBER、ORG_GROUP_CREATOR、ORG_BILLING_ADMIN、ORG_READ_ONLY などです。 --file と相互に排他的。
--teamId	string	false	チームを識別する一意な 24 桁のstring 。 --file と相互に排他的。

継承されたオプション

名前	タイプ	必須	説明
-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 organization with the ID 5f71e5255afec75a3d0f96dc with ORG_OWNER access:
atlas organizations invitations invite user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json

戻る

describe

list