User management

Signup user

This route is for signing up a new user and new tenant. Send the frontegg-vendor-host header. This is your domain name in the Frontegg Portal ➜ Workspace Settings ➜ Domains ➜ Domain Name. Send the user's information in the POST body. The user's email, provider, companyName, and metadata are required. The provider is the authentication provider, like local, saml, google, github. See the dropdown for available values. The metadata can be empty, like {}. You also can send in the POST body additional information as shown in the example. A vendor token is required for this route, it can be obtained from the vendor authentication route.

post/resources/users/v1/signUp

Request

Headers

frontegg-vendor-hoststring required
frontegg-application-idstring required

The application id

Request body

provider'local' | 'saml' | 'google' | 'github' | 'facebook' | 'microsoft' | 'scim2' | 'slack' | 'apple' required
metadatastring

Stringified JSON object. Use the JSON.stringify() method.

emailstring required
namestring
profilePictureUrlstring
passwordstring
phoneNumberstring
skipInviteEmailboolean
roleIdsstring[]
emailMetadataobject
companyNamestring required
recaptchaTokenstring
invitationTokenstring

Changes

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