User API

get /auth

SSO redirect login

Base URL https://api.vseepreview.com/api_v3 · operationId authRedirect

Authentication: No Auth — This endpoint requires no authentication headers.

Use this URL to redirect a user to VSee Clinic with automatic login.

Pattern: https://{portal_url}/auth?sso_token={token}&next={next_url}

This will log the user in and redirect them to the specified URL path.

Parameters

NameInTypeRequiredEnumDefaultDescription
sso_tokenquerystringyesSSO token from the POST /users/sso response (e.g. 66bcd0acff324e8a44992d9596b5d361)
nextquerystringnoURL path to redirect the user to after login (e.g. /u/clinic)
one_time_tokenquerystringno1Set to `1` to invalidate the sso_token after login (additional security)
disable_navigationquerystringno1Set to `1` to disable all email communication

Responses

302 — Redirects user to VSee Clinic portal

Machine-readable: OpenAPI JSON (operationId: authRedirect)