The tenant data type in this section describes the tenants resource.
When you create an HCP tenant, 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.
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.
- 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.