Struct AuthSessionHandle

pub struct AuthSessionHandle {
    ident: Arc<AuthSessionIdent>,
    external_metadata_rx: Receiver<ExternalUserMetadata>,
    authenticator: Arc<AuthenticatorInner>,
    app_password: AppPassword,
}

A handle to an authentication session.

An authentication session represents a duration of time during which a user’s authentication is known to be valid.

An authentication session begins with a successful API key exchange with Frontegg. While there is at least one outstanding handle to the session, the session’s metadata and validity are refreshed with Frontegg at a regular interval. The session ends when all outstanding handles are dropped and the refresh interval is reached.

AuthSessionHandle::external_metadata_rx can be used to receive events if the session’s metadata is updated.

AuthSessionHandle::expired can be used to learn if the session has failed to refresh the validity of the API key.

Fields

ident: Arc<AuthSessionIdent>

external_metadata_rx: Receiver<ExternalUserMetadata>

authenticator: Arc<AuthenticatorInner>

Hold a handle to the AuthenticatorInner so we can record when this session was dropped.

app_password: AppPassword

Used to record when the session linked with this AppPassword was dropped.

Implementations

impl AuthSessionHandle

pub fn user(&self) -> &str

Returns the name of the user that created the session.

pub fn tenant_id(&self) -> Uuid

Returns the ID of the tenant that created the session.

pub fn external_metadata_rx(&self) -> Receiver<ExternalUserMetadata>

Mints a receiver for updates to the session user’s external metadata.

pub async fn expired(&mut self)

Completes when the authentication session has expired.

Trait Implementations

impl Clone for AuthSessionHandle

fn clone(&self) -> AuthSessionHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AuthSessionHandle

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

Formats the value using the given formatter.

impl Drop for AuthSessionHandle

fn drop(&mut self)

Executes the destructor for this type.