Struct UserOperations 

pub struct UserOperations<'a> { /* private fields */ }

Focused user-management operations exposed from AuthFramework::users.

Example

// Register
let uid = auth.users().register("alice", "alice@example.com", "P@ssw0rd!").await?;

// Look up
let user = auth.users().get(&uid).await?;
assert_eq!(user.username, "alice");

// Update password
auth.users().update_password_by_id(&uid, "NewP@ss!").await?;

Implementations

impl UserOperations<'_>

pub async fn register( &self, username: &str, email: &str, password: &str, ) -> Result<String>

Register a new user and return the generated user ID.

pub async fn list( &self, limit: Option<usize>, offset: Option<usize>, active_only: bool, ) -> Result<Vec<UserInfo>>

👎Deprecated since 0.6.0:

use list_with_query(UserListQuery::new().limit(n).active_only()) instead

List users from the canonical user index.

Prefer list_with_query which uses a UserListQuery builder for better readability at call sites.

pub async fn list_with_query( &self, query: UserListQuery, ) -> Result<Vec<UserInfo>>

List users using a UserListQuery for better readability.

Example

let active = auth.users()
    .list_with_query(UserListQuery::new().limit(50).active_only())
    .await?;

pub async fn get(&self, user_id: &str) -> Result<UserInfo>

Fetch a user record by canonical user ID.

pub async fn exists_by_username(&self, username: &str) -> Result<bool>

Check whether a username exists.

pub async fn exists_by_email(&self, email: &str) -> Result<bool>

Check whether an email exists.

pub async fn get_by_username( &self, username: &str, ) -> Result<HashMap<String, Value>>

Fetch a user record by username.

pub async fn profile(&self, user_id: &str) -> Result<ProviderProfile>

Fetch an application-level user profile.

pub async fn update_password( &self, username: &str, new_password: &str, ) -> Result<()>

Update a user’s password.

pub async fn update_password_by_id( &self, user_id: &str, new_password: &str, ) -> Result<()>

Update a user’s password by user ID.

pub async fn update_roles(&self, user_id: &str, roles: &[String]) -> Result<()>

Update the roles assigned to a user.

pub async fn set_active(&self, user_id: &str, active: bool) -> Result<()>

👎Deprecated since 0.5.0:

use set_status(id, UserStatus) instead

Enable or disable a user.

pub async fn set_status(&self, user_id: &str, status: UserStatus) -> Result<()>

Change whether a user account is active or inactive.

Inactive users cannot authenticate until re-activated.

Example

auth.users().set_status(&user_id, UserStatus::Inactive).await?;

pub async fn update_email(&self, user_id: &str, email: &str) -> Result<()>

Update a user’s email address.

pub async fn verify_password( &self, user_id: &str, password: &str, ) -> Result<bool>

Verify a user’s password.

pub async fn username(&self, user_id: &str) -> Result<String>

Resolve a username from a user ID.

pub async fn delete(&self, username: &str) -> Result<()>

Delete a user by username.

pub async fn delete_by_id(&self, user_id: &str) -> Result<()>

Delete a user by user ID.

pub fn check_username(&self, username: &str) -> Result<()>

Validate a username against the configured format rules.

Returns Ok(()) when the username is acceptable, or Err(AuthError::Validation { .. }) describing the policy violation.

Example

auth.users().check_username("alice")?;
// Returns Err explaining why the name is invalid:
assert!(auth.users().check_username("").is_err());

pub fn check_password_strength(&self, password: &str) -> Result<()>

Validate a password against the active security policy.

Returns Ok(()) when the password meets production strength requirements, or Err(AuthError::Validation { .. }) with feedback.

Example

auth.users().check_password_strength("C0mpl3x!Pa$$word")?;
assert!(auth.users().check_password_strength("weak").is_err());

pub fn check_email(&self, email: &str) -> Result<()>

Validate an email address against RFC 5322 format rules.

Returns Ok(()) when the email is acceptable, or Err(AuthError::Validation { .. }) describing the issue.

Example

auth.users().check_email("alice@example.com")?;
assert!(auth.users().check_email("not-an-email").is_err());