Tenant resources let you create, retrieve information about, modify, and delete tenants. The table below provides information about these resources.
![]() |
Note: The management API is automatically enabled for tenants you create through the management API. |
Method |
Use |
Access |
Notes |
|
---|---|---|---|---|
tenant |
Create an HCP tenant or the default tenant and namespace |
System-level user account with the administrator role |
You can create the default tenant and namespace only if this is allowed by the HCP system configuration. For information about required and optional query parameters for creating tenants, see Query parameters for creating tenants. |
|
List |
Retrieve a list of the tenants defined in an HCP system |
System-level user account with the monitor or administrator role |
The listed tenants are identified by tenant name. In XML, the element that identifies each tenant is name. The root element for the list of tenants is tenants. In JSON, the name in the name/value pair that lists the tenants is name. |
|
tenant |
Retrieve information about a tenant |
•For an HCP tenant, •For the default tenant, system-level user account with the monitor or administrator role |
For an HCP tenant, the information returned depends on whether you’re using a system-level or tenant-level user account. |
|
N/A |
Check for the existence of a tenant |
•For an HCP tenant, •For the default tenant, system-level user account with the monitor or administrator role |
|
|
tenant |
Modify a tenant |
•For an HCP tenant •For the default tenant, system-level user account with the administrator role |
For an HCP tenant, the information you can modify depends on whether you’re using a system-level or tenant-level user account. |
|
N/A |
Delete a tenant |
System-level user account with the administrator role |
The tenant cannot own any namespaces. Not valid for the default tenant. |
|
List |
Retrieve a list of the service plans that are available for the tenant to assign to its namespaces |
•For an HCP tenant, •For the default tenant, system-level user account with the monitor or administrator role |
Valid only if the tenant is configured to allow service plan selection. The listed service plans are identified by service plan name. In XML, each listed service plan is the value of an element named name. In JSON, the name in the name/value pair that lists the service plans is name. |
|
.../tenants/tenant-name/availableServicePlans/service-plan-name |
||||
available |
Retrieve information about a service plan that’s available for the tenant to assign to its namespaces |
•For an HCP tenant, •For the default tenant, system-level user account with the monitor or administrator role |
Valid only if the tenant is configured to allow service plan selection. |
|
chargeback |
Generate a chargeback report for a tenant |
|
Not valid for the default tenant. Supported output formats are XML, JSON, and CSV. For information about optional query parameters for generating chargeback reports, see Query parameters for generating chargeback reports. For information about chargeback reports, see About chargeback reports. |
|
consoleSecurity |
Retrieve the Tenant Management Console configuration for a tenant |
Tenant-level user account with the security role |
Not valid for the default tenant. |
|
Modify the Tenant Management Console configuration for a tenant |
Tenant-level user account with the security role |
|||
contactInfo |
Retrieve the contact information for a tenant |
•For an HCP tenant, tenant-level user account with the monitor or administrator role •For the default tenant, system-level user account with the monitor or administrator role |
|
|
Modify the contact information for a tenant |
•For an HCP tenant, tenant-level user account with the administrator role •For the default tenant, system-level user account with the administrator role |
|
||
cors See cors data type |
PUT | Set the default CORS rules configuration for all namespaces owned by the tenant |
•System-level user account with the administrator role •Tenant-level user account with the administrator role |
If the default tenant-level CORS configuration is set, it is applicable for all namespaces that do not have a namespace-level CORS configuration. |
GET | Retrieve the default CORS configuration for all namespaces owned by the tenant |
•System-level user account with the monitor or administrator role •Tenant-level user account with the monitor or administrator role |
||
DELETE | Delete the default CORS configuration for all namespaces owned by the tenant |
•System-level user account with the administrator role •Tenant-level user account with the administrator role |
If the resource does not have a default CORS configuration, the HTTP status code 404 Not Found is returned. | |
email |
Retrieve the email notification configuration for a tenant |
•For an HCP tenant, tenant-level user account with the monitor or administrator role •For the default tenant, system-level user account with the with the monitor or administrator role |
|
|
POST |
Modify the email notification configuration for a tenant |
•For an HCP tenant, tenant-level user account with the administrator role •For the default tenant, system-level user account with the administrator role |
|
|
namespace |
Retrieve the default settings for namespace creation for a tenant |
Tenant-level user account with the monitor or administrator role |
Not valid for the default tenant. |
|
Modify the default settings for namespace creation for a tenant |
Tenant-level user account with the administrator role |
|||
List |
Retrieve the list of permissions in the data access permission mask for a tenant |
•For an HCP tenant, tenant-level user account with the monitor, administrator, or compliance role •For the default tenant, system-level user account with the monitor, administrator, or compliance role |
For the format of the permission list, see Permission lists. |
|
List |
Modify the list of permissions in the data access permission mask for a tenant |
•For an HCP tenant, tenant-level user account with the administrator role •For the default tenant, system-level user account with the administrator role |
Valid values for permissions are: •DELETE •PRIVILEGED •PURGE •READ •SEARCH •WRITE These values are case sensitive. For the format of the permission list, see Permission lists. The set of permissions specified in the request body replaces the set of permissions currently included in the data access permission mask for the tenant. To remove all permissions, specify an empty list. If the set of permissions includes PURGE, delete permission is enabled automatically. If the set of permissions includes SEARCH, read permission is enabled automatically. By default, when you create a tenant, its data access permission mask includes all permissions. |
|
searchSecurity |
Retrieve the Search Console configuration for a tenant |
Tenant-level user account with the security role |
Not valid for the default tenant. |
|
Modify the Search Console configuration for a tenant |
Tenant-level user account with the security role |
|||
statistics |
Retrieve statistics about the content of the namespaces owned by a tenant |
•For an HCP tenant, •For the default tenant, system-level user account with the monitor or administrator role |
|
© 2015, 2020 Hitachi Vantara LLC. All rights reserved.