User management

Update user

This route updates a user’s information for a specific tenant. Send the frontegg-user-id and frontegg-tenant-id headers to declare which user and which tenant.

put/resources/users/v1

Request

Headers

frontegg-user-idstring required

The user ID identifier

frontegg-tenant-idstring required

The tenant ID identifier

Request body

phoneNumberstring
profilePictureUrlstring nullable
metadatastring

Stringified JSON object

namestring

Example request

{
  "metadata": "{}"
}

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.