Skip to main content
GET
Start sign-in with an identity provider

Path Parameters

provider
enum<string>
required

Identity provider.

Available options:
github,
google,
microsoft
Example:

"github"

Query Parameters

redirect_uri
string

Application URL after sign-in. The session is delivered in a cookie or token query parameter according to the redirect target.

Maximum string length: 4096
code
string

Provider callback code. Open the provider sign-in URL without it to start authorization; the provider returns code and state to this same URL.

Maximum string length: 8192
state
string

CSRF state token (maximum 4096 characters)

Maximum string length: 4096
error
string

OAuth error code (for example, access_denied when user cancels).

Maximum string length: 8192
error_description
string

Human-readable error description

iss
string

Google callbacks only: issuer metadata. Ignored otherwise.

scope
string

Google callbacks only: granted scopes metadata. Ignored otherwise.

authuser
string

Google callbacks only: account index metadata. Ignored otherwise.

hd
string

Google callbacks only: Workspace hosted-domain metadata. Ignored otherwise.

prompt
string

Google callbacks only: prompt metadata. Ignored otherwise.

Response

Redirect to the provider consent screen, or back to the application after the callback. The provider returns to the same /auth/{provider} URL with code and state; these callback URLs are registered with each provider and remain unchanged.