Struct ic_auth_client::AuthClient

pub struct AuthClient {
    pub idle_manager: Option<IdleManager>,
    /* private fields */
}

The tool for managing authentication and identity. It maintains the state of the user’s identity and provides methods for authentication.

Fields

idle_manager: Option<IdleManager>

The idle manager that handles idle timeouts.

Implementations

impl AuthClient

pub fn builder() -> AuthClientBuilder

Create a new AuthClientBuilder for building an AuthClient.

pub async fn new() -> Self

Creates a new AuthClient with default options.

pub async fn new_with_options(options: AuthClientCreateOptions) -> Self

Creates a new AuthClient with the provided options.

pub fn identity(&self) -> Arc<dyn Identity>

Returns the identity of the user.

pub fn is_authenticated(&self) -> bool

Checks if the user is authenticated.

pub async fn login(&mut self)

Logs the user in with default options.

pub async fn login_with_options(&mut self, options: AuthClientLoginOptions)

Logs the user in with the provided options.

pub async fn logout(&self, return_to: Option<Location>)

Log the user out. If a return URL is provided, the user will be redirected to that URL after logging out.

Trait Implementations

impl Clone for AuthClient

fn clone(&self) -> AuthClient

Returns a copy of the value.

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

Performs copy-assignment from source.