FRfrontegg
Users

Add user to tenant

This route adds a user to a tenant. Send the user ID as a path params and the tenant ID as a POST body params. To skip the invite email requirement, pass as an optional POST body params for skipInviteEmail. Set its value to true to skip the invite email. A vendor token is required for this route, it can be obtained from the vendor authentication route.

post/resources/users/v1/{userId}/tenant

Request

Path parameters

userIdstring required

Request body

validateTenantExistboolean
tenantIdstring required
skipInviteEmailboolean

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.