Clerk Android API/com.clerk.api.externalaccount/ExternalAccount

ExternalAccount

@Serializable

data class ExternalAccount(val id: String, val identificationId: String, val provider: String, val providerUserId: String, val emailAddress: String, val approvedScopes: String, val firstName: String? = null, val lastName: String? = null, val imageUrl: String? = null, val username: String? = null, val label: String? = null, val verification: Verification? = null, val createdAt: Long)

The ExternalAccount object is a model around an identification obtained by an external provider (e.g. a social provider such as Google).

External account must be verified, so that you can make sure they can be assigned to their rightful owners. The ExternalAccount object holds all necessary state around the verification process.

Constructors

ExternalAccount

constructor(id: String, identificationId: String, provider: String, providerUserId: String, emailAddress: String, approvedScopes: String, firstName: String? = null, lastName: String? = null, imageUrl: String? = null, username: String? = null, label: String? = null, verification: Verification? = null, createdAt: Long)

Properties

@SerialName(value = "approved_scopes")

val approvedScopes: String

The scopes that the user has granted access to.

@SerialName(value = "created_at")

val createdAt: Long

@SerialName(value = "email_address")

val emailAddress: String

The provided email address of the user.

@SerialName(value = "first_name")

val firstName: String?

The user's first name.

The unique identifier for this external account.

identificationId

@SerialName(value = "identification_id")

val identificationId: String

The identification with which this external account is associated.

@SerialName(value = "image_url")

val imageUrl: String?

The user's image URL.

val label: String?

A descriptive label to differentiate multiple external accounts of the same user for the same provider.

@SerialName(value = "last_name")

val lastName: String?

The user's last name.

oauthProviderType

val ExternalAccount.oauthProviderType: OAuthProvider

val provider: String

The provider name e.g. google

@SerialName(value = "provider_user_id")

val providerUserId: String

The unique ID of the user in the provider.

val username: String?

The user's username.

val verification: Verification?

An object holding information on the verification of this external account.

Functions

suspend fun ExternalAccount.delete(): ClerkResult<DeletedObject, ClerkErrorResponse>

Deletes this external account from the user's profile.

suspend fun ExternalAccount.reauthorize(): ClerkResult<ExternalAccount, ClerkErrorResponse>

Reauthorizes this external account by refreshing its verification status.

suspend fun ExternalAccount.revokeTokens(): ClerkResult<User, ClerkErrorResponse>

Revokes the access tokens associated with this external account.