vapi metadata privilege: component info
The
component_info structure contains the privilege information of a component element. For an explanation of privilege information contained within component elements, see vapi.metadata.privilege.component.
Representation:
{
"packages" : {
"obj-103" : {
"privileges" : [
"string",
"string"
],
"services" : {
"obj-103" : {
"operations" : {
"obj-103" : {
"privileges" : [
"string",
"string"
],
"privilege_info" : [
{
"privileges" : [
"string",
"string"
],
"property_path" : "string"
},
{
"privileges" : [
"string",
"string"
],
"property_path" : "string"
}
]
}
}
}
}
}
}
}
"packages" : {
"obj-103" : {
"privileges" : [
"string",
"string"
],
"services" : {
"obj-103" : {
"operations" : {
"obj-103" : {
"privileges" : [
"string",
"string"
],
"privilege_info" : [
{
"privileges" : [
"string",
"string"
],
"property_path" : "string"
},
{
"privileges" : [
"string",
"string"
],
"property_path" : "string"
}
]
}
}
}
}
}
}
}
{
"packages" : [
{
"value" : {
"privileges" : [
"string",
"string"
],
"services" : [
{
"value" : {
"operations" : [
{
"value" : {
"privileges" : [
"string",
"string"
],
"privilege_info" : [
{
"privileges" : [
"string",
"string"
],
"property_path" : "string"
},
{
"privileges" : [
"string",
"string"
],
"property_path" : "string"
}
]
},
"key" : "obj-103"
}
]
},
"key" : "obj-103"
}
]
},
"key" : "obj-103"
}
]
}
"packages" : [
{
"value" : {
"privileges" : [
"string",
"string"
],
"services" : [
{
"value" : {
"operations" : [
{
"value" : {
"privileges" : [
"string",
"string"
],
"privilege_info" : [
{
"privileges" : [
"string",
"string"
],
"property_path" : "string"
},
{
"privileges" : [
"string",
"string"
],
"property_path" : "string"
}
]
},
"key" : "obj-103"
}
]
},
"key" : "obj-103"
}
]
},
"key" : "obj-103"
}
]
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| -.packages | object | Privilege information of all the package elements. The key in the key/value pairs is the identifier of the package element and the value in the key/value pairs is the privilege information for the package element. For an explanation of privilege information containment within package elements, see vapi.metadata.privilege.package. 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.package. 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.package.Object with element values of type package_info. |
| -.packages.* | package_info | |
| -.packages.*.privileges | string[] | 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. |
| -.packages.*.services | object | Information about all service elements contained in this package element that contain privilege information. The key in the key/value pairs is the identifier of the service element and the value in the key/value pairs 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 structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vapi.service. 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.service.Object with element values of type service_info. |
| -.packages.*.services.* | service_info | |
| -.packages.*.services.*.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. |
| -.packages.*.services.*.operations.* | operation_info | |
| -.packages.*.services.*.operations.*.privileges | string[] | List of all privileges assigned to the operation element. |
| -.packages.*.services.*.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. |
| -.packages.*.services.*.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, |
| -.packages.*.services.*.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 | ||
| packages | list | Privilege information of all the package elements. The key in the key/value pairs is the identifier of the package element and the value in the key/value pairs is the privilege information for the package element. For an explanation of privilege information containment within package elements, see vapi.metadata.privilege.package. 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.package. 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.package.List of {"key": string, "value": package_info} |
| packages[].key | string | |
| packages[].value | package_info | |
| packages[].value.privileges | string[] | 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. |
| packages[].value.services | list | Information about all service elements contained in this package element that contain privilege information. The key in the key/value pairs is the identifier of the service element and the value in the key/value pairs 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 structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vapi.service. 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.service.List of {"key": string, "value": service_info} |
| packages[].value.services[].key | string | |
| packages[].value.services[].value | service_info | |
| packages[].value.services[].value.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} |
| packages[].value.services[].value.operations[].key | string | |
| packages[].value.services[].value.operations[].value | operation_info | |
| packages[].value.services[].value.operations[].value.privileges | string[] | List of all privileges assigned to the operation element. |
| packages[].value.services[].value.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. |
| packages[].value.services[].value.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, |
| packages[].value.services[].value.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. |