User management

Update user's active tenant

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.

put/resources/users/v1/tenant

Request

Headers

frontegg-user-idstring required

The user ID identifier

frontegg-tenant-idstring required

The tenant ID identifier

Request body

tenantIdstring required

Desired tenant to set as active tenant for user

Response

idstring required
emailstring required
namestring
profilePictureUrlstring
substring required
verifiedboolean required
mfaEnrolledboolean required
mfaBypassboolean
phoneNumberstring
providerstring required
tenantIdstring required
tenantIdsstring[] required
activatedForTenantboolean
isLockedboolean
invisibleboolean
superUserboolean
metadatastring required
vendorMetadatastring required
createdAtstring date-time required
lastLoginstring date-time required
groupsobject[]
subAccountAccessAllowedboolean required
managedBy'frontegg' | 'scim2' | 'external'

Changes

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