Interface Organization.OrganizationMembers
-
- All Implemented Interfaces:
public interface Organization.OrganizationMembersAn interface that provides methods for performing create, update, delete, reactivate, and search operations on an Organization's members
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classOrganization.OrganizationMembers.CreateMemberParametersData class used for wrapping the parameters necessary for creating a user
public final classOrganization.OrganizationMembers.UpdateMemberParametersData class used for wrapping the parameters necessary for creating a user
public final classOrganization.OrganizationMembers.SearchParametersData class used for wrapping the parameters necessary to search members
public final classOrganization.OrganizationMembers.SearchQueryA data class representing conditions for a query
public classOrganization.OrganizationMembers.SearchQueryOperandA data class representing a Search Query Operand, which contains all of the filters and values to apply to your search query.
-
Method Summary
Modifier and Type Method Description abstract StytchResult<OrganizationMemberDeleteResponseData>delete(String memberId)Deletes a Member. abstract Unitdelete(String memberId, Function1<StytchResult<OrganizationMemberDeleteResponseData>, Unit> callback)Deletes a Member. abstract CompletableFuture<StytchResult<OrganizationMemberDeleteResponseData>>deleteCompletable(String memberId)Deletes a Member. abstract StytchResult<MemberResponseCommonData>reactivate(String memberId)Reactivates a deleted Member's status and its associated email status (if applicable) to active. abstract Unitreactivate(String memberId, Function1<StytchResult<MemberResponseCommonData>, Unit> callback)Reactivates a deleted Member's status and its associated email status (if applicable) to active. abstract CompletableFuture<StytchResult<MemberResponseCommonData>>reactivateCompletable(String memberId)Reactivates a deleted Member's status and its associated email status (if applicable) to active. abstract StytchResult<MemberResponseCommonData>deleteMemberAuthenticationFactor(String memberId, MemberAuthenticationFactor authenticationFactor)Deletes a MemberAuthenticationFactor from the currently authenticated member abstract UnitdeleteMemberAuthenticationFactor(String memberId, MemberAuthenticationFactor authenticationFactor, Function1<StytchResult<MemberResponseCommonData>, Unit> callback)Deletes a MemberAuthenticationFactor from the currently authenticated member abstract CompletableFuture<StytchResult<MemberResponseCommonData>>deleteMemberAuthenticationFactorCompletable(String memberId, MemberAuthenticationFactor authenticationFactor)Deletes a MemberAuthenticationFactor from the currently authenticated member abstract StytchResult<MemberResponseCommonData>create(Organization.OrganizationMembers.CreateMemberParameters parameters)Creates a Member. abstract Unitcreate(Organization.OrganizationMembers.CreateMemberParameters parameters, Function1<StytchResult<MemberResponseCommonData>, Unit> callback)Creates a Member. abstract CompletableFuture<StytchResult<MemberResponseCommonData>>createCompletable(Organization.OrganizationMembers.CreateMemberParameters parameters)Creates a Member. abstract StytchResult<MemberResponseCommonData>update(Organization.OrganizationMembers.UpdateMemberParameters parameters)Updates a Member. abstract Unitupdate(Organization.OrganizationMembers.UpdateMemberParameters parameters, Function1<StytchResult<MemberResponseCommonData>, Unit> callback)Updates a Member. abstract CompletableFuture<StytchResult<MemberResponseCommonData>>updateCompletable(Organization.OrganizationMembers.UpdateMemberParameters parameters)Updates a Member. abstract StytchResult<MemberSearchResponseData>search(Organization.OrganizationMembers.SearchParameters parameters)Search for Members from the caller's organization. abstract Unitsearch(Organization.OrganizationMembers.SearchParameters parameters, Function1<StytchResult<MemberSearchResponseData>, Unit> callback)Search for Members from the caller's organization. abstract CompletableFuture<StytchResult<MemberSearchResponseData>>searchCompletable(Organization.OrganizationMembers.SearchParameters parameters)Search for Members from the caller's organization. -
-
Method Detail
-
delete
abstract StytchResult<OrganizationMemberDeleteResponseData> delete(String memberId)
Deletes a Member. The caller must have permission to call this endpoint via the project's RBAC policy & their role assignments.
- Parameters:
memberId- The ID of the member to be deleted- Returns:
DeleteMemberResponse
-
delete
abstract Unit delete(String memberId, Function1<StytchResult<OrganizationMemberDeleteResponseData>, Unit> callback)
Deletes a Member. The caller must have permission to call this endpoint via the project's RBAC policy & their role assignments.
- Parameters:
memberId- The ID of the member to be deletedcallback- a callback that receives a DeleteMemberResponse
-
deleteCompletable
abstract CompletableFuture<StytchResult<OrganizationMemberDeleteResponseData>> deleteCompletable(String memberId)
Deletes a Member. The caller must have permission to call this endpoint via the project's RBAC policy & their role assignments.
- Parameters:
memberId- The ID of the member to be deleted- Returns:
DeleteMemberResponse
-
reactivate
abstract StytchResult<MemberResponseCommonData> reactivate(String memberId)
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.
- Parameters:
memberId- The ID of the member to be reactivated- Returns:
ReactivateMemberResponse
-
reactivate
abstract Unit reactivate(String memberId, Function1<StytchResult<MemberResponseCommonData>, Unit> callback)
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.
- Parameters:
memberId- The ID of the member to be reactivatedcallback- a callback that receives a ReactivateMemberResponse
-
reactivateCompletable
abstract CompletableFuture<StytchResult<MemberResponseCommonData>> reactivateCompletable(String memberId)
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.
- Parameters:
memberId- The ID of the member to be reactivated- Returns:
ReactivateMemberResponse
-
deleteMemberAuthenticationFactor
abstract StytchResult<MemberResponseCommonData> deleteMemberAuthenticationFactor(String memberId, MemberAuthenticationFactor authenticationFactor)
Deletes a MemberAuthenticationFactor from the currently authenticated member
- Parameters:
authenticationFactor- the authentication factor to delete- Returns:
DeleteOrganizationMemberAuthenticationFactorResponse
-
deleteMemberAuthenticationFactor
abstract Unit deleteMemberAuthenticationFactor(String memberId, MemberAuthenticationFactor authenticationFactor, Function1<StytchResult<MemberResponseCommonData>, Unit> callback)
Deletes a MemberAuthenticationFactor from the currently authenticated member
- Parameters:
authenticationFactor- the authentication factor to deletecallback- a callback that receives a DeleteOrganizationMemberAuthenticationFactorResponse
-
deleteMemberAuthenticationFactorCompletable
abstract CompletableFuture<StytchResult<MemberResponseCommonData>> deleteMemberAuthenticationFactorCompletable(String memberId, MemberAuthenticationFactor authenticationFactor)
Deletes a MemberAuthenticationFactor from the currently authenticated member
- Parameters:
authenticationFactor- the authentication factor to delete- Returns:
DeleteOrganizationMemberAuthenticationFactorResponse
-
create
abstract StytchResult<MemberResponseCommonData> create(Organization.OrganizationMembers.CreateMemberParameters parameters)
Creates a Member. The caller must have permission to call this endpoint via the project's RBAC policy & their role assignments.
- Parameters:
parameters- the parameters required for creating a user- Returns:
CreateMemberResponse
-
create
abstract Unit create(Organization.OrganizationMembers.CreateMemberParameters parameters, Function1<StytchResult<MemberResponseCommonData>, Unit> callback)
Creates a Member. The caller must have permission to call this endpoint via the project's RBAC policy & their role assignments.
- Parameters:
parameters- the parameters required for creating a usercallback- a callback that receives a CreateMemberResponse
-
createCompletable
abstract CompletableFuture<StytchResult<MemberResponseCommonData>> createCompletable(Organization.OrganizationMembers.CreateMemberParameters parameters)
Creates a Member. The caller must have permission to call this endpoint via the project's RBAC policy & their role assignments.
- Parameters:
parameters- the parameters required for creating a user- Returns:
CreateMemberResponse
-
update
abstract StytchResult<MemberResponseCommonData> update(Organization.OrganizationMembers.UpdateMemberParameters parameters)
Updates a Member. The caller must have permission to call this endpoint via the project's RBAC policy & their role assignments.
- Parameters:
parameters- the parameters required for updating a user- Returns:
UpdateOrganizationMemberResponse
-
update
abstract Unit update(Organization.OrganizationMembers.UpdateMemberParameters parameters, Function1<StytchResult<MemberResponseCommonData>, Unit> callback)
Updates a Member. The caller must have permission to call this endpoint via the project's RBAC policy & their role assignments.
- Parameters:
parameters- the parameters required for updating a usercallback- a callback that receives a UpdateOrganizationMemberResponse
-
updateCompletable
abstract CompletableFuture<StytchResult<MemberResponseCommonData>> updateCompletable(Organization.OrganizationMembers.UpdateMemberParameters parameters)
Updates a Member. The caller must have permission to call this endpoint via the project's RBAC policy & their role assignments.
- Parameters:
parameters- the parameters required for updating a user- Returns:
UpdateOrganizationMemberResponse
-
search
abstract StytchResult<MemberSearchResponseData> search(Organization.OrganizationMembers.SearchParameters parameters)
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.
- Parameters:
parameters- the parameters for searching- Returns:
MemberSearchResponse
-
search
abstract Unit search(Organization.OrganizationMembers.SearchParameters parameters, Function1<StytchResult<MemberSearchResponseData>, Unit> callback)
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.
- Parameters:
parameters- the parameters for searchingcallback- a callback that receives a MemberSearchResponse
-
searchCompletable
abstract CompletableFuture<StytchResult<MemberSearchResponseData>> searchCompletable(Organization.OrganizationMembers.SearchParameters parameters)
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.
- Parameters:
parameters- the parameters for searching- Returns:
MemberSearchResponse
-
-
-
-