Generates an email action link.
post/admin/generate_linkResponses
The response object for generate link.
- JavaScript
- Flutter
- PythonCommunity
- C#Community
- SwiftCommunity
- KotlinCommunity
- CLI Commands
- Management API
- Guides and Examples
- Integrations
Client Library Reference
Resources
Get a user.
get/admin/user/{user_id}Path Parameters
- user_idREQUIREDno type
The user's id
Responses
The current user.
Update a user.
put/admin/user/{user_id}Path Parameters
- user_idREQUIREDno type
The user's id
Responses
The current user.
Deletes a user.
delete/admin/user/{user_id}Path Parameters
- user_idREQUIREDno type
The user's id
Responses
The updated user.
List all users.
get/admin/usersResponses
The list of users.
Returns the created user.
post/admin/usersResponses
The current user.
Redirects the user to the 3rd-party OAuth provider to start the OAuth1.0 or OAuth2.0 authentication process.
get/authorizeQuery Parameters
- redirect_toOptionalno type
The redirect url to return the user to after the `/callback` endpoint has completed.
Responses
Redirects user to the 3rd-party OAuth provider
Receives the redirect from an external provider during the OAuth authentication process. Starts the process of creating an access and refresh token.
get/callbackResponses
Redirects user to the redirect url specified in `/authorize`. If no `redirect_url` is provided, the user will be redirected to the `SITE_URL`.
The healthcheck endpoint for gotrue. Returns the current gotrue version.
get/healthResponses
Sends an invite link to the user.
post/inviteResponses
Logs out the user.
post/logoutResponses
Passwordless sign-in method for email or phone.
post/otpResponses
Sends a password recovery email link to the user's email.
post/recoverResponses
Returns the configuration settings for the gotrue server.
get/settingsResponses
Password-based signup with either email or phone.
post/signupResponses
The current user.
Signs in a user with a password.
post/token?grant_type=passwordResponses
Refreshes a user's refresh token.
post/token?grant_type=refresh_tokenResponses
Get information for the logged-in user.
get/userResponses
The current user.
Returns the updated user.
put/userResponses
The current user.
Verifies a sign up.
get/verifyQuery Parameters
- typeOptionalstring
- tokenOptionalstring
- emailOptionalstring
- phoneOptionalstring
- redirect_toOptionalstring
Need some help?
Contact supportLastest product updates?
See ChangelogSomething's not right?
Check system status