Password APIs
Overview
The Password APIs handle sign-up and sign-in in a single step. On successful authentication, the user's JWT is returned. Password resets require email verification — the reset endpoint only succeeds if the user has a validated email address.
Use Cases
- Sign Up a new user via password authentication
- Sign In an existing user via password authentication
- Initiate a Password Reset
- Replace an existing user's password
- Update an existing user's password
Examples
Example - user sign-up via password
- Call the Sign-Up API endpoint. On success, the user's JWT is returned.
Example - reset user's password
- Call the Reset Password API endpoint.
- The user receives a password reset email. Verify the user after they complete the reset via Verify Magic Link.
Example - update user's password
- Use the user's refresh token to update their password via Update Password.
User Sign-Up POST
Create a new user using WebAuthn
Sign-Up User POST
### Sign-Up a new user utilizing password authentication. This endpoint will return the user's JWT. ### Next Steps Verify the user's email to allow for password reset by updating the email via [OTP](/api/otp/email/update-email), [Enchanted Link](/api/enchanted-link/update-email), or [Magic Link](/api/magic-link/email/update-email) Add tenants to the user via [Update User Add Tenant](/api/management/users/update-user-add-tenant) Add roles to the user via [Update User Add Role](/api/management/users/update-user-add-roles) ### See Also - See [The User Object](/api/overview#the-user-object) for further details on how to identify users and their contact information such as email addresses and phone number. - Use the [Sign-In](/api/passwords/sign-in) endpoint to sign-in an existing end user.