ユーザーを 1 人作成

項目一覧

Resource

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

MongoDB Ops Manager v6.0 は 1 月 2025 で EOL になります。可能な限りすぐに MongoDB Ops Manager の上位バージョンにアップグレードしてください。

注意

グループとプロジェクトは同義語です。あなたの {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 に含めるかどうかを示すフラグ形式。

false

envelope

ブール値

任意

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

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

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

名前	説明
状態	HTTPレスポンスコード
envelope	期待される応答本体

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 ユーザーのユーザー名。

リクエストの例

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        }'

応答例

応答ヘッダー

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

戻る

名前を使用してユーザーを取得

1 人のユーザーのロールを更新

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	}'

注意

Resource

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

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

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

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

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

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

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