UsersService (oVirt Java SDK 4.4.6 API)

All Superinterfaces:

Service

All Known Implementing Classes:

UsersServiceImpl
```
public interface UsersService
extends Service
```
A service to manage the users in the system.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`UsersService.AddRequest`	Add user from a directory service.
`static interface`	`UsersService.AddResponse`	Add user from a directory service.
`static interface`	`UsersService.ListRequest`	List all the users in the system.
`static interface`	`UsersService.ListResponse`	List all the users in the system.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`UsersService.AddRequest`	`add()`	Add user from a directory service.
`UsersService.ListRequest`	`list()`	List all the users in the system.
`Service`	`service(String path)`	Service locator method, returns individual service on which the URI is dispatched.
`UserService`	`userService(String id)`

- Method Detail
  - add
```
UsersService.AddRequest add()
```
    Add user from a directory service. For example, to add the `myuser` user from the `myextension-authz` authorization provider send a request like this: [source] ---- POST /ovirt-engine/api/users ---- With a request body like this: [source,xml] ---- myuser@myextension-authz myextension-authz ---- In case you are working with Active Directory you have to pass user principal name (UPN) as `username`, followed by authorization provider name. Due to https://bugzilla.redhat.com/1147900[bug 1147900] you need to provide also `principal` parameter set to UPN of the user. For example, to add the user with UPN `[email protected]` from the `myextension-authz` authorization provider send a request body like this: [source,xml] ---- [email protected] [email protected]@myextension-authz myextension-authz ----
  - list
```
UsersService.ListRequest list()
```
    List all the users in the system. Usage: .... GET /ovirt-engine/api/users .... Will return the list of users: [source,xml] ---- admin 23456 * user1 user1@domain-authz domain-authz ---- The order of the returned list of users isn't guaranteed.
  - userService
```
UserService userService(String id)
```
  - service
```
Service service(String path)
```
    Service locator method, returns individual service on which the URI is dispatched.