REST API - privilege

vapi metadata privilege: privilege info

The privilege_info structure contains the privilege information for a parameter element in an operation element.

Representation:

JSON

{
    "privileges": [
        "string",
        "string"
    ],
    "property_path": "string"
}

Attributes:

Name Type Description

Required

Name	Type	Description
Required
property_path	string	The `property_path` points to an entity that is used in the operation element. An entity can either be present in one of the parameter elements or if a parameter is a structure element, it could also be present in one of the field elements. If the privilege is assigned to an entity used in the parameter, `property_path` will just contain the name of the parameter field. If the privilege is assigned to an entity in one of the field elements of a parameter element that is a structure element, then `property_path` will contain a path to the field element starting from the parameter name.
privileges	string[]	List of privileges assigned to the entity that is being referred by vapi.metadata.privilege.privilege_info.property_path.

property_path

string

The property_path points to an entity that is used in the operation element. An entity can either be present in one of the parameter elements or if a parameter is a structure element, it could also be present in one of the field elements.

If the privilege is assigned to an entity used in the parameter, property_path will just contain the name of the parameter field. If the privilege is assigned to an entity in one of the field elements of a parameter element that is a structure element, then property_path will contain a path to the field element starting from the parameter name.

privileges

string[]

List of privileges assigned to the entity that is being referred by vapi.metadata.privilege.privilege_info.property_path.