NHnhost
authentication

Retrieve OAuth2 provider tokens from callback

Changed on

After successful OAuth2 authentication, retrieve the provider session containing access token, refresh token, and expiration information for the specified provider. To ensure the data isn't stale this endpoint must be called immediately after the OAuth callback to obtain the tokens. The session is cleared from the database during this call, so subsequent calls will fail without going through the sign-in flow again. It is the user's responsibility to store the session safely (e.g., in browser local storage).

get/signin/provider/{provider}/callback/tokens

Request

  • Base URL
    https://{subdomain}.auth.{region}.nhost.run/v1
  • URL
    https://{subdomain}.auth.{region}.nhost.run/v1/signin/provider/{provider}/callback/tokens
  • Auth
    HTTP bearer

Path parameters

provider'apple' | 'github' | 'google' | 'linkedin' | 'discord' | 'spotify' | 'twitch' | 'gitlab' | 'bitbucket' | 'workos' | 'azuread' | 'entraid' | 'strava' | 'facebook' | 'windowslive' | 'twitter' required

The name of the social provider

Response

Successfully retrieved provider session

accessTokenstring required

OAuth2 provider access token for API calls

expiresIninteger required

Number of seconds until the access token expires

expiresAtstring date-time required

Timestamp when the access token expires

refreshTokenstring nullable

OAuth2 provider refresh token for obtaining new access tokens (if provided by the provider)

Example response

{
  "accessToken": "ya29.a0AfH6SMBx...",
  "expiresIn": 3599,
  "expiresAt": "2024-12-31T23:59:59Z",
  "refreshToken": "1//0gK8..."
}

Changes

  • 0fc5fd589dbfRevision changes
    • warning

      added the new otp-too-many-attempts enum value to the response property for the response status

  • b39086c84b43Revision changes
    • warning

      added the new user-already-exists enum value to the response property for the response status

    • info

      removed the email-already-in-use enum value from the response property for the response status