Tenant

Tenant Update

Update a tenant's name, key leasing requirement, or the tenant's assigned tags.

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

icl-requestor-idstring required

ID of requesting user/service

namestring

New name for tenant

keyLeasingRequiredboolean

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

tagAdditionsTagId[]

Tags to assign to the tenant

tagRemovalsTagId[]

Tags to unassign from the tenant

Result of updating a tenant

idstring required

Tenant ID

namestring required

Updated tenant name

archivedboolean required

Is the tenant archived?

keyLeasingRequiredboolean required

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

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

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