---
title: "Create a new tenant in the platform that will be the home for a set of resources."
method: POST
path: "/v2/organizations/{organization}/tenants"
tags: ["Tenants"]
---

# Create a new tenant in the platform that will be the home for a set of resources.

`POST /v2/organizations/{organization}/tenants`

## Request

- Base URL: `https://docs.tetrate.io` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.tetrate.io/v2/organizations/{organization}/tenants`
- Auth: none declared
- TypeScript: <https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api/docs/v2/organizations/:organization/tenants/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `organization` string, required

## Request body

- object
  - `name` string, required: The short name for the resource to be created.
  - `tenant` V2Tenant, required: `Tenant` is a self-contained entity within an organization in the Service Bridge hierarchy.
    - `fqn` string
    - `displayName` string
    - `etag` string
    - `description` string
    - `securityDomain` string: Security domains can be used to group different resources under the same security domain. Although security domain is not resource itself currently, it follows a fqn format `organizations/myorg/securitydomains/mysecuritydomain`, and a child cannot override any ancestor's security domain. Once a security domain is assigned to a _Tenant_, all the children resources will belong to that security domain in the same way a _Workspace_ belongs to a _Tenant_, a _Workspace_ will also belong to the security domain assigned to the _Tenant_. Security domains can also be used to define _Security settings Authorization rules_ in which you can allow or deny request from or to a security domain.
    - `deletionProtectionEnabled` boolean: When set, prevents the resource from being deleted. In order to delete the resource this property needs to be set to `false` first.
    - `configGenerationMetadata` V2ConfigGenerationMetadata: `ConfigGenerationMetadata` allows to setup extra metadata that will be added in the final Istio generated configurations. Like new labels or annotations. Defining the config generation metadata in tenancy resources (like organization, tenant, workspace or groups) works as default values for those configs that belong to it. Defining same config generation metadata in configuration resources (like ingress gateways, service routes, etc.) will replace the ones defined in the tenancy resources.
      - `labels` object: Set of key value paris that will be added into the `metadata.labels` field of the Istio generated configurations.
      - `annotations` object: Set of key value paris that will be added into the `metadata.annotations` field of the Istio generated configurations.

## Response `200`

A successful response.

- V2Tenant: `Tenant` is a self-contained entity within an organization in the Service Bridge hierarchy.
  - `fqn` string
  - `displayName` string
  - `etag` string
  - `description` string
  - `securityDomain` string: Security domains can be used to group different resources under the same security domain. Although security domain is not resource itself currently, it follows a fqn format `organizations/myorg/securitydomains/mysecuritydomain`, and a child cannot override any ancestor's security domain. Once a security domain is assigned to a _Tenant_, all the children resources will belong to that security domain in the same way a _Workspace_ belongs to a _Tenant_, a _Workspace_ will also belong to the security domain assigned to the _Tenant_. Security domains can also be used to define _Security settings Authorization rules_ in which you can allow or deny request from or to a security domain.
  - `deletionProtectionEnabled` boolean: When set, prevents the resource from being deleted. In order to delete the resource this property needs to be set to `false` first.
  - `configGenerationMetadata` V2ConfigGenerationMetadata: `ConfigGenerationMetadata` allows to setup extra metadata that will be added in the final Istio generated configurations. Like new labels or annotations. Defining the config generation metadata in tenancy resources (like organization, tenant, workspace or groups) works as default values for those configs that belong to it. Defining same config generation metadata in configuration resources (like ingress gateways, service routes, etc.) will replace the ones defined in the tenancy resources.
    - `labels` object: Set of key value paris that will be added into the `metadata.labels` field of the Istio generated configurations.
    - `annotations` object: Set of key value paris that will be added into the `metadata.annotations` field of the Istio generated configurations.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api.md) - [All operations](https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tetrate/apis/tetrate-service-bridge-api/revisions/2f19c3a1ae57?raw)