Stytch B2B SDK/com.stytch.sdk.b2b.members/B2BMembersClient/create

create

abstract suspend fun create(request: IOrganizationsMemberCreateParameters): OrganizationsMemberCreateResponse

Creates a new member in the organization. Calls the POST /sdk/v1/b2b/organizations/members endpoint. Requires an active session and appropriate RBAC permissions.

Kotlin:

StytchB2B.members.create(
    OrganizationsMemberCreateParameters(
        emailAddress = "newmember@example.com",
        isBreakglass = false,
        createMemberAsPending = false,
        roles = listOf("member"),
    )
)

iOS:

let params = OrganizationsMemberCreateParameters(
    emailAddress: "newmember@example.com",
    isBreakglass: false,
    createMemberAsPending: false,
    roles: ["member"]
)
let response = try await StytchB2B.members.create(params)

React Native:

StytchB2B.members.create({
    emailAddress: "newmember@example.com",
    isBreakglass: false,
    createMemberAsPending: false,
    roles: ["member"],
})

Return

OrganizationsMemberCreateResponse containing the newly created member.

Parameters

request

IOrganizationsMemberCreateParameters
emailAddress — The email address of the new member.
isBreakglass — Whether this is a breakglass (emergency access) account.
createMemberAsPending — Whether to create the member in a pending state.
roles — List of RBAC role IDs to assign to the member.
name? — Display name for the new member.
mfaEnrolled? — Whether MFA is enrolled.
mfaPhoneNumber? — MFA phone number.
untrustedMetadata? — Client-settable key-value metadata.

Throws

StytchError

if the request fails or the email is already in use.

CancellationException

if the coroutine is cancelled.