Sign up with OAuth provider
GET/signup/provider/{provider}
Initiate OAuth signup flow with the specified provider. Redirects to the provider’s authorization page.
Use this endpoint to explicitly register a new account. When AUTH_DISABLE_AUTO_SIGNUP is enabled, this is the only way to register through this method.
If the user already exists at callback time, they are redirected with error=user-already-exists.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The name of the social provider
Query Parameters
Section titled “Query Parameters”Example
[ "me", "user"]Array of allowed roles for the user
Example
userDefault role for the user
Example
John SmithDisplay name for the user
Example
enA two or three characters locale
object
Example
{ "firstName": "John", "lastName": "Smith"}Additional metadata for the user (JSON encoded string)
Example
https://my-app.com/catch-redirectionURI to redirect to
Opaque state value to be returned by the provider
Additional provider-specific parameters
object
(workos) Specifies the connection to use for authentication
(workos) Specifies the organization to use for authentication
Extra parameters forwarded to the upstream OAuth2 provider’s authorization URL. Reserved OAuth2/OIDC parameters are rejected.
Extra parameters forwarded to the upstream OAuth2 provider’s authorization URL (e.g. Google’s prompt or login_hint). Reserved OAuth2/OIDC parameters are rejected.
object
PKCE code challenge (S256). When provided, the callback redirect will contain an authorization code instead of a refresh token.
Responses
Section titled “Responses”Redirect to social provider
Headers
Section titled “Headers”URL to redirect to
default
Section titled “default”An error occurred while processing the request
Standardized error response
object
HTTP status error code
Example
400Human-friendly error message
Example
Invalid email formatError code identifying the specific application error