STstytch
Oauth

Attach

Changed on

Generate an OAuth Attach Token to pre-associate an OAuth flow with an existing Stytch User. Pass the returned oauth_attach_token to the same provider's OAuth Start endpoint to treat this OAuth flow as a login for that user instead of a signup for a new user.

Exactly one of user_id, session_token, or session_jwt must be provided to identify the target Stytch User.

Note: This is an optional step in the OAuth flow. Stytch can often determine whether to associate a new OAuth login with an existing User based on verified information (such as an email address) from the identity provider. This endpoint is useful for cases where we can't, such as missing or unverified provider information.

See our OAuth email address behavior resource for additional information.

post/v1/oauth/attach

Request

  • Base URL
    https://api.stytch.com
  • Auth
    HTTP basic

Request body

providerstring required

The OAuth provider's name.

user_idstring

The unique ID of a specific User. You may use an external_id here if one is set for the user.

session_tokenstring

The session_token associated with a User's existing Session.

session_jwtstring

The session_jwt associated with a User's existing Session.

Response

Successful response

request_idstring required

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

oauth_attach_tokenstring required

A single-use token for connecting the Stytch User selection from an OAuth Attach request to the corresponding OAuth Start request.

status_codeinteger required

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.

Changes