---
title: "Update user's active tenant"
method: PUT
path: "/resources/users/v1/tenant"
tags: ["User management"]
---

# Update user's active tenant

`PUT /resources/users/v1/tenant`

## Request

- Base URL: `http://localhost:8181`
- URL: `http://localhost:8181/resources/users/v1/tenant`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/docs/resources/users/v1/tenant/put.ts> (a function with typed inputs; its response is checked against the schema)

This route updates the logged in user’s tenant. The user uses it when they have multiple tenants and they want to change the current tenant they log in to. Send the **`frontegg-user-id`** and **`frontegg-tenant-id`** headers to declare which user and which tenant to update when the request is sent with a vendor token. Send the tenant ID in the PUT body.

## Headers

- `frontegg-user-id` string, required
- `frontegg-tenant-id` string, required

## Request body

- UpdateUserTenantDto
  - `tenantId` string, required: Desired tenant to set as active tenant for user

## Response `200`

- UserDto
  - `id` string, required
  - `email` string, required
  - `name` string
  - `profilePictureUrl` string
  - `sub` string, required
  - `verified` boolean, required
  - `mfaEnrolled` boolean, required
  - `mfaBypass` boolean
  - `phoneNumber` string
  - `roles` RoleResponse[], required
    - `id` string, required
    - `vendorId` string, required
    - `tenantId` string, required
    - `key` string, required
    - `name` string, required
    - `description` string, required
    - `isDefault` boolean, required
    - `firstUserRole` boolean, required
    - `level` number, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `permissions` string[], required
  - `permissions` PermissionResponse[], required
    - `id` string, required
    - `key` string, required
    - `name` string, required
    - `description` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `roleIds` string[], required
    - `categoryId` string, required
    - `fePermission` boolean, required
  - `provider` string, required
  - `tenantId` string, required
  - `tenantIds` string[], required
  - `activatedForTenant` boolean
  - `isLocked` boolean
  - `tenants` UserTenantDto[], required
    - `tenantId` string, required
    - `roles` RoleResponse[], required
      - `id` string, required
      - `vendorId` string, required
      - `tenantId` string, required
      - `key` string, required
      - `name` string, required
      - `description` string, required
      - `isDefault` boolean, required
      - `firstUserRole` boolean, required
      - `level` number, required
      - `createdAt` string, date-time, required
      - `updatedAt` string, date-time, required
      - `permissions` string[], required
    - `temporaryExpirationDate` string, date-time
    - `isDisabled` boolean
  - `invisible` boolean
  - `superUser` boolean
  - `metadata` string, required
  - `vendorMetadata` string, required
  - `createdAt` string, date-time, required
  - `lastLogin` string, date-time, required
  - `groups` object[]
  - `subAccountAccessAllowed` boolean, required
  - `managedBy` 'frontegg' | 'scim2' | 'external'

---

[API](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp.md) - [All operations](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/llms.txt) - [OpenAPI document](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/revisions/c496ae9e1c3e?raw)
