Documentation navigation

Auth

Build an authorization URL

GET/auth/authorize

Builds the provider authorization URL without starting a browser redirect.

Parameters

AuthorizeUrlOptions
provider'apple' | 'azure' | 'discord' | 'github' | 'gitlab' | 'google' | 'snapchat' | 'twitch' | 'twitter' | 'x'
The external identity provider.
scopes?OAuthScopes
Provider scopes to request.
inviteToken?string
Invitation token included in the authorization request.
codeChallenge?string
PKCE code challenge.
codeChallengeMethod?CodeChallengeMethod
PKCE challenge method.
redirectTo?string
Callback destination after authorization.
projectId?ProjectId
Project override for the authorization request.

Returns

string