Stytch Android/com.stytch.sdk.b2b.organization/Organization/OrganizationMembers/UpdateMemberParameters

UpdateMemberParameters

data class UpdateMemberParameters @JvmOverloads constructor(val memberId: String, val emailAddress: String? = null, val name: String? = null, val isBreakGlass: Boolean? = null, val mfaEnrolled: Boolean? = null, val mfaPhoneNumber: String? = null, val untrustedMetadata: Map<String, Any?>? = null, val roles: List<String>? = null, val preserveExistingSessions: Boolean? = null, val defaultMfaMethod: MfaMethod? = null)

Data class used for wrapping the parameters necessary for creating a user

Constructors

@JvmOverloads

constructor(memberId: String, emailAddress: String? = null, name: String? = null, isBreakGlass: Boolean? = null, mfaEnrolled: Boolean? = null, mfaPhoneNumber: String? = null, untrustedMetadata: Map<String, Any?>? = null, roles: List<String>? = null, preserveExistingSessions: Boolean? = null, defaultMfaMethod: MfaMethod? = null)

Properties

defaultMfaMethod

val defaultMfaMethod: MfaMethod? = null

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

emailAddress

val emailAddress: String? = null

the Member's email_address

isBreakGlass

val isBreakGlass: Boolean? = null

Identifies the Member as a break glass user - someone who has permissions to authenticate into an Organization by bypassing the Organization's settings. A break glass account is typically used for emergency purposes to gain access outside of normal authentication procedures.

memberId

val memberId: String

Globally unique UUID that identifies a specific Member.

mfaEnrolled

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.

mfaPhoneNumber

val mfaPhoneNumber: String? = null

The Member's phone number. A Member may only have one phone number.

name

val name: String? = null

The name of the Member.

preserveExistingSessions

val preserveExistingSessions: Boolean? = null

Whether to preserve existing sessions when explicit Roles that are revoked are also implicitly assigned by SSO connection or SSO group. Defaults to false - that is, existing Member Sessions that contain SSO authentication factors with the affected SSO connection IDs will be revoked.

roles

val roles: List<String>? = null

Roles to explicitly assign to this Member.

untrustedMetadata

val untrustedMetadata: Map<String, Any?>? = null

An arbitrary JSON object of application-specific data. These fields can be edited directly by the frontend SDK, and should not be used to store critical information.