Struct NativeAuthClient 

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

Available on crate feature native only.

The tool for managing authentication and identity.

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

Implementations

impl NativeAuthClient

pub fn new<T: AsRef<str>>(service_name: T) -> Result<Self, AuthClientError>

Available on crate feature keyring only.

Creates a new [AuthClient] with default options.

pub fn new_with_pem_directory<T, P>( service_name: T, directory: P, ) -> Result<Self, AuthClientError>

where T: Into<String>, P: Into<PathBuf>,

Available on crate feature pem only.

Creates a new [AuthClient] using the first PEM file found inside the provided directory.

pub fn new_with_options( options: NativeAuthClientCreateOptions, ) -> Result<Self, AuthClientError>

Creates a new [AuthClient] with the provided options.

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

Returns the identity of the user.

pub fn principal(&self) -> Result<Principal, String>

Returns the principal of the user.

pub fn is_authenticated(&self) -> bool

Checks if the user is authenticated.

pub fn idle_manager(&self) -> Option<IdleManager>

Returns the idle manager if it exists.

pub fn login<T: AsRef<str> + Send + 'static>( &self, ii_url: T, options: AuthClientLoginOptions, )

Logs the user in by opening a browser window to the identity provider.

pub fn logout(&self)

Log the user out.

Trait Implementations

impl Clone for NativeAuthClient

fn clone(&self) -> NativeAuthClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NativeAuthClient

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

Formats the value using the given formatter.