Tenant resources

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.

Data type

Method

Use

Access

Notes

.../tenants

tenant

PUT

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 on required and optional query parameters for creating tenants, see Query parameters for creating tenants.

List

GET

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, each listed tenant is the value of an element named name. In JSON, the name in the name/value pair that lists the tenants is name.

.../tenants/tenant-name

tenant

GET

Retrieve information about a tenant

For an HCP tenant, system-level user account with the monitor or administrator role or tenant-level user account with the monitor or administrator role

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

HEAD

Check for the existence of a tenant

For an HCP tenant, system-level user account with the monitor or administrator role or tenant-level user account with the monitor or administrator role

For the default tenant, system-level user account with the monitor or administrator role

 

tenant

POST

Modify a tenant

For an HCP tenant, system-level user account with the administrator role or tenant-level user account with the administrator role

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

Delete a tenant

System-level user account with the administrator role

The tenant cannot own any namespaces.

Not valid for the default tenant.

.../tenants/tenant-name/availableServicePlans

List

GET

Retrieve a list of the service plans that are available for the tenant to assign to its namespaces

Tenant-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
ServicePlan

GET

Retrieve information about a service plan that’s available for the tenant to assign to its namespaces

Tenant-level user account with the monitor or administrator role

Valid only if the tenant is configured to allow service plan selection.

.../tenants/tenant-name/chargebackReport

chargeback
Report

GET

Generate a chargeback report for a tenant

Tenant-level user account with the monitor or administrator role

Not valid for the default tenant.

Supported output formats are XML, JSON, and CSV.

For information on optional query parameters for generating chargeback reports, see Query parameters for generating chargeback reports.

For information on chargeback reports, see About chargeback reports.

.../tenants/tenant-name/consoleSecurity

consoleSecurity

GET

Retrieve the Tenant Management Console configuration for a tenant

Tenant-level user account with the security role

Not valid for the default tenant.

POST

Modify the Tenant Management Console configuration for a tenant

Tenant-level user account with the security role

.../tenants/tenant-name/contactInfo

contactInfo

GET

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

 

POST

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

 

.../tenants/tenant-name/emailNotification

email
Notification

GET

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

 

.../tenants/tenant-name/namespaceDefaults

namespace
Defaults

GET

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.

POST

Modify the default settings for namespace creation for a tenant

Tenant-level user account with the administrator role

.../tenants/tenant-name/permissions

List

GET

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

POST

Modify the list of permissions in the data access permission mask for a tenant

Tenant-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.

.../tenants/tenant-name/searchSecurity

searchSecurity

GET

Retrieve the Search Console configuration for a tenant

Tenant-level user account with the security role

Not valid for the default tenant.

POST

Modify the Search Console configuration for a tenant

Tenant-level user account with the security role

.../tenants/tenant-name/statistics

statistics

GET

Retrieve statistics about the content of the namespaces owned by 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

 

Trademarks and Legal Disclaimer

© 2017 Hitachi Data Systems Corporation. All rights reserved.