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

OrganizationMembers

Types

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

SearchParameters

data class SearchParameters(val cursor: String? = null, val limit: Int? = null, val query: Organization.OrganizationMembers.SearchQuery? = null)

Data class used for wrapping the parameters necessary to search members

SearchQuery

data class SearchQuery(val operator: SearchOperator, val operands: List<Organization.OrganizationMembers.SearchQueryOperand>)

The action to perform on the operands. The accepted value are: AND – all the operand values provided must match. OR – the operator will return any matches to at least one of the operand values you supply.

SearchQueryOperand

data class SearchQueryOperand(@Json(name = "filter_name") val filterName: String, @Json(name = "filter_value") val filterValue: Any)

UpdateMemberParameters

data class UpdateMemberParameters(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

Functions

create

abstract suspend fun create(parameters: Organization.OrganizationMembers.CreateMemberParameters): CreateMemberResponse

abstract fun create(parameters: Organization.OrganizationMembers.CreateMemberParameters, callback: (CreateMemberResponse) -> Unit)

Creates a Member. The caller must have permission to call this endpoint via the project's RBAC policy & their role assignments.

delete

abstract suspend fun delete(memberId: String): DeleteMemberResponse

abstract fun delete(memberId: String, callback: (DeleteMemberResponse) -> Unit)

Deletes a Member. The caller must have permission to call this endpoint via the project's RBAC policy & their role assignments.

deleteMemberAuthenticationFactor

abstract suspend fun deleteMemberAuthenticationFactor(memberId: String, authenticationFactor: MemberAuthenticationFactor): DeleteOrganizationMemberAuthenticationFactorResponse

abstract fun deleteMemberAuthenticationFactor(memberId: String, authenticationFactor: MemberAuthenticationFactor, callback: (DeleteOrganizationMemberAuthenticationFactorResponse) -> Unit)

Deletes a MemberAuthenticationFactor from the currently authenticated member

reactivate

abstract suspend fun reactivate(memberId: String): ReactivateMemberResponse

abstract fun reactivate(memberId: String, callback: (ReactivateMemberResponse) -> Unit)

Reactivates a deleted Member's status and its associated email status (if applicable) to active. The caller must have permission to call this endpoint via the project's RBAC policy & their role assignments.

abstract suspend fun search(parameters: Organization.OrganizationMembers.SearchParameters): MemberSearchResponse

abstract fun search(parameters: Organization.OrganizationMembers.SearchParameters, callback: (MemberSearchResponse) -> Unit)

Search for Members from the caller's organization. Submitting an empty query returns all non-deleted Members. All fuzzy search filters require a minimum of three characters. The caller must have permission to call this endpoint via the project's RBAC policy & their role assignments.

update

abstract suspend fun update(parameters: Organization.OrganizationMembers.UpdateMemberParameters): UpdateOrganizationMemberResponse

abstract fun update(parameters: Organization.OrganizationMembers.UpdateMemberParameters, callback: (UpdateOrganizationMemberResponse) -> Unit)

Updates a Member. The caller must have permission to call this endpoint via the project's RBAC policy & their role assignments.