Tenant resources

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

Tenant resources let you create, retrieve information about, modify, and delete tenants. The tables below provides information about these resources.

.../tenants/tenant-name

Data type Method Use Access Notes
tenant GET Retrieve information about 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
 
N/A HEAD Check for the existence of 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
tenant POST Modify 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/availableServicePlans

Data type Method Use Access Notes
List GET Retrieve a list of the service plans that are available for the tenant to assign to its namespaces
  • 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

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

Data type Method Use Access Notes
available ServicePlan GET Retrieve information about a service plan that’s available for the tenant to assign to its namespaces
  • 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
Valid only if the tenant is configured to allow service plan selection.

.../tenants/tenant-name/chargebackReport

Data type Method Use Access Notes
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.

.../tenants/tenant-name/consoleSecurity

Data type Method Use Access Notes
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

Data type Method Use Access Notes
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/cors

Data type Method Use Access Notes
cors 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.

.../tenants/tenant-name/emailNotification

Data type Method Use Access Notes
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

Data type Method Use Access Notes
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

Data type Method Use Access Notes
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
 
List POST 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.

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.

.../tenants/tenant-name/searchSecurity

Data type Method Use Access Notes
searchSecurity GET Retrieve the Search Console configuration for a tenant Tenant-level user account with the security role Not valid for the default tenant.
searchSecurity POST Modify the Search Console configuration for a tenant Tenant-level user account with the security role Not valid for the default tenant.

.../tenants/tenant-name/statistics

Data type Method Use Access Notes
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