Vcenter Authorization Roles list
Queries the authorization roles in the vCenter Server matching given criteria.
This operation was added in vSphere API 9.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
System.Read.
Return only roles matching the specified filters.
If missing or null return all roles.
Names of the roles.
This property was added in vSphere API 9.0.0.0.
If missing or null all roles match.
The Vcenter Authorization Privileges part of the role.
This property was added in vSphere API 9.0.0.0.
If missing or null all roles match.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.authorization.Privilege. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.authorization.Privilege.
allows to iterate over the set of roles.
if missing or null, only the first roles that fit in a size defined by the service will be returned.
Detailed information about the roles.
"Vcenter Authorization Roles ListResult Object"The roles that match the specifiedVcenter Authorization Roles FilterSpec and Vcenter Authorization Roles IterationSpec in lexicographical order.
This property was added in vSphere API 9.0.0.0.
An opaque marker indicating the last returned role. If there are more roles collected than were returned, the next ones can be retrieved directly by passing this value to another call to #list.
This property was added in vSphere API 9.0.0.0.
If missing or null then all of the currently available roles have been returned.
if filterSpec or iterationSpec contain invalid data
"Vapi Std Errors InvalidArgument Object"if the user can not be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if an error occurred while getting the data.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/authorization/roles