mongocli IAM 組織の招待状の更新
組織への指定した保留中の招待の詳細を変更します。
招待を指定するには、招待IDまたはユーザーのメールアドレスを使用します。
このコマンドを使用するには、ユーザー アカウントまたは組織所有者ロールを持つ API キーで認証する必要があります。
構文
コマンド構文
mongocli iam organizations invitations update [invitationId] [options]
Arguments
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
招待ID | string | false | 招待を識別する一意な 24 桁のstring 。 |
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
--email | string | false | ユーザーのメールアドレス。 |
-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/ )を参照してください。 このフラグを渡すと、既存のデータが置き換えられます。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 MongoCLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-configuration-file を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Invitation <ID> updated.
例
# Modify the pending invitation with the ID 5dd56c847a3e5a1f363d424d to grant ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc: mongocli iam organizations invitations update 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json
# Modify the invitation for the user with the email address user@example.com to grant ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc: mongocli iam organizations invitations update --email user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json