Vcenter Authorization Permissions list

Queries the authorization permissions in the vCenter Server matching given criteria.

This operation was added in vSphere API 9.0.0.0.

Request

URI

POST

https://{api_host}/api/vcenter/authorization/permissions?action=list

COPY

Request Body

Request body for invoking operation: list

{
    "filter": {
        "objects": [
            {
                "type": "string",
                "id": "string"
            }
        ],
        "principals": [
            {
                "type": "string",
                "name": "string",
                "domain": "string"
            }
        ],
        "roles": [
            "string"
        ],
        "is_propagating": false
    },
    "iterate": "Vcenter Authorization Permissions IterationSpec Object"
}

Vcenter Authorization Permissions FilterSpec

filter

Optional

The Vcenter Authorization Permissions FilterSpec schema contains properties based on which authorization permissions can be filtered. Any permission matching all of the conditions is returned.

This schema was added in vSphere API 9.0.0.0.

Vcenter Authorization Permissions IterationSpec

iterate

Optional

The Vcenter Authorization Permissions IterationSpec schema contains properties used to break results into pages when listing permissions, see POST /vcenter/authorization/permissions?action=list).

This schema was added in vSphere API 9.0.0.0.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

200

Detailed information about the permissions.

Returns Vcenter Authorization Permissions ListResult of type(s) application/json

"Vcenter Authorization Permissions ListResult Object"

array of object

items

Required

The permissions that match the specifiedVcenter Authorization Permissions FilterSpec and Vcenter Authorization Permissions IterationSpec in lexicographical order.

This property was added in vSphere API 9.0.0.0.

string

marker

Optional

An opaque marker indicating the last returned permission. If there are more permissions 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 permissions have been returned.

400

if both filter and marker are passed

Returns Vapi Std Errors InvalidArgument of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0

"Vapi Std Errors InvalidArgument Object"

401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0

"Vapi Std Errors Unauthenticated Object"

string

challenge

Optional

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.

500

if an error occurred while getting the data.

Returns Vapi Std Errors Error of type(s) application/json

"Vapi Std Errors Error Object"

array of object

messages

Required

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.

object

data

Optional

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.

string

error_type

Required

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.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/vcenter/authorization/permissions?action=list

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Vcenter Operations

POST

Vcenter Authorization Permissions create

GET