- API >
- Public API Resources >
- Groups and Users >
- Users >
- Get a User by Name
Get a User by Name¶
On this page
Note
Groups and projects are synonymous terms. Your {GROUP-ID}
is the
same as your project id. For existing groups, your group/project id
remains the same. This page uses the more familiar term group when
referring to descriptions. The endpoint remains as stated in the
document.
You can always retrieve your own user account. Otherwise, you must be a global user or you must have the user admin role in at least one group that is common between you and the user you are retrieving.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Path Parameters¶
Parameter | Type | Description |
---|---|---|
USER-NAME | string | (Required.) Username of the MongoDB user that you want to retrieve. |
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.
Name | Type | Description | Default |
---|---|---|---|
pretty | boolean | Flag indicating whether the response body should be in a prettyprint format. | false |
envelope | boolean | Flag indicating whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return one result, response body includes:
|
false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
The HTTP document contains each of the following elements:
Name | Type | Description | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
emailAddress | string | Email address. | ||||||||||||||||||||||||||||||||||||
firstName | string | First name. | ||||||||||||||||||||||||||||||||||||
id | string | Unique identifier. | ||||||||||||||||||||||||||||||||||||
username | string | Ops Manager username. | ||||||||||||||||||||||||||||||||||||
mobileNumber | string | Mobile number. | ||||||||||||||||||||||||||||||||||||
lastName | string | Last name. | ||||||||||||||||||||||||||||||||||||
links | object array | Links to related sub-resources. All links arrays in responses
include at least one link called self. The relations between URLs are
explained in the Web Linking Specification. |
||||||||||||||||||||||||||||||||||||
roles | object array | Role assignments. | ||||||||||||||||||||||||||||||||||||
roles.groupId | string | The ID of the group in which the user has the specified role. For the “global” roles (those whose name starts
with |
||||||||||||||||||||||||||||||||||||
roles.orgId | string | The ID of the organization in which the user has the specified role. | ||||||||||||||||||||||||||||||||||||
roles.roleName | string | The name of the role. Accepted values are:
|