rel="users"
link. Individual user
elements contain the following:
Element | Type | Description | Properties |
---|---|---|---|
user_name
| string | The user principal name (UPN). The UPN is used as a more convenient identifier when adding a new user. |
![]() |
link rel="tags"
| relationship |
A link to the tags sub-collection for user resources.
| |
link rel="roles"
| relationship |
A link to the roles sub-collection for user resources.
| |
name
| string | A free-text name for the user. |
![]() |
description
| string | A free-text description of the user. |
![]() |
domain
| string | The containing directory service domain. |
![]() |
groups
| complex | A list of directory service groups for this user. |
![]() |
GET /api/users HTTP/1.1 Accept: application/xml <user id="225f15cd-e891-434d-8262-a66808fcb9b1" href="/api/users/225f15cd-e891-434d-8262-a66808fcb9b1"> <name>RHEV-M Admin</name> <actions/> <link rel="roles" href="/api/users/225f15cd-e891-434d-8262-a66808fcb9b1/roles"/> <link rel="tags" href="/api/users/225f15cd-e891-434d-8262-a66808fcb9b1/tags"/> <domain>domain.example.com</domain> <logged_in>false</logged_in> <user_name>rhevmadmin@domain.example.com</user_name> <groups> <group>Group Policy Creator Owners@domain.example.com/Users</group> <group>Domain Admins@domain.example.com/Users</group> <group>Enterprise Admins@domain.example.com/Users</group> <group>Schema Admins@domain.example.com/Users</group> <group>Administrators@domain.example.com/Builtin</group> </groups> </user>
POST
request to the users
collection. The client-provided new user representation includes an embedded roles
list with at least one initial role
to assign to the user. For example, the following request assigns two initial roles to the user joe@domain.example.com
:
POST /api/users HTTP/1.1 Content-Type: application/xml Accept: application/xml <user> <user_name>joe@domain.example.com</user_name> <roles> <role> <name>RHEVMPowerUser</name> </role> <role id="00000000-0000-0000-0001-000000000003"/> </roles> </user>
domains
collection prior to creation of the user.
POST
or DELETE
requests to the roles sub-collection of an individual user. The example below illustrates how the API adds the RHEVMVDIUser
role to the role assignments for a particular user.
user
element is only used for the initial creation. All interactions post-creation with the user's role assignments go through the roles
sub-collection.
POST /api/users/225f15cd-e891-434d-8262-a66808fcb9b1/roles HTTP/1.1 Content-Type: application/xml Accept: application/xml <role> <name>RHEVMVDIUser</name> </role>
PUT
verb. The only changes allowed post-creation are in the user's role assignments.
DELETE
request on the users
collection. The directory service domain remains unchanged after such a deletion.