19.3. Sub-Collections

19.3.1. Domain Users Sub-Collection

The users sub-collection contains all users in the directory service. This information is used to add new users to the Red Hat Virtualization environment.

Table 19.2. Domain user elements

Element Type Description
name string The name of the user.
last_name string The surname of the user.
user_name string The user name from directory service.
domain id GUID The containing directory service domain.
groups complex A list of directory service groups for this user.

Example 19.2. An XML representation of a user in the users sub-collection

<user id="225f15cd-e891-434d-8262-a66808fcb9b1"
  href="/ovirt-engine/api/domains/77696e32-6b38-7268-6576-2e656e676c61/users/
  d3b4e7be-5f57-4dac-b937-21e1771a501f">
    <name>RHEV-M Admin</name>
    <user_name>rhevmadmin@domain.example.com</user_name>
    <domain id="77696e32-6b38-7268-6576-2e656e676c61"
      href="/ovirt-engine/api/domains/77696e32-6b38-7268-6576-2e656e676c61"/>
    <groups>
        <group>
            <name>domain.example.com/Users/Enterprise Admins</name>
        </group>
        <group>
            <name>domain.example.com/Users/Domain Admins</name>
        </group>
        ...
    </groups>
</user>

19.3.2. Domain Groups Sub-Collection

The groups sub-collection contains all groups in the directory service. A domain group resource contains a set of elements.

Table 19.3. Domain group elements

Element Type Description
name string The name of the group.
domain id GUID The containing directory service domain.

Example 19.3. An XML representation of a group in the groups sub-collection

<group id="85bf8d97-273c-4a5c-b801-b17d58330dab"
  href="/ovirt-engine/api/domains/77696e32-6b38-7268-6576-2e656e676c61/groups/
  85bf8d97-273c-4a5c-b801-b17d58330dab">
    <name>example.com/Users/Enterprise Admins</name>
    <domain id="77696e32-6b38-7268-6576-2e656e676c61"
      href="/ovirt-engine/api/domains/77696e32-6b38-7268-6576-2e656e676c61"/>
</group>