- API >
- Public API Resources >
- Groups and Users >
- Users >
- Update a User
Update a User¶
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.
Update an existing user. Unspecified fields preserve their current values.
Note
You cannot update the password field for security reasons.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Path Parameters¶
Name | Type | Necessity | Description |
---|---|---|---|
USER-ID | string | Required | Unique identifier of the user that you want to retrieve. To retrieve the USER-ID for a user, see Get All Users in One Project. |
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 | Indicates whether the response body should be in a prettyprint format. | false |
||||||
envelope |
boolean | Indicates 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, the response body includes:
|
false |
Request Body Parameters¶
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | Unique identifier of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
username | string | Username of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
emailAddress | string | Email address of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
mobileNumber | string | Mobile telephone number of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
firstName | string | First name of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
lastName | string | Last name of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
roles | object array | Role assignments of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
roles.orgId | string | Unique identifier of the organization in which the Ops Manager user has the specified role. | ||||||||||||||||||||||||||||||||||||||||
roles.groupId | string | Unique identifier of the group in which the Ops Manager user has the specified role. For the “global” roles (those whose name starts
with |
||||||||||||||||||||||||||||||||||||||||
roles.roleName | string | Name of the role. Accepted values are:
|
Response¶
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
emailAddress | string | Email address of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
firstName | string | First name of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
id | string | Unique identifier of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
lastName | string | Last name of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||||||||||
mobileNumber | string | Mobile number of the Ops Manager user. | ||||||||||||||||||||||||||||||||||||||||
roles | object array | Role assignments. | ||||||||||||||||||||||||||||||||||||||||
roles.groupId | string | Unique identifier for the project in which the user has the specified role. For the “global” roles (those whose name starts
with |
||||||||||||||||||||||||||||||||||||||||
roles.orgId | string | Unique identifier for the organization in which the user has the specified role. | ||||||||||||||||||||||||||||||||||||||||
roles.roleName | string | Name of the role. Accepted values are:
|
||||||||||||||||||||||||||||||||||||||||
username | string | Ops Manager username of the Ops Manager user. |