Tenant

Tenant Create V1

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 default tag of the vendor organization. The Tenant Create V2 endpoint can be used to set tags explicitly.

post/1/tenants

Request

Base URL
http://localhost:3000/api
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/ironcorelabs/apis/vendor-api-bridge/docs/1/tenants/post.ts
A function with typed inputs. Its response is checked against the schema.

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

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.