Struct AuthenticatedUser 

pub struct AuthenticatedUser(/* private fields */);

Extractor for the authenticated user.

Spring Equivalent

@AuthenticationPrincipal User user parameter or SecurityContextHolder.getContext().getAuthentication().getPrincipal()

Usage

use actix_security_core::http::security::AuthenticatedUser;

async fn handler(user: AuthenticatedUser) -> impl Responder {
    format!("Hello, {}!", user.get_username())
}

Errors

Returns 401 Unauthorized if the user is not authenticated.

Implementations

impl AuthenticatedUser

pub fn new(user: User) -> AuthenticatedUser

Creates a new AuthenticatedUser wrapper.

pub fn into_inner(self) -> User

Returns the inner User.

Methods from Deref<Target = User>

pub fn get_username(&self) -> &str

Returns the username.

pub fn get_password(&self) -> &str

Returns the password (for authentication checks).

pub fn get_roles(&self) -> &[String]

Returns the user’s roles.

pub fn get_authorities(&self) -> &[String]

Returns the user’s authorities.

pub fn has_role(&self, role: &str) -> bool

Checks if the user has a specific role.

pub fn has_any_role(&self, roles: &[&str]) -> bool

Checks if the user has ANY of the specified roles (OR logic).

pub fn has_all_roles(&self, roles: &[&str]) -> bool

Checks if the user has ALL of the specified roles (AND logic).

pub fn has_authority(&self, authority: &str) -> bool

Checks if the user has a specific authority.

pub fn has_any_authority(&self, authorities: &[&str]) -> bool

Checks if the user has ANY of the specified authorities (OR logic).

pub fn has_all_authorities(&self, authorities: &[&str]) -> bool

Checks if the user has ALL of the specified authorities (AND logic).

pub fn has_roles(&self, roles: &[String]) -> bool

Checks if the user has ANY of the specified roles (legacy).

Trait Implementations

impl Clone for AuthenticatedUser

fn clone(&self) -> AuthenticatedUser

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AuthenticatedUser

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for AuthenticatedUser

type Target = User

The resulting type after dereferencing.

fn deref(&self) -> &<AuthenticatedUser as Deref>::Target

Dereferences the value.

impl FromRequest for AuthenticatedUser

type Error = AuthError

The associated error which can be returned.

type Future = Ready<Result<AuthenticatedUser, <AuthenticatedUser as FromRequest>::Error>>

Future that resolves to a Self.

fn from_request( req: &HttpRequest, _payload: &mut Payload, ) -> <AuthenticatedUser as FromRequest>::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.