- API >
- Public API Resources >
- Groups and Users >
- Groups >
- Add Existing Users to One Group
Add Existing Users to One Group¶
On this page
This resource adds users who exist in Ops Manager to another group. It does not create new users and add them to a group.
Base URL: {opsManagerHost}:{port}
¶
Syntax¶
Request Parameters¶
Request Path Parameters¶
Parameter | Required/Optional | Description |
---|---|---|
GROUP-ID |
Required. | The unique identifier for the group. |
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 |
---|---|---|---|
pageNum |
integer | Page number (1-based). | 1 |
itemsPerPage |
integer | Maximum number of items to return, up to a maximum of 100. | 100 |
pretty |
boolean | Display response in human-readable format. | false |
Request Body Parameters¶
Name | Type | Description |
---|---|---|
id |
string | The unique identifier for an existing user. |
roles |
document array | The roles to which this user is assigned. |
roles.groupId |
string | The unique identifier for the group role. |
roles.roleName |
string | The display name for the user role. |
Response Elements¶
Name | Type | Description |
---|---|---|
emailAddress |
string | The email address for the Ops Manager user. |
firstName |
string | The first name displayed for the returned Ops Manager user. |
id |
string | The unique identifier for the user. |
links |
string array | See Response Links. |
lastName |
string | The last name displayed for the returned Ops Manager user. |
roles |
document array | The roles to which this user is assigned. |
roles.groupId |
string | The unique identifier for the group role. |
roles.roleName |
string | The display name for the user role. |
username |
string | The Ops Manager username. |
Response Links¶
Relation | Description |
---|---|
self |
Me |
http://{opsManagerHost}:{port}/whitelist |
All whitelists in the group. |
Examples¶
Example Request¶
Note
You must send an array of entities, even if adding a single user. For
each user that you wish to add, specify the user ID and the roles the
user should possess. For possible role values, see the description of
the roles.roleName
field in the
users resource’s field descriptions.
If you specify a user that is already a member of the group, their existing roles are overwritten with the specified permissions.