REST API - service

vapi metadata privilege: service info

The service_info structure contains privilege information of a service element.

For an explanation of privilege information contained within service elements, see vapi.metadata.privilege.service.

Representation:

JSON
LEGACY JSON

{
    "operations" : {
        "obj-103" : {
            "privileges" : [
                "string",
                "string"
            ],
            "privilege_info" : [
                {
                    "privileges" : [
                        "string",
                        "string"
                    ],
                    "property_path" : "string"
                },
                {
                    "privileges" : [
                        "string",
                        "string"
                    ],
                    "property_path" : "string"
                }
            ]
        }
    }
}

{
    "operations" : [
        {
            "value" : {
                "privileges" : [
                    "string",
                    "string"
                ],
                "privilege_info" : [
                    {
                        "privileges" : [
                            "string",
                            "string"
                        ],
                        "property_path" : "string"
                    },
                    {
                        "privileges" : [
                            "string",
                            "string"
                        ],
                        "property_path" : "string"
                    }
                ]
            },
            "key" : "obj-103"
        }
    ]
}

Attributes:

Name	Type	Description
Required
-.operations	object	Information about all operation elements contained in this service element that contain privilege information. The key in the key/value pairs is the identifier of the operation element and the value in the key/value pairs is the privilege information for the operation element. For an explanation of containment of privilege information within operation elements, see vapi.metadata.privilege.service.operation. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: `com.vmware.vapi.operation`. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: `com.vmware.vapi.operation`.Object with element values of type operation_info.
-.operations.*	operation_info
-.operations.*.privileges	string[]	List of all privileges assigned to the operation element.
-.operations.*.privilege_info	privilege_info[]	Privilege information of all the parameter elements of the operation element. For an explanation of containment of privilege information within parameter elements, see vapi.metadata.privilege.privilege_info.
-.operations.*.privilege_info[].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.
-.operations.*.privilege_info[].privileges	string[]	List of privileges assigned to the entity that is being referred by vapi.metadata.privilege.privilege_info.property_path.

Attributes:

Name	Type	Description
Required
operations	list	Information about all operation elements contained in this service element that contain privilege information. The key in the key/value pairs is the identifier of the operation element and the value in the key/value pairs is the privilege information for the operation element. For an explanation of containment of privilege information within operation elements, see vapi.metadata.privilege.service.operation. When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: `com.vmware.vapi.operation`. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: `com.vmware.vapi.operation`.List of {"key": string, "value": operation_info}
operations[].key	string
operations[].value	operation_info
operations[].value.privileges	string[]	List of all privileges assigned to the operation element.
operations[].value.privilege_info	privilege_info[]	Privilege information of all the parameter elements of the operation element. For an explanation of containment of privilege information within parameter elements, see vapi.metadata.privilege.privilege_info.
operations[].value.privilege_info[].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.
operations[].value.privilege_info[].privileges	string[]	List of privileges assigned to the entity that is being referred by vapi.metadata.privilege.privilege_info.property_path.