---
title: "Patch a Tenant"
method: PATCH
path: "/v1/tenants/{tenant_id}"
tags: ["Tenants"]
---

# Patch a Tenant

`PATCH /v1/tenants/{tenant_id}`

## Request

- Base URL: `https://api-us.beyondidentity.com`
- URL: `https://api-us.beyondidentity.com/v1/tenants/{tenant_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/docs/v1/tenants/:tenant_id/patch.ts> (a function with typed inputs; its response is checked against the schema)

To update only specific attributes of an existing tenant, send a PATCH request to `/v1/tenants/$TENANT_ID`. Values in the request body for immutable or read-only fields will be ignored. Fields that are omitted from the request body will be left unchanged.

## Path parameters

- `tenant_id` string, required

## Request body

- object: Request for UpdateTenant.
  - `tenant` Tenant, required: A tenant represents an organization in the Beyond Identity Cloud. Tenants contain all data necessary for that organization to operate.
    - `id` string: A unique identifier for the tenant. This is automatically generated on creation. This field is immutable and read-only.
    - `display_name` string: A human-readable name for the tenant. This name is used for display purposes.
    - `create_time` string, date-time: A time value given in ISO8601 combined date and time format that represents when the tenant was created. This is automatically generated on creation. This field is read-only.
    - `update_time` string, date-time: A time value given in ISO8601 combined date and time format that represents when the tenant was last updated. This is automatically updated when the tenant is updated. This field is read-only.

## Response `200`

The response will be a JSON object containing the standard attributes associated with a tenant.

- Tenant: A tenant represents an organization in the Beyond Identity Cloud. Tenants contain all data necessary for that organization to operate.
  - `id` string: A unique identifier for the tenant. This is automatically generated on creation. This field is immutable and read-only.
  - `display_name` string: A human-readable name for the tenant. This name is used for display purposes.
  - `create_time` string, date-time: A time value given in ISO8601 combined date and time format that represents when the tenant was created. This is automatically generated on creation. This field is read-only.
  - `update_time` string, date-time: A time value given in ISO8601 combined date and time format that represents when the tenant was last updated. This is automatically updated when the tenant is updated. This field is read-only.

## Other responses

- `400`: Bad request.
- `401`: Unauthorized.
- `403`: Forbidden.
- `500`: Server error.

---

[API](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api.md) - [All operations](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-access-api/revisions/42f3cac49392?raw)