TaggingCategoryModel

The CategoryModel structure defines a category that is used to group one or more tags.


Properties

array of string
associable_types Required

The types of objects that the tags in this category can be attached to. If the set is empty, then tags can be attached to all types of objects. This field works only for objects that reside in Inventory Service (IS). For non IS objects, this check is not performed today and hence a tag can be attached to any non IS object.


cardinality Required

The associated cardinality (Cardinality) of the category.

Possible values are: SINGLEMULTIPLE


string
description Required

The description of the category.


string
id Required

The unique identifier of the category. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.tagging.Category. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.tagging.Category.


string
name Required

The display name of the category.


array of string
used_by Required

The set of users that can use this category. To add users to this, you need to have the edit privilege on the category. Similarly, to unsubscribe from this category, you need the edit privilege on the category. You should not modify other users subscription from this set.

JSON Example

{
    "associable_types": [
        "string"
    ],
    "cardinality": "enum",
    "description": "string",
    "id": "string",
    "name": "string",
    "used_by": [
        "string"
    ]
}
Returned By

Get Category
Feedback

Was this page helpful?