Vapi Metadata Privilege Package get

Vapi Metadata Privilege Package get

Retrieves privilege information about the package element corresponding to packageId.

Request
URI
GET
https://{api_host}/api/vapi/metadata/privilege/package/{packageId}
COPY
Path Parameters
string
packageId
Required

Identifier of the package element.

The parameter must be an identifier for the resource type: com.vmware.vapi.package.


Authentication
This operation uses the following authentication methods.
Responses
200

The Vapi Metadata Privilege PackageInfo instance that corresponds to packageId

Returns Vapi Metadata Privilege PackageInfo of type(s) application/json
{
    "privileges": [
        "string"
    ],
    "services": {
        "services": {
            "operations": {
                "operations": {
                    "privileges": [
                        "string"
                    ],
                    "privilege_info": [
                        {
                            "property_path": "string",
                            "privileges": [
                                "string"
                            ]
                        }
                    ]
                }
            }
        }
    }
}
array of string
privileges
Required

List of default privileges to be used for all the operations present in this package. If a particular operation element has no explicit privileges defined in the privilege definition file, these privileges are used for enforcing authorization.

object
services
Required

Information about all service elements contained in this package element that contain privilege information. The key in the map is the identifier of the service element and the value in the map is the privilege information for the service element.

For an explanation of privilege information containment within service elements, see Vapi Metadata Privilege Service.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vapi.service.


404

if the package element associated with packageId does not have any privilege information.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vapi/metadata/privilege/package/{packageId}