Struct firestore_db_and_auth::sessions::user::Session

pub struct Session {
    pub userid: String,
    pub refresh_token: Option<String>,
    pub api_key: String,
    pub bearer: String,
    pub projectid: String,
}

An impersonated session. If you access FireStore with such a session, FireStore rules might restrict access to data.

Fields

userid: String

refresh_token: Option<String>

api_key: String

bearer: String

projectid: String

Methods

impl Session

pub fn by_refresh_token(
    credentials: &Credentials,
    refresh_token: &str
) -> Result<Session>

Create a new firestore user session via a valid refresh_token

pub fn by_user_id(credentials: &Credentials, user_id: &str) -> Result<Session>

Create a new firestore user session with a fresh access token and new refresh token

pub fn new(
    credentials: &Credentials,
    user_id: Option<&str>,
    firebase_tokenid: Option<&str>,
    refresh_token: Option<&str>
) -> Result<Session>

Create an impersonated session

If the optionally provided access token is still valid, it will be used. If the access token is not valid anymore, but the given refresh token is, it will be used to retrieve a new access token.

If neither refresh token nor access token work are provided or valid, the service account credentials will be used to generate a new impersonated refresh and access token for the given user.

If none of the parameters are given, the function will error out.

See:

• https://firebase.google.com/docs/reference/rest/auth#section-refresh-token
• https://firebase.google.com/docs/auth/admin/create-custom-tokens#create_custom_tokens_using_a_third-party_jwt_library

pub fn by_access_token(
    credentials: &Credentials,
    firebase_tokenid: &str
) -> Result<Session>

Trait Implementations

impl<'a> FirebaseAuthBearer<'a> for Session

fn projectid(&'a self) -> &'a str

Return the project ID. This is required for the firebase REST API.

fn bearer(&'a self) -> String

An access token, preferably valid.

impl Debug for Session

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

Formats the value using the given formatter.

impl Serialize for Session

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Session

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.