OAuthClient

interface OAuthClient

OAuth authentication methods for browser-based and native provider flows.

Properties

Link copied to clipboard
abstract val amazon: OAuthType

Amazon OAuth.

Link copied to clipboard
abstract val apple: OAuthType

Apple OAuth.

Link copied to clipboard
abstract val bitbucket: OAuthType

Bitbucket OAuth.

Link copied to clipboard
abstract val coinbase: OAuthType

Coinbase OAuth.

Link copied to clipboard
abstract val discord: OAuthType

Discord OAuth.

Link copied to clipboard
abstract val facebook: OAuthType

Facebook OAuth.

Link copied to clipboard
abstract val figma: OAuthType

Figma OAuth.

Link copied to clipboard
abstract val github: OAuthType

GitHub OAuth.

Link copied to clipboard
abstract val gitlab: OAuthType

GitLab OAuth.

Link copied to clipboard
abstract val google: OAuthType

Google OAuth.

Link copied to clipboard
abstract val linkedin: OAuthType

LinkedIn OAuth.

Link copied to clipboard
abstract val microsoft: OAuthType

Microsoft OAuth.

Link copied to clipboard
abstract val salesforce: OAuthType

Salesforce OAuth.

Link copied to clipboard
abstract val slack: OAuthType

Slack OAuth.

Link copied to clipboard
abstract val snapchat: OAuthType

Snapchat OAuth.

Link copied to clipboard
abstract val tiktok: OAuthType

TikTok OAuth.

Link copied to clipboard
abstract val twitch: OAuthType

Twitch OAuth.

Link copied to clipboard
abstract val twitter: OAuthType

Twitter/X OAuth.

Link copied to clipboard
abstract val yahoo: OAuthType

Yahoo OAuth.

Functions

Link copied to clipboard
abstract suspend fun attach(request: IOAuthAttachParameters): OAuthAttachResponse

Creates an OAuth attach token that can be used to link an OAuth provider to an existing authenticated session. Calls the POST /sdk/v1/oauth/attach endpoint. Pass the returned attach token as oauthAttachToken in a subsequent OAuthType.start call.

Link copied to clipboard
abstract suspend fun authenticate(request: IOAuthAuthenticateParameters): OAuthAuthenticateResponse

Authenticates an OAuth token received from a deeplink after the browser-based OAuth flow completes. Calls the POST /sdk/v1/oauth/authenticate endpoint. Retrieves the PKCE code verifier stored during the corresponding OAuthType.start call.

Link copied to clipboard
abstract suspend fun authenticateAppleIdToken(request: IOAuthAppleIDTokenAuthenticateParameters): OAuthGoogleIDTokenAuthenticateResponse

Authenticates an Apple ID token obtained via native iOS Sign In with Apple. Calls the POST /sdk/v1/oauth/apple/id_token/authenticate endpoint.

Link copied to clipboard
abstract suspend fun authenticateGoogleIdToken(request: IOAuthGoogleIDTokenAuthenticateParameters): OAuthGoogleIDTokenAuthenticateResponse

Authenticates a Google ID token obtained via native Android Google Sign-In. Calls the POST /sdk/v1/oauth/google/id_token/authenticate endpoint.