Resources and properties

Content Platform Tenant Management Help

File Size
4269 KB
Part Number

Each entity that you can manage independently in the HCP management API is called a resource. Examples of resources are tenants and namespaces.

Resources have properties. The values of these properties describe the resource. For example, tenant properties include the tenant name, description, and whether system-level users can manage the tenant.

Some properties are treated as resources in their own right. For example, the Tenant Management Console configuration is a property of a tenant, but it is treated as a resource.

To identify a resource, you use a URL. For example, this URL identifies the tenant resource named Finance in the HCP system named

You also use URLs to identify lists of resources. For example, this URL identifies the list of namespaces owned by the Finance tenant:

Each URL that identifies a resource or list of resources has a data type. For a list of resources, the data type is list. For an individual resource, the data type is a named unordered set of properties. For example, the data type for the retention class resource is retentionClass. The properties included in this data type are name, value, description, and allowDisposition.

Properties also have data types. The data type of a property can be string, integer, long, Boolean, or list, or it can be another named unordered set of properties. For example, the name property for a tenant resource has a data type of string. The ipSettings property for a Tenant Management Console configuration resource has a data type of ipSettings.