Users
Register users and manage sessions, profiles, and account recovery.
Fields
idstringUnique identifier of the resource.emailstringstatusenuminactive · active · suspended · pendingDeletion · deletinguserNamestringfirstNamestringlastNamestringbirthDatestringdocumentTypeenumKind of identity or tax document.nationalId · passport · foreignId · taxId · See all 25 fields
genderenummale · female · other · documentNumberstringNational identity or tax document number.phonestringavatarUrlstringaddressstringcountryCodestringISO 3166-1 alpha-2 country code, for example PE.isProfileCompletebooleanisConfirmedbooleanisEmailConfirmedbooleanisPhoneNumberConfirmedbooleanisTwoFactorEnabledbooleanisActivebooleancreatedOnstringTimestamp when the resource was created, in ISO 8601.rolesarray<string>hasPasswordbooleanloginProvidersarray<string>deletionScheduledOnstringOperations
| Method | Endpoint | Operation |
|---|---|---|
POST | / | Register user |
POST | / | Request login code |
POST | / | Request a password reset |
POST | / | Reset a user password |
GET | / | Get the current user |
PUT | / | Update the current user |
POST | / | Schedule the account for deletion |
POST | / | Enable two-factor authentication |
GET | / | List the passkeys of the current user |
GET | / | Get two-factor status |
PUT | / | Update the current user's password |
DELETE | / | Cancel a scheduled account deletion |
DELETE | / | Disable two-factor authentication |
POST | / | Start authenticator enrollment |
POST | / | Generate new recovery codes |
DELETE | / | Delete a passkey of the current user |
DELETE | / | Forget the devices that skip two-factor verification |
Last updated: