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

注意

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

組織またはプロジェクト内でユーザーのロールを追加、更新、または削除します。デフォルトでは、ペイロード内の新しい非グローバル組織とプロジェクトロールは、最初に組織またはプロジェクトへの招待をユーザーに送信します。 mms.user.bypassInviteForExistingUsersの設定をtrueに設定している場合にのみ、組織またはプロジェクトにユーザーを直接追加できます。

Resource

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

PATCH /users/{USER-ID}

必須のロール

このAPIエンドポイントを使用するには、適切なオーナーロールが必要です。

レベル	必要なロール
組織	`Organization Owner`
プロジェクト	`Project Owner`

重要

自分のユーザーアカウントはいつでも更新できます。

組織またはプロジェクトを所有している場合は、その組織またはプロジェクトのメンバーシップを持つ全ユーザーのユーザーロールを更新できます。その他のユーザープロファイル情報は変更できません。

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

名前	タイプ	必要性	説明
`USER-ID`	string	必須	検索するユーザーの一意の識別子。ユーザーの`USER-ID`を取得するには、「 1 つのプロジェクトのすべてのユーザーを取得」を参照してください。

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

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

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

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

名前	タイプ	必要性	説明
`roles`	オブジェクトの配列	必須	MongoDB Ops Manager ユーザーに割り当てられたロール。
`roles` `.orgId`	string	任意	MongoDB Ops Manager ユーザーが指定されたロールを持つ組織の一意の識別子。
`roles` `.groupId`	string	任意	MongoDB Ops Manager ユーザーが指定されたロールを持つプロジェクトの一意の識別子。 `GLOBAL_`で始まるロールには`groupId`は必要ありません。これらのロールはプロジェクトには関連付けられていません。
`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`

応答

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 PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}" \6     --data '7       {8         "roles": [{9           "groupId": "{GROUP-ID}",10           "roleName": "{ROLE}"11         }]12       }'

応答例

応答ヘッダー

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 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

レスポンス本体

1{2  "id": "{USER-ID}",3  "username": "jane",4  "emailAddress": "jane@qa.example.com",5  "firstName": "Jane",6  "lastName": "D'oh",7  "links": [{8    "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}",9    "rel": "self"10  },11  {12    "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}/accessList",13    "rel": "http://mms.mongodb.com/accessList"14  }],15  "roles": [{16    "orgId": "{ORG-ID}",17    "roleName": "ORG_MEMBER"18  },{19    "groupId": "{PROJECT-ID}",20    "roleName": "GROUP_READ_ONLY"21  }],22  "teamIds": []23}