Struct UserManagement

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

User Management.

WorkOS Docs: User Management

Implementations

impl<'a> UserManagement<'a>

pub fn new(workos: &'a WorkOs) -> Self

Returns a new UserManagement instance for the provided WorkOS client.

Trait Implementations

impl AuthenticateWithCode for UserManagement<'_>

fn authenticate_with_code<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 AuthenticateWithCodeParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<AuthenticationResponse, AuthenticateError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Authenticates a user using AuthKit, OAuth or an organization’s SSO connection.

impl AuthenticateWithEmailVerification for UserManagement<'_>

fn authenticate_with_email_verification<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 AuthenticateWithEmailVerificationParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<AuthenticationResponse, AuthenticateError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Authenticates a user with an unverified email and verifies their email address.

impl AuthenticateWithMagicAuth for UserManagement<'_>

fn authenticate_with_magic_auth<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 AuthenticateWithMagicAuthParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<AuthenticationResponse, AuthenticateError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Authenticates a user by verifying the Magic Auth code sent to the user’s email.

impl AuthenticateWithPassword for UserManagement<'_>

fn authenticate_with_password<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 AuthenticateWithPasswordParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<AuthenticationResponse, AuthenticateError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Authenticates a user with email and password.

impl AuthenticateWithRefreshToken for UserManagement<'_>

fn authenticate_with_refresh_token<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 AuthenticateWithRefreshTokenParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<AuthenticationResponse, AuthenticateError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Use this endpoint to exchange a refresh token for a new access token.

impl AuthenticateWithTotp for UserManagement<'_>

fn authenticate_with_totp<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 AuthenticateWithTotpParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<AuthenticationResponse, AuthenticateError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Authenticates a user enrolled into MFA using time-based one-time password (TOTP).

impl CreateMagicAuth for UserManagement<'_>

fn create_magic_auth<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 CreateMagicAuthParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<MagicAuth, CreateMagicAuthError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Creates a one-time authentication code that can be sent to the user’s email address.

impl CreatePasswordReset for UserManagement<'_>

fn create_password_reset<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 CreatePasswordResetParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<PasswordReset, CreatePasswordResetError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Creates a one-time token that can be used to reset a user’s password.

impl CreateUser for UserManagement<'_>

fn create_user<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 CreateUserParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<User, CreateUserError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create a new user in the current environment.

impl DeleteUser for UserManagement<'_>

fn delete_user<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 DeleteUserParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<(), DeleteUserError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Permanently deletes a user in the current environment. It cannot be undone.

impl EnrollAuthFactor for UserManagement<'_>

fn enroll_auth_factor<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 EnrollAuthFactorParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<EnrollAuthFactorResponse, EnrollAuthFactorError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Enrolls a user in a new authentication factor.

impl GetAuthorizationUrl for UserManagement<'_>

fn get_authorization_url( &self, params: &GetAuthorizationUrlParams<'_>, ) -> Result<Url, ParseError>

Generates an OAuth 2.0 authorization URL to authenticate a user with AuthKit or SSO.

impl GetEmailVerification for UserManagement<'_>

fn get_email_verification<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 EmailVerificationId, ) -> Pin<Box<dyn Future<Output = WorkOsResult<EmailVerification, GetEmailVerificationError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get the details of an existing email verification code that can be used to send an email to a user for verification.

impl GetJwks for UserManagement<'_>

fn get_jwks<'life0, 'life1, 'async_trait>( &'life0 self, client_id: &'life1 ClientId, ) -> Pin<Box<dyn Future<Output = WorkOsResult<JwkSet, GetJwksError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get JSON Web Key Set (JWKS).

impl GetJwksUrl for UserManagement<'_>

fn get_jwks_url(&self, client_id: &ClientId) -> Result<Url, ParseError>

Returns a URL that hosts the JWKS for signing access tokens.

impl GetLogoutUrl for UserManagement<'_>

fn get_logout_url( &self, params: &GetLogoutUrlParams<'_>, ) -> Result<Url, ParseError>

Returns a logout URL the user’s browser should be redirected to.

impl GetMagicAuth for UserManagement<'_>

fn get_magic_auth<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 MagicAuthId, ) -> Pin<Box<dyn Future<Output = WorkOsResult<MagicAuth, GetMagicAuthError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get the details of an existing Magic Auth code that can be used to send an email to a user for authentication.

impl GetPasswordReset for UserManagement<'_>

fn get_password_reset<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 PasswordResetId, ) -> Pin<Box<dyn Future<Output = WorkOsResult<PasswordReset, GetPasswordResetError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get the details of an existing password reset token that can be used to reset a user’s password.

impl GetUser for UserManagement<'_>

fn get_user<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 UserId, ) -> Pin<Box<dyn Future<Output = WorkOsResult<User, GetUserError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get the details of an existing user.

impl GetUserByExternalId for UserManagement<'_>

fn get_user_by_external_id<'life0, 'life1, 'async_trait>( &'life0 self, external_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = WorkOsResult<User, GetUserByExternalIdError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get the details of an existing user by an external identifier.

impl GetUserIdentities for UserManagement<'_>

fn get_user_identities<'life0, 'life1, 'async_trait>( &'life0 self, user_id: &'life1 UserId, ) -> Pin<Box<dyn Future<Output = WorkOsResult<Vec<Identity>, GetUserIdentitiesError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get a list of identities associated with the user.

impl ListAuthFactors for UserManagement<'_>

fn list_auth_factors<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 ListAuthFactorsParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<PaginatedList<AuthenticationFactor>, ()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Lists the authentication factors for a user.

impl ListUsers for UserManagement<'_>

fn list_users<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 ListUsersParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<PaginatedList<User>, ListUsersError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Retrieves a list of Users.

impl ResetPassword for UserManagement<'_>

fn reset_password<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 ResetPasswordParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<ResetPasswordResponse, ResetPasswordError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Sets a new password using the token query parameter from the link that the user received.

impl UpdateUser for UserManagement<'_>

fn update_user<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, params: &'life1 UpdateUserParams<'life2>, ) -> Pin<Box<dyn Future<Output = WorkOsResult<User, UpdateUserError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Updates properties of a user. The omitted properties will be left unchanged.