Tenant resources

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

.../tenants/tenant-name

Data typeMethodUseAccessNotes
tenantGETRetrieve 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/AHEADCheck 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
tenantPOSTModify 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 typeMethodUseAccessNotes
ListGETRetrieve 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 typeMethodUseAccessNotes
available ServicePlanGETRetrieve 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 typeMethodUseAccessNotes
chargeback ReportGETGenerate a chargeback report for a tenantTenant-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 typeMethodUseAccessNotes
consoleSecurityGETRetrieve the Tenant Management Console configuration for a tenantTenant-level user account with the security roleNot valid for the default tenant.
POSTModify the Tenant Management Console configuration for a tenantTenant-level user account with the security role

.../tenants/tenant-name/contactInfo

Data typeMethodUseAccessNotes
contactInfoGETRetrieve 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
POSTModify 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 typeMethodUseAccessNotes
corsPUTSet 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.
GETRetrieve 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
DELETEDelete 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 typeMethodUseAccessNotes
email NotificationGETRetrieve 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
POSTModify 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 typeMethodUseAccessNotes
namespace DefaultsGETRetrieve the default settings for namespace creation for a tenantTenant-level user account with the monitor or administrator roleNot valid for the default tenant.
POSTModify the default settings for namespace creation for a tenantTenant-level user account with the administrator role

.../tenants/tenant-name/permissions

Data typeMethodUseAccessNotes
ListGETRetrieve 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
ListPOSTModify 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 typeMethodUseAccessNotes
searchSecurityGETRetrieve the Search Console configuration for a tenantTenant-level user account with the security roleNot valid for the default tenant.
searchSecurityPOSTModify the Search Console configuration for a tenantTenant-level user account with the security roleNot valid for the default tenant.

.../tenants/tenant-name/statistics

Data typeMethodUseAccessNotes
statisticsGETRetrieve 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