Package org.ovirt.engine.sdk4.services

Interface AssignedPermissionsService

All Superinterfaces:

Service

All Known Subinterfaces:

SystemPermissionsService

All Known Implementing Classes:

AssignedPermissionsServiceImpl, SystemPermissionsServiceImpl

public interface AssignedPermissionsService
extends Service

Represents a permission sub-collection, scoped by user, group or some entity type.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AssignedPermissionsService.AddClusterPermissionRequest	Add a new permission on the cluster to the group in the system.
static interface	AssignedPermissionsService.AddClusterPermissionResponse	Add a new permission on the cluster to the group in the system.
static interface	AssignedPermissionsService.AddDataCenterPermissionRequest	Add a new permission on the data center to the group in the system.
static interface	AssignedPermissionsService.AddDataCenterPermissionResponse	Add a new permission on the data center to the group in the system.
static interface	AssignedPermissionsService.AddGroupLevelRequest	Add a new group level permission for a given virtual machine.
static interface	AssignedPermissionsService.AddGroupLevelResponse	Add a new group level permission for a given virtual machine.
static interface	AssignedPermissionsService.AddHostPermissionRequest	Add a new permission on the host to the group in the system.
static interface	AssignedPermissionsService.AddHostPermissionResponse	Add a new permission on the host to the group in the system.
static interface	AssignedPermissionsService.AddRequest	Assign a new permission to a user or group for specific entity.
static interface	AssignedPermissionsService.AddResponse	Assign a new permission to a user or group for specific entity.
static interface	AssignedPermissionsService.AddStorageDomainPermissionRequest	Add a new permission on the storage domain to the group in the system.
static interface	AssignedPermissionsService.AddStorageDomainPermissionResponse	Add a new permission on the storage domain to the group in the system.
static interface	AssignedPermissionsService.AddTemplatePermissionRequest	Add a new permission on the template to the group in the system.
static interface	AssignedPermissionsService.AddTemplatePermissionResponse	Add a new permission on the template to the group in the system.
static interface	AssignedPermissionsService.AddUserLevelRequest	Add a new user level permission for a given virtual machine.
static interface	AssignedPermissionsService.AddUserLevelResponse	Add a new user level permission for a given virtual machine.
static interface	AssignedPermissionsService.AddVmPermissionRequest	Add a new permission on the vm to the group in the system.
static interface	AssignedPermissionsService.AddVmPermissionResponse	Add a new permission on the vm to the group in the system.
static interface	AssignedPermissionsService.AddVmPoolPermissionRequest	Add a new permission on the vm pool to the group in the system.
static interface	AssignedPermissionsService.AddVmPoolPermissionResponse	Add a new permission on the vm pool to the group in the system.
static interface	AssignedPermissionsService.ListRequest	List all the permissions of the specific entity.
static interface	AssignedPermissionsService.ListResponse	List all the permissions of the specific entity.

Method Summary

Modifier and Type	Method	Description
AssignedPermissionsService.AddRequest	add()	Assign a new permission to a user or group for specific entity.
AssignedPermissionsService.AddClusterPermissionRequest	addClusterPermission()	Add a new permission on the cluster to the group in the system.
AssignedPermissionsService.AddDataCenterPermissionRequest	addDataCenterPermission()	Add a new permission on the data center to the group in the system.
AssignedPermissionsService.AddGroupLevelRequest	addGroupLevel()	Add a new group level permission for a given virtual machine.
AssignedPermissionsService.AddHostPermissionRequest	addHostPermission()	Add a new permission on the host to the group in the system.
AssignedPermissionsService.AddStorageDomainPermissionRequest	addStorageDomainPermission()	Add a new permission on the storage domain to the group in the system.
AssignedPermissionsService.AddTemplatePermissionRequest	addTemplatePermission()	Add a new permission on the template to the group in the system.
AssignedPermissionsService.AddUserLevelRequest	addUserLevel()	Add a new user level permission for a given virtual machine.
AssignedPermissionsService.AddVmPermissionRequest	addVmPermission()	Add a new permission on the vm to the group in the system.
AssignedPermissionsService.AddVmPoolPermissionRequest	addVmPoolPermission()	Add a new permission on the vm pool to the group in the system.
AssignedPermissionsService.ListRequest	list()	List all the permissions of the specific entity.
PermissionService	permissionService(String id)	Sub-resource locator method, returns individual permission 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

AssignedPermissionsService.AddRequest add()

Assign a new permission to a user or group for specific entity. For example, to assign the `UserVmManager` role to the virtual machine with id `123` to the user with id `456` send a request like this: .... POST /ovirt-engine/api/vms/123/permissions .... With a request body like this: [source,xml] ---- UserVmManager ---- To assign the `SuperUser` role to the system to the user with id `456` send a request like this: .... POST /ovirt-engine/api/permissions .... With a request body like this: [source,xml] ---- SuperUser ---- If you want to assign permission to the group instead of the user please replace the `user` element with the `group` element with proper `id` of the group. For example to assign the `UserRole` role to the cluster with id `123` to the group with id `789` send a request like this: .... POST /ovirt-engine/api/clusters/123/permissions .... With a request body like this: [source,xml] ---- UserRole ----

addClusterPermission

AssignedPermissionsService.AddClusterPermissionRequest addClusterPermission()

Add a new permission on the cluster to the group in the system.

addDataCenterPermission

AssignedPermissionsService.AddDataCenterPermissionRequest addDataCenterPermission()

Add a new permission on the data center to the group in the system.

addGroupLevel

AssignedPermissionsService.AddGroupLevelRequest addGroupLevel()

Add a new group level permission for a given virtual machine.

addHostPermission

AssignedPermissionsService.AddHostPermissionRequest addHostPermission()

Add a new permission on the host to the group in the system.

list

AssignedPermissionsService.ListRequest list()

List all the permissions of the specific entity. For example to list all the permissions of the cluster with id `123` send a request like this: .... GET /ovirt-engine/api/clusters/123/permissions .... [source,xml] ---- ---- The order of the returned permissions isn't guaranteed.

addStorageDomainPermission

AssignedPermissionsService.AddStorageDomainPermissionRequest addStorageDomainPermission()

Add a new permission on the storage domain to the group in the system.

addTemplatePermission

AssignedPermissionsService.AddTemplatePermissionRequest addTemplatePermission()

Add a new permission on the template to the group in the system.

addUserLevel

AssignedPermissionsService.AddUserLevelRequest addUserLevel()

Add a new user level permission for a given virtual machine.

addVmPermission

AssignedPermissionsService.AddVmPermissionRequest addVmPermission()

Add a new permission on the vm to the group in the system.

addVmPoolPermission

AssignedPermissionsService.AddVmPoolPermissionRequest addVmPoolPermission()

Add a new permission on the vm pool to the group in the system.

permissionService

PermissionService permissionService(String id)

Sub-resource locator method, returns individual permission 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.