com.vmware.vcenter.authorization

Interface PrivilegeChecks

All Superinterfaces:

PrivilegeChecksTypes, Service

All Known Implementing Classes:

PrivilegeChecksStub

public interface PrivilegeChecks
extends Service, PrivilegeChecksTypes

The PrivilegeChecks interface provides methods for retrieving permission privilege checks recorded by VPXD.

The privilege checks are recorded as VPXD makes them. The latest recorded privilege check can be retrieved by a call to com.vmware.vcenter.authorization.privilege_checks.Latest.get This allows for querying of all privilege checks before or after that moment. For example, if an administrator wants to record the privilege checks made by a given UI workflow, they can do the following. 1. Retrieve the latest privilege check and store it. 2. Go through the UI workflow. 3. Retrieve the latest privilege check and store it. 4. Invoke com.vmware.vcenter.authorization.PrivilegeChecks.list with the values from steps 1) and 3) along with any additional filters.

. This interface was added in vSphere API 8.0.0.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.authorization.PrivilegeChecksTypes

PrivilegeChecksTypes.FilterSpec, PrivilegeChecksTypes.Info, PrivilegeChecksTypes.IterationSpec, PrivilegeChecksTypes.ListResult, PrivilegeChecksTypes.Principal

Field Summary

Fields inherited from interface com.vmware.vcenter.authorization.PrivilegeChecksTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
PrivilegeChecksTypes.ListResult	list(PrivilegeChecksTypes.IterationSpec iteration, PrivilegeChecksTypes.FilterSpec filter) Queries the privilege checks matching given criteria.
void	list(PrivilegeChecksTypes.IterationSpec iteration, PrivilegeChecksTypes.FilterSpec filter, AsyncCallback<PrivilegeChecksTypes.ListResult> asyncCallback) Queries the privilege checks matching given criteria.
void	list(PrivilegeChecksTypes.IterationSpec iteration, PrivilegeChecksTypes.FilterSpec filter, AsyncCallback<PrivilegeChecksTypes.ListResult> asyncCallback, InvocationConfig invocationConfig) Queries the privilege checks matching given criteria.
PrivilegeChecksTypes.ListResult	list(PrivilegeChecksTypes.IterationSpec iteration, PrivilegeChecksTypes.FilterSpec filter, InvocationConfig invocationConfig) Queries the privilege checks matching given criteria.

Method Detail

list

PrivilegeChecksTypes.ListResult list(PrivilegeChecksTypes.IterationSpec iteration,
                                     PrivilegeChecksTypes.FilterSpec filter)

Queries the privilege checks matching given criteria. This method was added in vSphere API 8.0.0.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

iteration - Contains optional settings for pagination of the result. if unset, the oldest privilege checks recorded are returned, paged by the default page size.

The default page size can be changed from config.vpxd.privilegeChecks.pageSize advanced option.

filter - Contains optional settings by which the privilege checks should be filtered. if unset, recorded privilege checks matching the iteration spec are returned.

Returns:

Detailed information about the privileges collected so far.

Throws:

Error - if there is a generic error.

InvalidArgument - if filter or iteration spec contain invalid values.

NotFound - if the iteration spec contains a marker that could not be found.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Sessions.CollectPrivilegeChecks.

list

PrivilegeChecksTypes.ListResult list(PrivilegeChecksTypes.IterationSpec iteration,
                                     PrivilegeChecksTypes.FilterSpec filter,
                                     InvocationConfig invocationConfig)

Queries the privilege checks matching given criteria. This method was added in vSphere API 8.0.0.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

iteration - Contains optional settings for pagination of the result. if unset, the oldest privilege checks recorded are returned, paged by the default page size.

The default page size can be changed from config.vpxd.privilegeChecks.pageSize advanced option.

filter - Contains optional settings by which the privilege checks should be filtered. if unset, recorded privilege checks matching the iteration spec are returned.

invocationConfig - Configuration for the method invocation.

Returns:

Detailed information about the privileges collected so far.

Throws:

Error - if there is a generic error.

InvalidArgument - if filter or iteration spec contain invalid values.

NotFound - if the iteration spec contains a marker that could not be found.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Sessions.CollectPrivilegeChecks.

list

void list(PrivilegeChecksTypes.IterationSpec iteration,
          PrivilegeChecksTypes.FilterSpec filter,
          AsyncCallback<PrivilegeChecksTypes.ListResult> asyncCallback)

Queries the privilege checks matching given criteria. This method was added in vSphere API 8.0.0.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Detailed information about the privileges collected so far.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if filter or iteration spec contain invalid values.
NotFound - if the iteration spec contains a marker that could not be found.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Sessions.CollectPrivilegeChecks.

Parameters:

iteration - Contains optional settings for pagination of the result. if unset, the oldest privilege checks recorded are returned, paged by the default page size.

The default page size can be changed from config.vpxd.privilegeChecks.pageSize advanced option.

filter - Contains optional settings by which the privilege checks should be filtered. if unset, recorded privilege checks matching the iteration spec are returned.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(PrivilegeChecksTypes.IterationSpec iteration,
          PrivilegeChecksTypes.FilterSpec filter,
          AsyncCallback<PrivilegeChecksTypes.ListResult> asyncCallback,
          InvocationConfig invocationConfig)

Queries the privilege checks matching given criteria. This method was added in vSphere API 8.0.0.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
Detailed information about the privileges collected so far.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if filter or iteration spec contain invalid values.
NotFound - if the iteration spec contains a marker that could not be found.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires Sessions.CollectPrivilegeChecks.

Parameters:

iteration - Contains optional settings for pagination of the result. if unset, the oldest privilege checks recorded are returned, paged by the default page size.

The default page size can be changed from config.vpxd.privilegeChecks.pageSize advanced option.

filter - Contains optional settings by which the privilege checks should be filtered. if unset, recorded privilege checks matching the iteration spec are returned.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.