Docs Menu
Docs Home
/ /
Atlas CLI
/ /

Atlas ユーザーの招待

項目一覧

  • 構文
  • オプション
  • 継承されたオプション
  • 出力

Atlas userアプリケーション用のMongoDB Atlas を作成し、そのAtlas user を組織とプロジェクトに招待します。

Atlas userアカウントは、 MongoDB Atlasアプリケーションへのアクセスのみを許可します。 データベースへのアクセスを許可するには、 Atlas dbusers create を使用してデータベースユーザーを作成します。

コマンド構文
atlas users invite [options]
名前
タイプ
必須
説明
--country
string
true
ユーザーの地理的位置の ISO 3166-1 アルファベット 2 文字の国コード。 Atlas CLI ではこのオプションが必要です。
--email
string
true
ユーザーのメールアドレス。
--firstName
string
true
ユーザーの名。
-h, --help
false
招待のヘルプ
--lastName
string
true
ユーザーの姓。
-- mobile
string
false
ユーザーの携帯電話番号。
--orgRole
string
false
組織、コロン、および組織内のユーザーのロールを識別する一意な 24 桁のstring 。 この値は orgID:ROLE として指定します。 ROLE の有効な値は、ORG_OWNER、ORG_MEMBER、ORG_GROUP_CREATOR、ORG_BILLING_ADMIN、ORG_READ_ONLY などです。
-o, --output
string
false
出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。
--password
string
false
ユーザーのパスワード。
--projectRole
string
false
プロジェクト、コロン、およびプロジェクトにおけるユーザーのロールを識別する一意の 24 桁のstring 。 この値は projectID:ROLE として指定します。 ROLE の有効な値は、GROUP_CLUSTER_MANAGER、GROUP_DATA_ACCESS_ADMIN、GROUP_DATA_ACCESS_READ_ONLY、GROUP_DATA_ACCESS_READ_WRITE、GROUP_OWNER、GROUP_READ_ONLY です。
--username
string
true
ユーザーを識別する名前。 有効なメール アドレスを指定する必要があります。
名前
タイプ
必須
説明
-P, --profile
string
false
構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルについては、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。

コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。

The user '<Username>' has been invited.
Invited users do not have access to the project until they accept the invitation.
# Create the Atlas user with the username user@example.com and invite them to the organization with the ID 5dd56c847a3e5a1f363d424d with ORG_OWNER access:
atlas users invite --email user@example.com --username user@example.com --orgRole 5dd56c847a3e5a1f363d424d:ORG_OWNER --firstName Example --lastName User --country US --output json
# Create the Atlas user with the username user@example.com and invite them to the project with the ID 5f71e5255afec75a3d0f96dc with GROUP_READ_ONLY access:
atlas users invite --email user@example.com --username user@example.com --projectRole 5f71e5255afec75a3d0f96dc:GROUP_READ_ONLY --firstName Example --lastName User --country US --output json

戻る

describe