Clerk Android/com.clerk.network.model.environment/UserSettings

UserSettings

@Serializable

data class UserSettings(val attributes: Map<String, UserSettings.AttributesConfig>, val signUp: UserSettings.SignUpUserSettings, val social: Map<String, UserSettings.SocialConfig>, val actions: UserSettings.Actions, val passkeySettings: UserSettings.PasskeySettings?)

Represents user settings and configuration from the Clerk environment.

This data class contains all the configuration settings that control user authentication, sign-up flows, social providers, and other user-related features for the application.

Constructors

UserSettings

constructor(attributes: Map<String, UserSettings.AttributesConfig>, signUp: UserSettings.SignUpUserSettings, social: Map<String, UserSettings.SocialConfig>, actions: UserSettings.Actions, passkeySettings: UserSettings.PasskeySettings?)

Types

Actions

@Serializable

data class Actions(val deleteSelf: Boolean = false, val createOrganization: Boolean = false)

Configuration for user actions and permissions.

AttributesConfig

@Serializable

data class AttributesConfig(val enabled: Boolean, val required: Boolean, val usedForFirstFactor: Boolean, val firstFactors: List<String>?, val usedForSecondFactor: Boolean, val secondFactors: List<String>?, val verifications: List<String>?, val verifyAtSignUp: Boolean)

Configuration for a user attribute (email, phone, username, etc.).

PasskeySettings

@Serializable

data class PasskeySettings(val allowAutofill: Boolean, val showSignInButton: Boolean)

Configuration for passkey authentication features.

SignUpUserSettings

@Serializable

data class SignUpUserSettings(val customActionRequired: Boolean, val progressive: Boolean, val mode: String, val legalConsentEnabled: Boolean)

Configuration for the sign-up flow and requirements.

SocialConfig

@Serializable

data class SocialConfig(val enabled: Boolean, val required: Boolean, val authenticatable: Boolean, val strategy: String, val notSelectable: Boolean, val name: String, val logoUrl: String?)

Configuration for a social authentication provider.