---
title: "Tenant Create V2"
method: POST
path: "/2/tenants"
tags: ["Tenant"]
---

# Tenant Create V2

`POST /2/tenants`

## Request

- Base URL: `http://localhost:3000/api`
- URL: `http://localhost:3000/api/2/tenants`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge/docs/2/tenants/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a new tenant with the provided ID and name.  
If `tenantAdminEmail` is provided, an invite email will be sent to the tenant to claim their account.
The Tenant ID will be needed for all subsequent tenant calls.
The tenant will be created with the provided tags. If no tags are provided, the tenant will be untagged and its associated KMS configs will not be sent to any TSPs.
The tenant will be required to support key leasing for all of its KMS configurations if set in your vendor's Organization Settings in the Config Broker UI (can be updated after creation from Vendor Bridge).

## Headers

- `icl-requestor-id` string, required

## Request body

- object
  - `id` string, required: Tenant ID
  - `name` string, required: Name for new tenant
  - `tenantAdminEmail` string: Optional email addresss to send tenant invite to
  - `tags` TagId[]: Tag IDs to assign to the tenant after creation. If no tags are provided, this tenant's KMS configurations will not be sent to any TSPs.

## Response `200`

Result of creating a tenant

- object
  - `id` string, required: Tenant ID
  - `name` string, required: Tenant name
  - `tenantCreatedConfigs` boolean, required: Has the tenant created their own KMS configurations?
  - `emailSent` boolean, required: Whether an invitation was sent to the tenant email (if provided)
  - `keyLeasingRequired` boolean, required: Whether key leasing must be enabled for all KMS configurations assigned to this tenant.
  - `archived` boolean, required: Is the tenant archived?
  - `tags` Tag[], required
    - `id` integer, required: Tag ID
    - `tagText` string, required: Human-readable text associated with tag
    - `default` boolean, required: Whether this is the default tag for tenants/service accounts
    - `created` string, required: RFC3339 timestamp
  - `createdBy` CreatedBy, required: Metadata about creating user/service
    - `id` string, required: Creator ID
    - `name` string, required: Creator name
    - `type` 'Tsp' | 'Admin' | 'Va', required: Creator type
  - `created` string, required: RFC3339 timestamp
  - `updated` string, required: RFC3339 timestamp

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge.md) - [All operations](https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge/llms.txt) - [OpenAPI document](https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge/revisions/5c0e553ffa21?raw)