tenant (data type for tenant resource)
The tenant data type in this section describes the tenants
resource.
When you create an HCPtenant, you need to specify query parameters that define the initial user account for the tenant. When you create the default tenant, you need to specify query parameters that further define the default namespace.
Properties
The table below describes the properties included in the tenant
data type that describes the tenants
resource.
Property | Data type | Description | Notes |
administrationAllowed | Boolean |
For an HCP tenant, specifies whether system-level users have administrative access to the tenant. Valid values are:
The default is false. | This property is not valid for the default tenant. |
authenticationTypes | String |
For an HCP tenant, lists the types of user authentication supported by the tenant. Possible authentication types are:
|
This property is not valid on a POST request. It is returned only by a verbose GET request. In XML, each listed authentication type is the value of an element named This property is not valid for the default tenant. |
complianceConfiguration Enabled | Boolean |
For an HCP tenant, specifies whether the tenant can set the retention mode of the namespaces it owns. Possible values are:
|
This property is not valid on a POST request. It is returned only by a verbose GET request. This property is not valid for the default tenant. In enterprise mode, privileged deletes are allowed, retention class durations can be shortened, and retention classes can be deleted. In compliance mode, these activities are not allowed. |
creationTime | String |
Specifies the date and time at which the tenant was created, in this ISO 8601 format:
( For example: 2017-02-09T19:26:32-0500 | This property is not valid on a POST request. It is returned only by a verbose GET request. |
fullyQualifiedName | String | Specifies the fully qualified hostname of the tenant. | This property is not valid on a POST request. It is returned only by a verbose GET request. |
hardQuota | String |
For an HCP tenant, specifies the total amount of space available to the tenant for allocation to its namespaces. Possible values are decimal numbers with up to two places after the period, followed by a space, followed by MB, GB, or TB (for example, 10.25 TB). The minimum value is 1 (one) for GB and .01 for TB. |
This property is not valid on a POST request. It is returned only by a verbose GET request. This property is not valid for the default tenant. |
id | String | Specifies the system-supplied unique ID for the tenant. HCP generates this ID automatically when you create a tenant. | This property is not valid on a POST request. It is returned only by a verbose GET request. |
maxNamespacesPer User | integer |
For an HCP tenant, specifies the maximum number of namespaces that can be owned at one time by any given user. Valid values are zero through 10,000. The default is 100. | This property is not valid for the default tenant. |
name | String |
Specifies the name of the tenant. HCP derives the hostname for the tenant from this name. The hostname is used in URLs for access to the tenant and its namespaces. The name of the default tenant is always Default. |
This property is not valid on a POST request. It is returned only by a verbose GET request for an HCP tenant. This property is not returned by any GET request for the default tenant. The tenant name is used in the URL for access to the tenant. |
namespaceQuota | String |
For an HCP tenant, specifies the number of namespaces HCP reserves for the tenant out of the total number of namespaces the system can have. This is also maximum number of namespaces the tenant can own at any given time. Possible values are:
|
This property is not valid on a POST request. It is returned only by a verbose GET request. This property is not valid for the default tenant. |
replicationConfiguration Enabled | Boolean |
For an HCP tenant, specifies whether the tenant is eligible for replication. Possible values are:
|
This property is not valid on a POST request. It is returned only by a verbose GET request. This property is not valid for the default tenant. If the HCP system supports replication, directories in the default namespace are automatically eligible for replication. |
searchConfiguration Enabled | Boolean |
For an HCP tenant, specifies whether the tenant can enable and disable search for the namespaces it owns. Possible values are:
|
This property is not valid on a POST request. It is returned only by a verbose GET request. This property is not valid for the default tenant. |
snmpLoggingEnabled | Boolean |
Specifies whether tenant log messages are sent to the SNMP managers specified at the HCP system level. Valid values are:
The default is false. | |
softQuota | Integer |
For an HCP tenant, specifies the percentage point at which HCP notifies the tenant that free storage space is running low. Possible values are integers in the range zero through 100. |
This property is not valid on a POST request. It is returned only by a verbose GET request. This property is not valid for the default tenant. |
syslogLoggingEnabled | Boolean |
Specifies whether tenant log messages are sent to the syslog servers specified at the HCP system level. Valid values are:
The default is false. | |
tenantVisibleDescription | String |
Specifies the tenant-level description of the tenant. This description is optional. The default is no description. To remove a tenant-level description from an existing tenant, specify the | |
versioningConfiguration Enabled | Boolean |
For an HCP tenant, specifies whether the tenant's namespaces can have versioning enabled. Possible values are:
|
This property is not valid on a POST request. It is returned only by a verbose GET request. This property is not valid for the default tenant. |
Example
Here’s an XML example of the tenant
data type that describes the tenants
resource; the properties shown are those that are returned in response to a verbose GET request for an HCP tenant where the request is made using a tenant-level user account that includes the administrator role:
<tenant> <administrationAllowed>true</administrationAllowed> <authenticationTypes> <authenticationType>LOCAL</authenticationType> <authenticationType>RADIUS</authenticationType> </authenticationTypes> <complianceConfigurationEnabled>true</complianceConfigurationEnabled> <creationTime>2017-02-09T09:11:17-0500</creationTime> <fullyQualifiedName>Finance.hcp.example.com</fullyQualifiedName> <hardQuota>100 GB</hardQuota> <maxNamespacesPerUser>5</maxNamespacesPerUser> <name>Finance</name> <namespaceQuota>5</namespaceQuota> <replicationConfigurationEnabled>true</replicationConfigurationEnabled> <snmpLoggingEnabled>false</snmpLoggingEnabled> <searchConfigurationEnabled>true</searchConfigurationEnabled> <softQuota>90</softQuota> <syslogLoggingEnabled>true</syslogLoggingEnabled> <tenantVisibleDescription>Please see Lee Green for any questions about this tenant and its namespaces.</tenantVisibleDescription> <id>4420f62f-3f63-43ab-a3cd-0bcf1f399daf</id> <versioningConfigurationEnabled>true</versioningConfigurationEnabled> </tenant>
Query parameters for creating tenants
When you create a tenant, you need to specify query parameters on the resource URL. These parameters differ for HCP tenants and the default tenant.
HCP tenant query parameters
When you create an HCP tenant, HCP automatically creates the initial user or group account for the tenant, depending on which query parameters you include in the PUT request.
Creating an initial user account
To create a tenant with an initial user account, you use these query parameters, which correspond to user account properties with the same name:
username
This parameter is required when you create a tenant. The user name you specify is also used as the full name for the user account.
password
This parameter is required when you create a tenant.
forcePasswordChange
This parameter is optional when you create a tenant. The default is false.
The user account that’s created:
- Is enabled
- Is locally authenticated
- Has only the security role
- Has no data access permissions
- Has no description
The username, password, and forcePasswordChange query parameters are valid only when you create an HCP tenant and only if you enable local authentication for the tenant in the same request. They are not valid on a request to modify a tenant.
Creating an initial group account
To create the tenant with an initial group account, you use the initialSecurityGroup query parameter. The value of this parameter must be the name or SID of an AD group defined in the AD forest supported by HCP. You can specify the name in either of these formats:
group-name
group-name@ad-domain-name
If you omit the domain name, HCP uses the AD domain specified in the system configuration.
Be sure to use the second format if a group with the specified name exists in more than one domain in the AD forest or if the group name looks like a SID.
The group account that’s created:
- Has only the security role
- Has no data access permissions
The initialSecurityGroup query parameter is valid only when you create an HCP tenant and only if you enable AD authentication for the tenant in the same request. It is not valid on a request to modify a tenant.
Default tenant query parameters
When you create the default tenant, HCP automatically creates the default namespace. To provide information about this namespace, you use these query parameters, which correspond to namespace properties with the same name:
enterpriseMode
This parameter is required when you create the default tenant.
hashScheme
This parameter is required when you create the default tenant.
searchEnabled
This parameter is optional when you create the default tenant. The default is false. (By default, if you specify searchEnabled=true, search indexing is enabled. Otherwise, search indexing is disabled by default.)
servicePlan
This parameter is optional when you create the default tenant. The default is Default.
These query parameters are valid only when you create the default tenant. They are not valid on requests to modify the tenant.