FRfrontegg
Users

Update user globally

This route updates a user’s information globally, not just for a specific tenant. Send the user’s ID as a path params to identify specific user. Send the updated user values within the PUT body. The PUT request does a complete update of the resource, so include values for all of the body params that you want to have values. This is a global update, so do not send a frontegg-tenant-id within the header.

put/resources/users/v1/{userId}

Request

Path parameters

userIdstring required

Request body

phoneNumberstring
profilePictureUrlstring nullable
metadatastring

Stringified JSON object

vendorMetadatastring

Extra vendor-only data. stringified JSON object

mfaBypassboolean

Indicates whether MFA should be bypassed for this user

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.