General

Authenticate user with password

This route authenticates a local user using email and password. Send the frontegg-vendor-host as a header to declare which vendor. This is your domain name in the Frontegg Portal ➜ Workspace Settings ➜ Domains ➜ Domain Name. Optionally, send login information for the user as POST body params. Include the invitation token if the user is signing up by invitation. Send the recaptcha token if the recaptcha is enabled for login.

post/resources/auth/v1/user

Request

Headers

frontegg-vendor-hoststring

The vendor host domain

Request body

emailstring required
passwordstring required
recaptchaTokenstring
invitationTokenstring

Response

tokenTypestring
mfaRequiredboolean required
mfaTokenstring
mfaEnrolledboolean
mfaStrategiesobject
qrCodestring
recoveryCodestring
accessTokenstring required
refreshTokenstring required
expiresInnumber required
expiresstring required
userIdstring
userEmailstring
emailVerifiedboolean
isBreachedPasswordboolean

Changes

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