AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

ユーザーを 1 人作成

注意

グループとプロジェクトは同義期間です。あなたの {PROJECT-ID} はグループ ID と同じです。既存のグループの場合、グループ/プロジェクトID は同じままです。このページでは、説明を参照するときに、より一般的な期間のグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。

新しいユーザーを作成します。 デフォルトでは、ペイロード内の非グローバルの組織とプロジェクト ロールは、最初に組織またはプロジェクトへの招待をユーザーに送信します。

Resource

ベース URL: https://cloud.mongodb.com/api/public/v1.0

POST /users

リクエスト パス パラメーター

このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。

リクエスト クエリ パラメータ

次のクエリ パラメータは 任意です。

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

レスポンス本体をpretty-print形式にするかどうかを示すフラグ。

false

envelope

ブール値

任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。

1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。

  • status: HTTPレスポンス コード

  • content: 期待される応答本体

false

リクエスト ボディ パラメータ

すべてのフィールドが必須です。

名前
タイプ
説明

username

string

Cloud Manager ユーザーのユーザー名。 有効なメールアドレスである必要があります。

パスワード

string

Cloud Manager ユーザーのパスワード。

このフィールドは、サーバーから返されるエンティティには含まれていません。 新しいユーザーを作成するときにのみ、 エンティティ本体で送信できます。

メールアドレス

string

Cloud Manager ユーザーのメールアドレス。

mobileNumber

string

Cloud Manager ユーザーの携帯電話番号。

名

string

Cloud Manager ユーザーの名。

姓

string

Cloud Manager ユーザーの姓。

国

string

Cloud Managerユーザーが存在するプライマリ国。2 文字の ISO 3661-1 国コードと一致する必要があります。

役割

オブジェクト配列

Cloud Manager ユーザーのロール割り当て。

role.orgId

string

Cloud Manager ユーザーが指定されたロールを持つ組織の一意の識別子。

role.groupId

string

Cloud Manager ユーザーが指定されたロールを持つグループの一意の識別子。

role.roleName

string

ロールの名前。 指定できる値は以下のとおりです。

応答

JSON document には、次の各要素が含まれています。

Name
タイプ
説明

emailAddress

string

Cloud Manager ユーザーのメールアドレス。

firstName

string

Cloud Manager ユーザーの名。

id

string

Cloud Manager ユーザーの一意の識別子です。

lastName

string

Cloud Manager ユーザーの姓。

links

オブジェクト配列

関連するサブリソースへのリンク。レスポンス内のすべての links 配列には、self と呼ばれるリンクが少なくとも 1 つ含まれています。Web Linking Specification では、これらの関係について説明しています。

mobileNumber

string

Cloud Manager ユーザーのモバイル番号。

roles

空の配列

Cloud Manager ユーザーに割り当てられたロール。

roles
.groupId

string

ユーザーが指定されたロールを持つプロジェクトのユニーク識別子。

roles
.orgId

string

ユーザーが指定されたロールを持つ組織の一意の ID。

roles
.roleName

string

ロールの名前。users リソースは、Cloud Manager と MongoDB Atlas でユーザーが持っているすべてのロールを返します。

指定できる値は次のとおりです。

username

string

Cloud Manager ユーザーのユーザー名。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \     --header "Accept: application/json" \     --header "Content-Type: application/json" \     --include \     --request POST "https://cloud.mongodb.com/api/public/v1.0/users" \     --data '       {         "username": "jane.doe@mongodb.com",         "emailAddress": "jane.doe@mongodb.com",         "firstName": "Jane",         "lastName": "Doe",         "password": "M0ng0D8!:)",         "country" : "US",         "roles": [{           "groupId": "533daa30879bb2da07807696",           "roleName": "GROUP_USER_ADMIN"         },{           "orgId" : "55555bbe3bd5253aea2d9b16",           "roleName" : "ORG_MEMBER"         }]       }'

応答例

応答ヘッダー

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 201 CreatedVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

{  "id" : "533dc19ce4b00835ff81e2eb",  "username" : "jane.doe@mongodb.com",  "emailAddress" : "jane.doe@mongodb.com",  "firstName" : "Jane",  "lastName" : "Doe",  "roles" : [],  "links" : []}
戻る
ユーザー
次へ
IDで取得
このページを評価

項目一覧