Module user_api

Source

Structs§

CreateUserParams
struct for passing parameters to the method create_user
DeleteUserParams
struct for passing parameters to the method delete_user
GetUserParams
struct for passing parameters to the method get_user
RequestPasswordResetParams
struct for passing parameters to the method request_password_reset
UpdateUserParams
struct for passing parameters to the method update_user
UpdateUserPasswordParams
struct for passing parameters to the method update_user_password

Enums§

CreateUserError
struct for typed errors of method create_user
DeleteUserError
struct for typed errors of method delete_user
GetCurrentUserError
struct for typed errors of method get_current_user
GetUserError
struct for typed errors of method get_user
RequestPasswordResetError
struct for typed errors of method request_password_reset
UpdateUserError
struct for typed errors of method update_user
UpdateUserPasswordError
struct for typed errors of method update_user_password

Functions§

create_user
Create a user.
delete_user
Delete a user.
get_current_user
Get the logged in user.
get_user
Get a specific user.
request_password_reset
Requests a password reset for the specified user.
update_user
Update a user. Only users with the role of superuser can make changes to other users on the account. Non-superusers may use this endpoint to make changes to their own account. Two-factor attributes are not editable via this endpoint.
update_user_password
Update the user’s password to a new one.