UpdateParams

data class UpdateParams @JvmOverloads constructor(val name: String? = null, val untrustedMetadata: Map<String, Any>? = null, val mfaEnrolled: Boolean? = null, val mfaPhoneNumber: String? = null, val defaultMfaMethod: MfaMethod? = null)

Data class used for wrapping parameters used with Member updates

Constructors

Link copied to clipboard
constructor(name: String? = null, untrustedMetadata: Map<String, Any>? = null, mfaEnrolled: Boolean? = null, mfaPhoneNumber: String? = null, defaultMfaMethod: MfaMethod? = null)

Properties

Link copied to clipboard
val defaultMfaMethod: MfaMethod? = null

Sets the Member's default MFA method. Valid values are 'SMS' and 'TOTP'. This value will determine

Link copied to clipboard
val mfaEnrolled: Boolean? = null

Sets whether the Member is enrolled in MFA. If true, the Member must complete an MFA step whenever they wish to log in to their Organization. If false, the Member only needs to complete an MFA step if the Organization's MFA policy is set to REQUIRED_FOR_ALL.

Link copied to clipboard
val mfaPhoneNumber: String? = null

Sets the Member's phone number. Throws an error if the Member already has a phone number

Link copied to clipboard
val name: String? = null

the name of the member

Link copied to clipboard

a map of untrusted metadata to assign to the member