ユーザーを 1 人作成
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
新しいユーザーを作成します。 デフォルトでは、ペイロード内の非グローバルの組織とプロジェクト ロールは、最初に組織またはプロジェクトへの招待をユーザーに送信します。 ユーザーを組織またはプロジェクトに直接追加できるのは、 mms.user.bypassInviteForExistingUsersの設定をtrueに設定している場合のみです。
Resource
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
POST /users
リクエスト パス パラメーター
このエンドポイントは、HTTP リクエスト パス パラメーターを使用しません。
リクエスト クエリ パラメータ
次のクエリ パラメータは 任意です。
名前 | タイプ | 必要性 | 説明 | default | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 |
| ||||||
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。
|
|
リクエスト ボディ パラメータ
すべてのフィールドが必須です。
名前 | タイプ | 説明 | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
username | string | MongoDB Ops Manager ユーザーのユーザー名。
詳細については、「 | ||||||||||||||||||||||||||||||||||||||||
パスワード | string | MongoDB Ops Manager ユーザーのパスワード。 このフィールドは、サーバーから返されるエンティティには含まれていません。 新しいユーザーを作成するときにのみ、 エンティティ本体で送信できます。 | ||||||||||||||||||||||||||||||||||||||||
メールアドレス | string | MongoDB Ops Manager ユーザーのメールアドレス。 | ||||||||||||||||||||||||||||||||||||||||
mobileNumber | string | MongoDB Ops Manager ユーザーの携帯電話番号。 | ||||||||||||||||||||||||||||||||||||||||
名 | string | MongoDB Ops Manager ユーザーの名。 | ||||||||||||||||||||||||||||||||||||||||
姓 | string | MongoDB Ops Manager ユーザーの姓。 | ||||||||||||||||||||||||||||||||||||||||
役割 | オブジェクト配列 | MongoDB Ops Manager ユーザーのロール割り当て。 | ||||||||||||||||||||||||||||||||||||||||
role.orgId | string | MongoDB Ops Manager ユーザーが指定されたロールを持つ組織の一意の識別子。 | ||||||||||||||||||||||||||||||||||||||||
role.groupId | string | MongoDB Ops Manager ユーザーが指定されたロールを持つグループの一意の識別子。 「グローバル」ロール（名前が | ||||||||||||||||||||||||||||||||||||||||
role.roleName | string | ロールの名前。 指定できる値は以下のとおりです。
|
応答
JSON document には、次の各要素が含まれています。
Name | タイプ | 説明 | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | MongoDB Ops Manager ユーザーのメールアドレス。 | ||||||||||||||||||||||||||||||||||||||||
| string | MongoDB Ops Manager ユーザーの名。 | ||||||||||||||||||||||||||||||||||||||||
| string | MongoDB Ops Manager ユーザーの一意の識別子です。 | ||||||||||||||||||||||||||||||||||||||||
| string | MongoDB Ops Manager ユーザーの姓。 | ||||||||||||||||||||||||||||||||||||||||
| オブジェクト配列 | 関連するサブリソース へのリンク。 応答内のすべての | ||||||||||||||||||||||||||||||||||||||||
| string | MongoDB Ops Manager ユーザーのモバイル番号。 | ||||||||||||||||||||||||||||||||||||||||
| 空の配列 | MongoDB Ops Manager ユーザーに割り当てられたロール。 | ||||||||||||||||||||||||||||||||||||||||
roles.groupId | string | 指定されたロールを持つユーザーを持つプロジェクトの一意の識別子です。
| ||||||||||||||||||||||||||||||||||||||||
roles.orgId | string | 指定されたロールを持つユーザーが所属する組織の一意の識別子です。 | ||||||||||||||||||||||||||||||||||||||||
roles.roleName | string | ロールの名前。 指定できる値は以下のとおりです。
| ||||||||||||||||||||||||||||||||||||||||
| string | MongoDB Ops Manager ユーザーのユーザー名。 |
リクエストの例
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request POST "https://<OpsManagerHost>:<Port>/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 "roles": [{ 14 "groupId": "533daa30879bb2da07807696", 15 "roleName": "GROUP_USER_ADMIN" 16 },{ 17 "orgId" : "55555bbe3bd5253aea2d9b16", 18 "roleName" : "ORG_MEMBER" 19 }] 20 }'
応答例
応答ヘッダー
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
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" : [] }