Create/add a new tenant to the Cohesity Cluster.

post

https://cluster.ip.address/irisservices/api/v1/public/tenants

Privileges: ORGANIZATION_MODIFY

A tenant is required to support MultiTenant architecture for service provider
(SP) to facilitate data and view segregations in the Cohesity Dashboard.

Returns the created/added tenant.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to add or create a new tenant.

Specifies the settings used to create/add a new tenant.

bifrostEnabled

boolean | null

Specifies whether bifrost (Ambassador proxy) is enabled for tenant.

clusterHostname

string | null

The hostname for Cohesity cluster as seen by tenants and as is routable
from the tenant's network. Tenant's VLAN's hostname, if available can be
used instead but it is mandatory to provide this value if there's no VLAN
hostname to use. Also, when set, this field would take precedence over
VLAN hostname.

clusterIps

array of strings | null

Set of IPs as seen from the tenant's network for the Cohesity cluster.
Only one from 'ClusterHostname' and 'ClusterIps' is needed.

clusterIps

dataSourceConnectorEnabled

boolean | null

Specifies whether data source connector is enabled for the tenant.

description

string | null

Specifies the description of this tenant.

isManagedOnHelios

boolean | null

Specifies whether this tenant is manged on helios

name

string | null

Specifies the name of the tenant.

orgSuffix

string | null

Specifies the organization suffix needed to construct tenant id. Tenant id
is not completely auto generated rather chosen by tenant/SP admin as we
needed same tenant id on multiple clusters to support replication across
clusters, etc.

parentTenantId

string | null

Specifies the parent tenant of this tenant if available.

subscribeToAlertEmails

boolean | null

Service provider can optionally unsubscribe from the Tenant Alert Emails.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Create Tenants response

defaultError