UsersApi class

Constructors

UsersApi.new([ApiClient? apiClient])

Properties

apiClient ApiClient
final
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

banUser(String userId) Future<User?>
Ban a user
banUserWithHttpInfo(String userId) Future<Response>
Ban a user
createUser(CreateUserRequest createUserRequest) Future<User?>
Create a new user
createUserWithHttpInfo(CreateUserRequest createUserRequest) Future<Response>
Create a new user
deleteBackupCode(String userId) Future<DisableMFA200Response?>
Disable all user's Backup codes
deleteBackupCodeWithHttpInfo(String userId) Future<Response>
Disable all user's Backup codes
deleteExternalAccount(String userId, String externalAccountId) Future<DeletedObject?>
Delete External Account
deleteExternalAccountWithHttpInfo(String userId, String externalAccountId) Future<Response>
Delete External Account
deleteTOTP(String userId) Future<DisableMFA200Response?>
Delete all the user's TOTPs
deleteTOTPWithHttpInfo(String userId) Future<Response>
Delete all the user's TOTPs
deleteUser(String userId) Future<DeletedObject?>
Delete a user
deleteUserProfileImage(String userId) Future<User?>
Delete user profile image
deleteUserProfileImageWithHttpInfo(String userId) Future<Response>
Delete user profile image
deleteUserWithHttpInfo(String userId) Future<Response>
Delete a user
disableMFA(String userId) Future<DisableMFA200Response?>
Disable a user's MFA methods
disableMFAWithHttpInfo(String userId) Future<Response>
Disable a user's MFA methods
getOAuthAccessToken(String userId, String provider, {bool? paginated, int? limit, int? offset}) Future<List<GetOAuthAccessToken200ResponseInner>?>
Retrieve the OAuth access token of a user
getOAuthAccessTokenWithHttpInfo(String userId, String provider, {bool? paginated, int? limit, int? offset}) Future<Response>
Retrieve the OAuth access token of a user
getUser(String userId) Future<User?>
Retrieve a user
getUserList({List<String>? emailAddress, List<String>? phoneNumber, List<String>? externalId, List<String>? username, List<String>? web3Wallet, List<String>? userId, List<String>? organizationId, String? query, String? emailAddressQuery, String? phoneNumberQuery, String? usernameQuery, String? nameQuery, bool? banned, int? lastActiveAtBefore, int? lastActiveAtAfter, int? lastActiveAtSince, int? createdAtBefore, int? createdAtAfter, int? limit, int? offset, String? orderBy}) Future<List<User>?>
List all users
getUserListWithHttpInfo({List<String>? emailAddress, List<String>? phoneNumber, List<String>? externalId, List<String>? username, List<String>? web3Wallet, List<String>? userId, List<String>? organizationId, String? query, String? emailAddressQuery, String? phoneNumberQuery, String? usernameQuery, String? nameQuery, bool? banned, int? lastActiveAtBefore, int? lastActiveAtAfter, int? lastActiveAtSince, int? createdAtBefore, int? createdAtAfter, int? limit, int? offset, String? orderBy}) Future<Response>
List all users
getUsersCount({List<String>? emailAddress, List<String>? phoneNumber, List<String>? externalId, List<String>? username, List<String>? web3Wallet, List<String>? userId, List<String>? organizationId, String? query, String? emailAddressQuery, String? phoneNumberQuery, String? usernameQuery, String? nameQuery, bool? banned, int? lastActiveAtBefore, int? lastActiveAtAfter, int? lastActiveAtSince, int? createdAtBefore, int? createdAtAfter}) Future<TotalCount?>
Count users
getUsersCountWithHttpInfo({List<String>? emailAddress, List<String>? phoneNumber, List<String>? externalId, List<String>? username, List<String>? web3Wallet, List<String>? userId, List<String>? organizationId, String? query, String? emailAddressQuery, String? phoneNumberQuery, String? usernameQuery, String? nameQuery, bool? banned, int? lastActiveAtBefore, int? lastActiveAtAfter, int? lastActiveAtSince, int? createdAtBefore, int? createdAtAfter}) Future<Response>
Count users
getUserWithHttpInfo(String userId) Future<Response>
Retrieve a user
lockUser(String userId) Future<User?>
Lock a user
lockUserWithHttpInfo(String userId) Future<Response>
Lock a user
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setUserProfileImage(String userId, {MultipartFile? file}) Future<User?>
Set user profile image
setUserProfileImageWithHttpInfo(String userId, {MultipartFile? file}) Future<Response>
Set user profile image
toString() String
A string representation of this object.
inherited
unbanUser(String userId) Future<User?>
Unban a user
unbanUserWithHttpInfo(String userId) Future<Response>
Unban a user
unlockUser(String userId) Future<User?>
Unlock a user
unlockUserWithHttpInfo(String userId) Future<Response>
Unlock a user
updateUser(String userId, UpdateUserRequest updateUserRequest) Future<User?>
Update a user
updateUserMetadata(String userId, {UpdateUserMetadataRequest? updateUserMetadataRequest}) Future<User?>
Merge and update a user's metadata
updateUserMetadataWithHttpInfo(String userId, {UpdateUserMetadataRequest? updateUserMetadataRequest}) Future<Response>
Merge and update a user's metadata
updateUserWithHttpInfo(String userId, UpdateUserRequest updateUserRequest) Future<Response>
Update a user
userPasskeyDelete(String userId, String passkeyIdentificationId) Future<DeletedObject?>
Delete a user passkey
userPasskeyDeleteWithHttpInfo(String userId, String passkeyIdentificationId) Future<Response>
Delete a user passkey
usersGetOrganizationInvitations(String userId, {int? limit, int? offset, String? status}) Future<OrganizationInvitationsWithPublicOrganizationData?>
Retrieve all invitations for a user
usersGetOrganizationInvitationsWithHttpInfo(String userId, {int? limit, int? offset, String? status}) Future<Response>
Retrieve all invitations for a user
usersGetOrganizationMemberships(String userId, {int? limit, int? offset}) Future<OrganizationMemberships?>
Retrieve all memberships for a user
usersGetOrganizationMembershipsWithHttpInfo(String userId, {int? limit, int? offset}) Future<Response>
Retrieve all memberships for a user
userWeb3WalletDelete(String userId, String web3WalletIdentificationId) Future<DeletedObject?>
Delete a user web3 wallet
userWeb3WalletDeleteWithHttpInfo(String userId, String web3WalletIdentificationId) Future<Response>
Delete a user web3 wallet
verifyPassword(String userId, {VerifyPasswordRequest? verifyPasswordRequest}) Future<VerifyPassword200Response?>
Verify the password of a user
verifyPasswordWithHttpInfo(String userId, {VerifyPasswordRequest? verifyPasswordRequest}) Future<Response>
Verify the password of a user
verifyTOTP(String userId, {VerifyTOTPRequest? verifyTOTPRequest}) Future<VerifyTOTP200Response?>
Verify a TOTP or backup code for a user
verifyTOTPWithHttpInfo(String userId, {VerifyTOTPRequest? verifyTOTPRequest}) Future<Response>
Verify a TOTP or backup code for a user

Operators

operator ==(Object other) bool
The equality operator.
inherited