3.1.3

auth-kt/io.github.jan.supabase.auth.admin/AdminUserUpdateBuilder

AdminUserUpdateBuilder

@Serializable

data class AdminUserUpdateBuilder( var email: String? = null, var password: String? = null, var appMetadata: JsonObject? = null, var userMetadata: JsonObject? = null, var emailConfirm: Boolean? = null, var phoneConfirm: Boolean? = null, var phone: String? = null, var banDuration: String? = null, var role: String? = null)(source)

A builder for updating a user.

Constructors

AdminUserUpdateBuilder

constructor( email: String? = null, password: String? = null, appMetadata: JsonObject? = null, userMetadata: JsonObject? = null, emailConfirm: Boolean? = null, phoneConfirm: Boolean? = null, phone: String? = null, banDuration: String? = null, role: String? = null)

Properties

@SerialName(value = "app_metadata")

var appMetadata: JsonObject?

Extra app metadata

@SerialName(value = "ban_duration")

var banDuration: String?

Determines how long a user is banned for. The format for the ban duration follows a strict sequence of decimal numbers with a unit suffix.

var email: String?

The user's email address

@SerialName(value = "email_confirm")

var emailConfirm: Boolean?

Automatically confirms the email address

var password: String?

The user's password

var phone: String?

The user's phone number

@SerialName(value = "phone_confirm")

var phoneConfirm: Boolean?

Automatically confirms the phone number

var role: String?

The role claim set in the user's access token JWT.

@SerialName(value = "user_metadata")

var userMetadata: JsonObject?

Extra user metadata