Tenant

Tenant Get

Get information about the provided tenant.

get/1/tenants/{tenantId}

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/:tenantId/get.ts
A function with typed inputs. Its response is checked against the schema.

Headers

icl-requestor-idstring required

ID of requesting user/service

Response

Result of getting a tenant. Same as TenantCreateResponse but with the addition of primaryKmsConfigId.

idstring required

Tenant ID

namestring required

archivedboolean required

tenantCreatedConfigsboolean required

invitedboolean required

If true, this tenant has been invited, but not yet accepted their invitation.

keyLeasingRequiredboolean required

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

primaryKmsConfigIdinteger nullable required

createdstring required

RFC3339 timestamp

updatedstring required

RFC3339 timestamp

Example response

{
  "id": "tenant-icl",
  "tags": [
    {
      "created": "2022-01-13T21:44:43.653Z"
    }
  ],
  "createdBy": {
    "id": "vendor",
    "name": "Vendor",
    "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.