FRfrontegg
User management

Invite user

This route creates a user for a specific tenant. Send the tenant’s ID in the frontegg-tenant-id header to declare to what tenant this user is assigned. Send the user's information in the POST body. The user's email and metadata are required. The metadata can be empty, like {}.

post/resources/users/v2

Request

Headers

frontegg-tenant-idstring required

The tenant ID identifier

Request body

emailstring email required
namestring
profilePictureUrlstring
passwordstring
phoneNumberstring
provider'local' | 'saml' | 'google' | 'github' | 'facebook' | 'microsoft' | 'scim2' | 'slack' | 'apple'
metadatastring

Stringified JSON object

skipInviteEmailboolean
roleIdsstring[]
emailMetadataobject
expirationInSecondsnumber

Temporary user expiration in seconds

Example request

{
  "metadata": "{}"
}

Response

idstring
emailstring
verifiedboolean
namestring
profilePictureUrlstring
rolesstring[]
permissionsstring[]
metadatastring
createdAtstring date-time
lastLoginstring date-time
activatedForTenantboolean
temporaryExpirationDatestring date-time

Changes

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