OAuth

@Serializable
data class OAuth(val provider: OAuthProvider, val redirectUrl: String = RedirectConfiguration.DEFAULT_REDIRECT_URL, val identifier: String? = null, val emailAddress: String? = null, val legalAccepted: Boolean? = null, val unsafeMetadata: Map<String, Any>? = null) : SignUp.AuthenticateWithRedirectParams

OAuth authentication parameters for redirect-based sign-up.

Parameters

provider

The OAuth provider to use for authentication.

redirectUrl

The URL to redirect to after OAuth completion.

identifier

Optional user identifier.

emailAddress

Optional email address for pre-filling forms.

legalAccepted

Whether legal terms have been accepted.

Constructors

Link copied to clipboard
constructor(provider: OAuthProvider, redirectUrl: String = RedirectConfiguration.DEFAULT_REDIRECT_URL, identifier: String? = null, emailAddress: String? = null, legalAccepted: Boolean? = null, unsafeMetadata: Map<String, Any>? = null)

Properties

Link copied to clipboard
@SerialName(value = "email_address")
open override val emailAddress: String?
Link copied to clipboard
open override val identifier: String?
Link copied to clipboard
@SerialName(value = "legal_accepted")
open override val legalAccepted: Boolean?
Link copied to clipboard
@SerialName(value = "strategy")
val provider: OAuthProvider
Link copied to clipboard
@SerialName(value = "redirect_url")
open override val redirectUrl: String
Link copied to clipboard
@Transient
@SerialName(value = "unsafe_metadata")
open override val unsafeMetadata: Map<String, Any>?

Custom metadata that will be attached to the created user. This metadata is not validated by Clerk and should not contain sensitive information.