Skip to main content

AuthClient

Struct AuthClient 

Source
pub struct AuthClient { /* private fields */ }
Expand description

Firebase Authentication client.

A single concrete type serves both live and emulator use: mode is a runtime field (ClientMode), not a type parameter, so every method below has exactly one signature regardless of environment. Build one with AuthClientBuilder.

Implementations§

Source§

impl AuthClient

Source

pub fn builder(project_id: impl Into<String>) -> AuthClientBuilder

Starts building a new client for the given Firebase project.

Source

pub fn project_id(&self) -> &ProjectId

Returns the Firebase project id this client is configured for.

Source

pub async fn verify_id_token( &self, token: &str, ) -> Result<IdTokenClaims, AuthError>

Verifies a Firebase ID token, returning its claims.

Source

pub fn create_custom_token( &self, uid: &str, claims: Option<Map<String, Value>>, ) -> Result<String, AuthError>

Creates a Firebase custom token for the given uid.

Requires the client to have been built with an explicit service account key; Application Default Credentials do not expose a private key and cannot sign custom tokens.

Exchanges a verified ID token for a session cookie valid for valid_duration (Firebase allows up to 14 days).

Verifies a Firebase session cookie, returning its claims.

Verified against a different certificate endpoint and issuer than Self::verify_id_token — see crate::auth::session_cookie::verify for why the two aren’t interchangeable.

Source

pub async fn get_user(&self, uid: &str) -> Result<UserRecord, AuthError>

Fetches a user by uid.

Source

pub async fn get_user_by_email( &self, email: &str, ) -> Result<UserRecord, AuthError>

Fetches a user by email address.

Source

pub async fn create_user( &self, request: CreateUserRequest, ) -> Result<UserRecord, AuthError>

Creates a new user.

Source

pub async fn update_user( &self, uid: &str, request: UpdateUserRequest, ) -> Result<UserRecord, AuthError>

Updates an existing user.

Source

pub async fn set_custom_user_claims( &self, uid: &str, claims: Map<String, Value>, ) -> Result<(), AuthError>

Replaces a user’s custom claims.

Source

pub async fn delete_user(&self, uid: &str) -> Result<(), AuthError>

Deletes a user by uid.

Source

pub async fn list_users( &self, max_results: u32, page_token: Option<&str>, ) -> Result<UserPage, AuthError>

Lists users, paginated via next_page_token.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more