Docs Menu
Docs Home
/
MongoDB Cloud Manager
/ / / /

ユーザーを 1 人作成

項目一覧

  • Resource
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答
  • リクエストの例
  • 応答例
  • 応答ヘッダー
  • レスポンス本体

注意

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

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

ベース URL: https://cloud.mongodb.com/api/public/v 1.0

POST /users

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

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

名前
タイプ
必要性
説明
default

pretty

ブール値

任意

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 文字の ISO3661 -1 に一致する必要があります 国コード。

役割

オブジェクト配列

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

role.orgId

string

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

role.groupId

string

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

role.roleName

string

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

説明

ORG_MEMBER

ORG_READ_ONLY

ORG_BILLING_ADMIN

ORG_GROUP_CREATOR

ORG_OWNER

GROUP_ATLAS_ADMIN

Project Admin (Atlas)

GROUP_AUTOMATION_ADMIN

GROUP_BACKUP_ADMIN

GROUP_MONITORING_ADMIN

GROUP_OWNER

GROUP_READ_ONLY

GROUP_USER_ADMIN

GROUP_BILLING_ADMIN

プロジェクト請求管理者

GROUP_DATA_ACCESS_ADMIN

GROUP_DATA_ACCESS_READ_ONLY

GROUP_DATA_ACCESS_READ_WRITE

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

Name
タイプ
説明

emailAddress

string

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

firstName

string

Cloud Manager ユーザーの名。

id

string

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

lastName

string

Cloud Manager ユーザーの姓。

links

オブジェクト配列

関連するサブリソース へのリンク。 応答内のすべてのlinks配列には、自己と呼ばれるリンクが少なくとも 1 つ含まれています。 URL の関係は、 Web リンク仕様 で説明されています。

mobileNumber

string

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

roles

空の配列

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

roles
.groupId

string

指定されたロールを持つユーザーを持つプロジェクトの一意の識別子です。

roles
.orgId

string

指定されたロールを持つユーザーが所属する組織の一意の識別子です。

roles
.roleName

string

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

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

説明

ORG_MEMBER

ORG_READ_ONLY

ORG_BILLING_ADMIN

Organization Billing Admin

ORG_GROUP_CREATOR

ORG_OWNER

GROUP_AUTOMATION_ADMIN

GROUP_BACKUP_ADMIN

GROUP_MONITORING_ADMIN

GROUP_OWNER

GROUP_READ_ONLY

GROUP_USER_ADMIN

GROUP_DATA_ACCESS_ADMIN

GROUP_DATA_ACCESS_READ_ONLY

GROUP_DATA_ACCESS_READ_WRITE

username

string

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

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --include \
5 --request POST "https://cloud.mongodb.com/api/public/v1.0/users" \
6 --data '
7 {
8 "username": "jane.doe@mongodb.com",
9 "emailAddress": "jane.doe@mongodb.com",
10 "firstName": "Jane",
11 "lastName": "Doe",
12 "password": "M0ng0D8!:)",
13 "country" : "US",
14 "roles": [{
15 "groupId": "533daa30879bb2da07807696",
16 "roleName": "GROUP_USER_ADMIN"
17 },{
18 "orgId" : "55555bbe3bd5253aea2d9b16",
19 "roleName" : "ORG_MEMBER"
20 }]
21 }'
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 201 Created
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-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" : []
}

戻る

ユーザー