Clerk Android API/com.clerk.api.signin/SignIn/AuthenticateWithRedirectParams/OAuth

OAuth

@Serializable

data class OAuth(val provider: OAuthProvider, val redirectUrl: String = RedirectConfiguration.DEFAULT_REDIRECT_URL, val emailAddress: String? = null, val legalAccepted: Boolean? = null, val identifier: String? = null) : SignIn.AuthenticateWithRedirectParams

Parameters for authenticating with an OAuth provider using a redirect flow.

Parameters

provider

The OAuth provider to use for authentication. You can use a predefined OAuthProvider or a custom one.

redirectUrl

The URL to redirect to after the user completes the authentication flow with the provider. Defaults to the first redirect URL configured in your Clerk Dashboard.

emailAddress

The user's email address, which can be used to pre-fill the authentication form on the provider's site.

legalAccepted

Indicates whether the user has accepted any legal terms, such as a privacy policy or terms of service.

identifier

The user's identifier for authentication, which can be an email address or phone number.

Constructors

OAuth

constructor(provider: OAuthProvider, redirectUrl: String = RedirectConfiguration.DEFAULT_REDIRECT_URL, emailAddress: String? = null, legalAccepted: Boolean? = null, identifier: String? = null)

Properties

emailAddress

@SerialName(value = "email_address")

open override val emailAddress: String?

identifier

open override val identifier: String?

legalAccepted

@SerialName(value = "legal_accepted")

open override val legalAccepted: Boolean?

provider

val provider: OAuthProvider

redirectUrl

@SerialName(value = "redirect_url")

open override val redirectUrl: String