Package-level declarations

Types

@Serializable

data class User(val backupCodeEnabled: Boolean? = null, val createdAt: Long? = null, val createOrganizationEnabled: Boolean? = null, val createOrganizationsLimit: Int? = null, val deleteSelfEnabled: Boolean = false, val emailAddresses: List<EmailAddress>, val enterpriseAccounts: List<EnterpriseAccount>? = null, val externalAccounts: List<ExternalAccount>, val firstName: String? = null, val hasImage: Boolean, val id: String, val imageUrl: String, val lastSignInAt: Long? = null, val lastName: String? = null, val legalAcceptedAt: Long? = null, val organizationMemberships: List<OrganizationMembership>? = null, val passkeys: List<Passkey>, val passwordEnabled: Boolean, val phoneNumbers: List<PhoneNumber>, val primaryEmailAddressId: String? = null, val primaryPhoneNumberId: String? = null, val publicMetadata: JsonObject? = null, val privateMetadata: JsonObject? = null, val totpEnabled: Boolean, val twoFactorEnabled: Boolean, val updatedAt: Long, val unsafeMetadata: JsonObject? = null, val username: String? = null)

The User object holds all of the information for a single user of your application and provides a set of methods to manage their account.

Properties

unconnectedProviders

val User.unconnectedProviders: List<OAuthProvider>

Extension property that returns a list of OAuth providers that the user has not yet connected.

Functions

activeSessions

suspend fun User.activeSessions(): ClerkResult<List<Session>, ClerkErrorResponse>

Retrieves the active sessions for the current user or the user with the given session ID.

allSessions

suspend fun User.allSessions(): ClerkResult<List<Session>, ClerkErrorResponse>

Retrieves all sessions for the current user or the user with the given session ID.

attemptTOTPVerification

suspend fun User.attemptTOTPVerification(code: String): ClerkResult<TOTPResource, ClerkErrorResponse>

Verifies a TOTP (Time-based One-Time Password) code to complete the TOTP setup process.

createBackupCodes

suspend fun User.createBackupCodes(): ClerkResult<BackupCodeResource, ClerkErrorResponse>

Generates backup codes for the current user's account.

createEmailAddress

suspend fun User.createEmailAddress(email: String): ClerkResult<EmailAddress, ClerkErrorResponse>

Creates a new email address for the current user or the user with the given session ID.

createExternalAccount

suspend fun User.createExternalAccount(params: User.CreateExternalAccountParams): ClerkResult<ExternalAccount, ClerkErrorResponse>

Adds an external account for the user. A new ExternalAccount will be created and associated with the user. This method is useful if you want to allow an already signed-in user to connect their account with an external provider, such as Facebook, GitHub, etc., so that they can sign in with that provider in the future.

createPasskey

suspend fun User.createPasskey(): ClerkResult<Passkey, ClerkErrorResponse>

Creates a new passkey for the current user or the user with the given session ID.

createPhoneNumber

suspend fun User.createPhoneNumber(phoneNumber: String): ClerkResult<PhoneNumber, ClerkErrorResponse>

Creates a new phone number for the current user or the user with the given session ID.

createTOTP

suspend fun User.createTOTP(): ClerkResult<TOTPResource, ClerkErrorResponse>

Creates a new TOTP (Time-based One-Time Password) configuration for the current user.

delete

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

Deletes the current user, or the user with the given session ID, from the Clerk API.

deletePassword

suspend fun User.deletePassword(currentPassword: String): ClerkResult<User, ClerkErrorResponse>

Deletes the current user's password, or the user with the given session ID, using the Clerk API.

deleteProfileImage

suspend fun User.deleteProfileImage(): ClerkResult<DeletedObject, ClerkErrorResponse>

Deletes the current user's profile image, or the user with the given session ID, from the Clerk API.

deleteTOTP

suspend fun User.deleteTOTP(): ClerkResult<DeletedObject, ClerkErrorResponse>

Deletes the TOTP (Time-based One-Time Password) configuration for the current user.

emailAddresses

suspend fun User.emailAddresses(): ClerkResult<List<EmailAddress>, ClerkErrorResponse>

Retrieves all email addresses associated with the current user or the user with the given session ID.

fullName

fun User.fullName(): String

Extension function that returns the user's full name by combining first and last names.

get

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

Retrieves the current user, or the user with the given session ID, from the Clerk API.

phoneNumbers

suspend fun User.phoneNumbers(): ClerkResult<List<PhoneNumber>, ClerkErrorResponse>

Retrieves all phone numbers associated with the current user or the user with the given session ID.

setProfileImage

suspend fun User.setProfileImage(file: File): ClerkResult<ImageResource, ClerkErrorResponse>

Update the current user's profile image, or the user with the given session ID, with the provided image data.

update

suspend fun User.update(params: User.UpdateParams): ClerkResult<User, ClerkErrorResponse>

Updates the current user, or the user with the given session ID, with the provided parameters.

updatePassword

suspend fun User.updatePassword(params: User.UpdatePasswordParams): ClerkResult<User, ClerkErrorResponse>

Updates the current user's password, or the user with the given session ID, using the Clerk API.