List Privilege Checks
Queries the privilege checks matching given criteria. if you do not have all of the privileges described as follows: - Operation execution requires Sessions.CollectPrivilegeChecks.
Request
URLURL
https://{api_host}/api/vcenter/authorization/privilege-checks?action=list
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
AuthorizationPrivilegeChecksListRequestBody of mimetype application/json
Optional
This is a request body class for an operation.
(The request body parameter is missing description)
{
"filter": {
"objects": [
{
"id": "string",
"type": "string"
}
],
"op_ids": [
"string"
],
"principals": [
{
"domain": "string",
"name": "string"
}
],
"privileges": [
"string"
],
"sessions": [
"string"
]
}
}
filter
Optional
Contains optional settings by which the privilege checks should be filtered. if unset, recorded privilege checks matching the iteration spec are returned.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
AuthorizationPrivilegeChecksListResult
of type application/json
Detailed information about the privileges collected so far.
{
"items": [
{
"object": {
"id": "string",
"type": "string"
},
"principal": {
"domain": "string",
"name": "string"
},
"privilege": "string"
}
],
"marker": "string",
"truncated": false
}
array of
AuthorizationPrivilegeChecksInfo
items
Required
Privilege checks that match the specifiedPrivilegeChecks.FilterSpec and PrivilegeChecks.IterationSpec in chronological order as they were performed. Each check is recorded only the first time it is made. If more than one privilege check matches a given PrivilegeChecks.FilterSpec (for example, two different opIDs checked System.Read for the same object and the same principal, a FilterSpec which specifies only the principal will only contain the first check).
string
marker
Required
An opaque marker indicating the last returned privilege check. If there are more privilege checks collected than were returned, the next ones can be retrieved directly by passing this value to another call to com.vmware.vcenter.authorization.PrivilegeChecks.list.
boolean
truncated
Required
In case PrivilegeChecks.IterationSpec.marker was specified and valid, but the privilege check indicated by it is no longer stored,
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if filter or iteration spec contain invalid values.
404
com.vmware.vapi.std.errors.not_found : if the iteration spec contains a marker that could not be found.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$StdDynamicID = Initialize-StdDynamicID -Type "MyType" -Id "MyId"
$AuthorizationPrivilegeChecksPrincipal = Initialize-AuthorizationPrivilegeChecksPrincipal -Name "MyName" -Domain "MyDomain"
$AuthorizationPrivilegeChecksFilterSpec = Initialize-AuthorizationPrivilegeChecksFilterSpec -Objects $StdDynamicID -Sessions "MySessions" -Principals $AuthorizationPrivilegeChecksPrincipal -Privileges "MyPrivileges" -OpIds "MyOpIds"
$AuthorizationPrivilegeChecksListRequestBody = Initialize-AuthorizationPrivilegeChecksListRequestBody -VarFilter $AuthorizationPrivilegeChecksFilterSpec
Invoke-ListAuthorizationPrivilegeChecks -AuthorizationPrivilegeChecksListRequestBody $AuthorizationPrivilegeChecksListRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"filter":{"op_ids":["string"],"principals":[{"domain":"string","name":"string"}],"privileges":["string"],"sessions":["string"]}}' https://{api_host}/api/vcenter/authorization/privilege-checks?action=list
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 8.0.0.0
