authentication
Sign in with an OAuth2 provider
Initiate OAuth2 authentication flow with a social provider. Redirects the user to the provider's authorization page.
get/signin/provider/{provider}
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
Query parameters
allowedRolesstring[]
Array of allowed roles for the user
[ "me", "user" ]
defaultRolestring
Example:user
Default role for the user
displayNamestring
Example:John Smith
Display name for the user
localestring
Example:en
A two or three characters locale
Additional metadata for the user (JSON encoded string)
redirectTostring uri
Example:https://my-app.com/catch-redirection
URI to redirect to
connectstring
If set, this means that the user is already authenticated and wants to link their account. This needs to be a valid JWT access token.
statestring
Opaque state value to be returned by the provider
Additional provider-specific parameters
codeChallengestring
PKCE code challenge (S256). When provided, the callback redirect will contain an authorization code instead of a refresh token.
Response
An error occurred while processing the request
Example response
{
"status": 400,
"message": "Invalid email format"
}