Package org.ovirt.engine.sdk4.services

Interface RolesService

All Superinterfaces:

Service

All Known Implementing Classes:

RolesServiceImpl

public interface RolesService
extends Service

Provides read-only access to the global set of roles

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RolesService.AddRequest	Create a new role.
static interface	RolesService.AddResponse	Create a new role.
static interface	RolesService.ListRequest	List roles.
static interface	RolesService.ListResponse	List roles.

Method Summary

Modifier and Type	Method	Description
RolesService.AddRequest	add()	Create a new role.
RolesService.ListRequest	list()	List roles.
RoleService	roleService(String id)	Sub-resource locator method, returns individual role resource on which the remainder of the URI is dispatched.
Service	service(String path)	Service locator method, returns individual service on which the URI is dispatched.

Method Detail

add

RolesService.AddRequest add()

Create a new role. The role can be administrative or non-administrative and can have different permits. For example, to add the `MyRole` non-administrative role with permits to login and create virtual machines send a request like this (note that you have to pass permit id): [source] ---- POST /ovirt-engine/api/roles ---- With a request body like this: [source,xml] ---- MyRole My custom role to create virtual machines false ----

list

RolesService.ListRequest list()

List roles. [source] ---- GET /ovirt-engine/api/roles ---- You will receive response in XML like this one: [source,xml] ---- SuperUser Roles management administrator true false ... ---- The order of the returned list of roles isn't guaranteed.

roleService

RoleService roleService(String id)

Sub-resource locator method, returns individual role resource on which the remainder of the URI is dispatched.

service

Service service(String path)

Service locator method, returns individual service on which the URI is dispatched.