ID でユーザーを取得

注意

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

自分のユーザーアカウントはいつでも検索できます。それ以外の場合は、グローバルユーザーであるか、取得するユーザーとの間で共通の少なくとも 1 つのプロジェクトでProject User Adminロールが必要です。

このエンドポイントを使用してAPI キーに関する情報を返すことはできません。この情報を取得するには、 Get One API Keyエンドポイントをリクエストします。

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

Resource

GET /users/{USER-ID}

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

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

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

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

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

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

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

応答

HTTP ドキュメントには、次の各要素が含まれています。

名前	タイプ	説明
メールアドレス	string	MongoDB Ops Manager ユーザーのメールアドレス。
名	string	MongoDB Ops Manager ユーザーの名。
id	string	MongoDB Ops Manager ユーザーの一意の識別子です。
姓	string	MongoDB Ops Manager ユーザーの姓。
Links	オブジェクト配列	関連するサブリソースへのリンク。応答内のすべての `links` 配列には、自己と呼ばれるリンクが少なくとも 1 つ含まれています。URL の関係は、Web リンク仕様で説明されています。
mobileNumber	string	MongoDB Ops Manager ユーザーのモバイル番号。
役割	オブジェクト配列	ロールの割り当て。
role.groupId	string	指定されたロールを持つユーザーを持つプロジェクトの一意の識別子です。「グローバル」ロール（名前が`GLOBAL_`で始まるロール）の場合、これらのロールはプロジェクトに関連付けられていないため、 groupIdはありません。
role.orgId	string	指定されたロールを持つユーザーが所属する組織の一意の識別子です。
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`
username	string	MongoDB Ops Manager ユーザーのユーザー名。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://<ops-manager-host>/api/public/v1.0/users/533dc19ce4b00835ff81e2eb"

応答例

応答ヘッダー

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}

レスポンス本体

{  "id" : "533dc19ce4b00835ff81e2eb",  "username" : "jane",  "emailAddress" : "jane@qa.example.com",  "firstName" : "Jane",  "lastName" : "D'oh",  "roles" : [ {    "groupId" : "{PROJECT-ID}",    "roleName" : "GROUP_USER_ADMIN"  },{    "orgId" : "55555bbe3bd5253aea2d9b16",    "roleName" : "ORG_MEMBER"  } ],  "links" : [],  "username": "jane"}

戻る

ユーザー

名前を使用して取得