IRironcorelabs
Tenant

Tenant Create V2

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).

post/2/tenants

Request

Headers

icl-requestor-idstring required

ID of requesting user/service

Request body

idstring required

Tenant ID

namestring required

Name for new tenant

tenantAdminEmailstring

Optional email addresss to send tenant invite to

tagsTagId[]

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.

Example request

{
  "id": "string",
  "name": "string"
}

Response

Result of creating a tenant

idstring required

Tenant ID

namestring required

Tenant name

tenantCreatedConfigsboolean required

Has the tenant created their own KMS configurations?

emailSentboolean required

Whether an invitation was sent to the tenant email (if provided)

keyLeasingRequiredboolean required

Whether key leasing must be enabled for all KMS configurations assigned to this tenant.

archivedboolean required

Is the tenant archived?

createdstring required

RFC3339 timestamp

updatedstring required

RFC3339 timestamp

Example response

{
  "id": "string",
  "name": "string",
  "tenantCreatedConfigs": true,
  "archived": true,
  "createdBy": {
    "id": "string",
    "name": "string",
    "type": "Vaa"
  },
  "created": "2022-01-13T21:44:43.653Z",
  "updated": "2022-01-13T21:44:43.653Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.