ユーザーを 1 人作成

注意

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

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

Resource

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

POST /users

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

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

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

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

名前	タイプ	必要性	説明	default
pretty	ブール値	任意	レスポンス本体をpretty-print形式にするかどうかを示すフラグ。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。 `status`: HTTPレスポンスコード `content`: 期待される応答本体	`false`

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

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

名前	タイプ	説明
username	string	MongoDB Ops Manager ユーザーのユーザー名。 `mms.email.validation`プロパティの値に応じて検証されます。 `false`:（デフォルト）ユーザー名はメールアドレスである必要はありません。 `loose`: ユーザー名には、`@` 記号とそれに続くピリオドを含める必要があります。 `strict`: ユーザー名は、厳格なメールアドレス検証の正規式に準拠する必要があります。詳細については、「`mms.email.validation`」を参照してください。
パスワード	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 ユーザーが指定されたロールを持つグループの一意の識別子。「グローバル」ロール（名前が`GLOBAL_`で始まるロール）では、これらのロールはグループに関連付けられていないため、 `groupId`は存在しません。
role.roleName	string	ロールの名前。指定できる値は以下のとおりです。 `ORG_MEMBER`: `Organization Member` `ORG_READ_ONLY`: `Organization Read Only` `ORG_GROUP_CREATOR`: `Organization Project Creator` `ORG_OWNER`: `Organization Owner` `GROUP_AUTOMATION_ADMIN`: `Project Automation Admin` `GROUP_BACKUP_ADMIN`: `Project Backup Admin` `GROUP_MONITORING_ADMIN`: `Project Monitoring Admin` `GROUP_OWNER`: `Project Owner` `GROUP_READ_ONLY`: `Project Read Only` `GROUP_USER_ADMIN`: `Project User Admin` `GROUP_DATA_ACCESS_ADMIN`: `Project Data Access Admin` `GROUP_DATA_ACCESS_READ_ONLY`: `Project Data Access Read Only` `GROUP_DATA_ACCESS_READ_WRITE`: `Project Data Access Read/Write` `GLOBAL_AUTOMATION_ADMIN`: `Global Automation Admin` `GLOBAL_BACKUP_ADMIN`: `Global Backup Admin` `GLOBAL_MONITORING_ADMIN`: `Global Monitoring Admin` `GLOBAL_OWNER`: `Global Owner` `GLOBAL_READ_ONLY`: `Global Read Only` `GLOBAL_USER_ADMIN`: `Global User Admin`

応答

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

`Name`	タイプ	説明
`emailAddress`	string	MongoDB Ops Manager ユーザーのメールアドレス。
`firstName`	string	MongoDB Ops Manager ユーザーの名。
`id`	string	MongoDB Ops Manager ユーザーの一意の識別子です。
`lastName`	string	MongoDB Ops Manager ユーザーの姓。
`links`	オブジェクト配列	関連するサブリソースへのリンク。応答内のすべての `links` 配列には、自己と呼ばれるリンクが少なくとも 1 つ含まれています。URL の関係は、Web リンク仕様で説明されています。
`mobileNumber`	string	MongoDB Ops Manager ユーザーのモバイル番号。
`roles`	空の配列	MongoDB Ops Manager ユーザーに割り当てられたロール。
`roles` `.groupId`	string	指定されたロールを持つユーザーを持つプロジェクトの一意の識別子です。 `GLOBAL_`で始まるロールには`groupId`は必要ありません。これらのロールはプロジェクトには関連付けられていません。
`roles` `.orgId`	string	指定されたロールを持つユーザーが所属する組織の一意の識別子です。
`roles` `.roleName`	string	ロールの名前。指定できる値は以下のとおりです。 `ORG_MEMBER`: `Organization Member` `ORG_READ_ONLY`: `Organization Read Only` `ORG_GROUP_CREATOR`: `Organization Project Creator` `ORG_OWNER`: `Organization Owner` `GROUP_AUTOMATION_ADMIN`: `Project Automation Admin` `GROUP_BACKUP_ADMIN`: `Project Backup Admin` `GROUP_MONITORING_ADMIN`: `Project Monitoring Admin` `GROUP_OWNER`: `Project Owner` `GROUP_READ_ONLY`: `Project Read Only` `GROUP_USER_ADMIN`: `Project User Admin` `GROUP_DATA_ACCESS_ADMIN`: `Project Data Access Admin` `GROUP_DATA_ACCESS_READ_ONLY`: `Project Data Access Read Only` `GROUP_DATA_ACCESS_READ_WRITE`: `Project Data Access Read/Write` `GLOBAL_AUTOMATION_ADMIN`: `Global Automation Admin` `GLOBAL_BACKUP_ADMIN`: `Global Backup Admin` `GLOBAL_MONITORING_ADMIN`: `Global Monitoring Admin` `GLOBAL_OWNER`: `Global Owner` `GLOBAL_READ_ONLY`: `Global Read Only` `GLOBAL_USER_ADMIN`: `Global User Admin`
`username`	string	MongoDB Ops 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://<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       }'

応答例

応答ヘッダー

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" : []}

戻る

名前を使用して取得

ロールを更新