Home

gotrue

Documentation of the gotrue API.

Generates an email action link.

postapiv0/admin/generate_link

Responses

The response object for generate link.

Get a user.

getapiv0/admin/user/{user_id}

Path parameters

  • user_id
    REQUIRED

    The user's id

Responses

The current user.

Update a user.

putapiv0/admin/user/{user_id}

Path parameters

  • user_id
    REQUIRED

    The user's id

Responses

The current user.

Deletes a user.

deleteapiv0/admin/user/{user_id}

Path parameters

  • user_id
    REQUIRED

    The user's id

Responses

The updated user.

List all users.

getapiv0/admin/users

Responses

The list of users.

Returns the created user.

postapiv0/admin/users

Responses

The current user.

Redirects the user to the 3rd-party OAuth provider to start the OAuth1.0 or OAuth2.0 authentication process.

getapiv0/authorize

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.

getapiv0/callback

Responses

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.

getapiv0/health

Responses

Sends an invite link to the user.

postapiv0/invite

Responses

Logs out the user.

postapiv0/logout

Responses

Passwordless sign-in method for email or phone.

postapiv0/otp

Responses

Sends a password recovery email link to the user's email.

postapiv0/recover

Responses

Returns the configuration settings for the gotrue server.

getapiv0/settings

Responses

Password-based signup with either email or phone.

postapiv0/signup

Responses

The current user.

Signs in a user with a password.

postapiv0/token?grant_type=password

Responses

Refreshes a user's refresh token.

postapiv0/token?grant_type=refresh_token

Responses

Get information for the logged-in user.

getapiv0/user

Responses

The current user.

Returns the updated user.

putapiv0/user

Responses

The current user.

Verifies a sign up.

getapiv0/verify

Verifies a sign up.

postapiv0/verify
Need some help?

Not to worry, our specialist engineers are here to help. Submit a support ticket through the Dashboard.