- API >
- Public API Resources >
- Groups and Users >
- Projects >
- Add Existing Users to One Group
Add Existing Users to One Group¶
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.
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: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Parameters¶
Request Path Parameters¶
Parameter | Type | Description |
---|---|---|
GROUP-ID | string | (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 | ||||||
---|---|---|---|---|---|---|---|---|---|
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 | The unique identifier for an existing user. |
roles | object 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¶
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 | object array | One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification |
lastName | string | The last name displayed for the returned Ops Manager user. |
roles | object 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. |
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 role values, see the description of the
roles.roleName
field in the
users resource.
If you specify a user that is already a member of the group, their existing roles are overwritten with the specified permissions.