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

CreateMemberParameters

data class CreateMemberParameters(val emailAddress: String, val name: String? = null, val isBreakGlass: Boolean? = null, val mfaEnrolled: Boolean? = null, val mfaPhoneNumber: String? = null, val untrustedMetadata: Map<String, Any?>? = null, val createMemberAsPending: Boolean? = null, val roles: List<String>? = null)

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

Constructors

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

Properties

createMemberAsPending

val createMemberAsPending: Boolean? = null

Flag for whether or not to save a Member as pending or active in Stytch. It defaults to false. If true, new Members will be created with status pending in Stytch's backend. Their status will remain pending and they will continue to receive signup email templates for every Email Magic Link until that Member authenticates and becomes active. If false, new Members will be created with status active.

emailAddress

val emailAddress: String

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.

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.

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.