---
title: "Tenant Update"
method: PUT
path: "/1/tenants/{tenantId}"
tags: ["Tenant"]
---

# Tenant Update

`PUT /1/tenants/{tenantId}`

## Request

- Base URL: `http://localhost:3000/api`
- URL: `http://localhost:3000/api/1/tenants/{tenantId}`
- 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)

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

## Headers

- `icl-requestor-id` string, required

## Request body

- object
  - `name` string: New name for tenant
  - `keyLeasingRequired` boolean: Whether key leasing must be enabled for all KMS configurations assigned to this tenant.
  - `tagAdditions` TagId[]: Tags to assign to the tenant
  - `tagRemovals` TagId[]: Tags to unassign from the tenant

## Response `200`

Result of updating a tenant

- object
  - `id` string, required: Tenant ID
  - `name` string, required: Updated tenant name
  - `archived` boolean, required: Is the tenant archived?
  - `keyLeasingRequired` boolean, required: Whether key leasing must be enabled for all KMS configurations assigned to this tenant.
  - `tags` Tag[], required: Tags associated with the tenant
    - `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

## Other responses

- `400`: Bad Request Possible causes: \- Invalid tenant ID provided \- Attempting to un-archive a tenant \- Attempting to archive an unclaimed tenant (must delete tenant instead)
- `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)