Create a tenant organization (Beta)

POST

/v2/tenants

POST

/v2/tenants

$ curl -X POST https://api.sigmacomputing.com/v2/tenants \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "tenantOrganizationName": "Acme Analytics",
>   "tenantOrganizationSlug": "acme-analytics"
> }'

200Successful

1 {
2   "tenantOrganizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
3   "parentOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
4   "createdBy": "user-9876543210abcdef",
5   "updatedBy": "user-9876543210abcdef",
6   "createdAt": "2024-01-15T09:30:00Z",
7   "updatedAt": "2024-01-15T09:30:00Z",
8   "tenantOrganizationName": "Acme Analytics",
9   "tenantOrganizationSlug": "acme-analytics",
10   "sharedAt": "2024-01-15T09:30:00Z",
11   "tenantCloudProvider": "aws-us-a",
12   "tenantRegion": "us-east-1",
13   "tenantApiUrl": "https://api.us-a.aws.sigmacomputing.com/tenants/acme-analytics"
14 }

Create a new tenant organization with the specified name and organization slug to be used in the URL.

Beta: This documentation describes a public beta feature and is subject to the Beta features disclaimer.

Usage notes

To perform this operation, you must use API credentials owned by a user assigned the Admin account type.
The tenantOrganizationName is displayed as the organization name in the Sigma interface.
The tenantOrganizationSlug must be unique and is used in URLs to identify the tenant organization.

Create a new tenant organization with the specified name and organization slug to be used in the URL. **Beta**: This documentation describes a public beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### Usage notes - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. - The **tenantOrganizationName** is displayed as the organization name in the Sigma interface. - The **tenantOrganizationSlug** must be unique and is used in URLs to identify the tenant organization.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.

tenantOrganizationNamestringRequired

Name of the tenant organization to create

tenantOrganizationSlugstringRequired

URL identifier for the tenant organization

cloudProviderenumOptional

Cloud provider to create the tenant organization in. Defaults to the same cloud provider as the parent organization

Response

The response body.

tenantOrganizationIdstring

Unique identifier of the tenant organization

parentOrganizationIdstring

Unique identifier of the tenant's parent organization

createdBystring

Unique identifier of the user who created the tenant organization

updatedBystring

Unique identifier of the user who last updated the tenant organization

createdAtdatetime

Timestamp when the tenant organization was created. Format: ISO 8601 timestamp

updatedAtdatetime

Timestamp when the tenant organization was last updated. Format: ISO 8601 timestamp

tenantOrganizationNamestring

Name of the tenant organization to create

tenantOrganizationSlugstring

URL identifier for the tenant organization

sharedAtdatetime

Timestamp when the tenant organization was shared, if applicable. Format: ISO 8601 timestamp

tenantCloudProviderstring

Cloud provider the tenant organization is hosted on

tenantRegionstring

Region the tenant organization is hosted in

tenantApiUrlstring

Base URL for accessing the tenant organization API