Skip to main content

HasuraIdentity

Struct HasuraIdentity 

Source
pub struct HasuraIdentity {
    pub role: String,
    pub session: HashMap<String, String>,
    pub elevated: bool,
}
Expand description

Who the caller is, in Hasura’s sense of the word.

This is not a database role and must not be used as one. The corpus names roles like Artist and anonymous that exist in no catalogue, and Hasura connects as one database user whatever role a request claims. What the role decides is which permissions apply and what x-hasura-role reads as inside a function; which database user the transaction runs as is settled elsewhere and separately.

Fields§

§role: String

The role the caller speaks as.

§session: HashMap<String, String>

Session variables, stripped of the x-hasura- prefix, lowercased, and with dashes turned into underscores: user_id, allowed_ids. The same shape a verified token’s claims are reduced to, because a policy should not be able to tell which of the two it is reading.

§elevated: bool

Whether the admin secret authenticated this request.

Distinct from role == "admin", which an administrator gives up the moment it asks to be treated as someone else. Hasura keeps the distinction for one purpose – a mutation marked backend_only is reachable only by a caller that proved it holds the secret, whatever role it then claims – and that is what this records.

Trait Implementations§

Source§

impl Clone for HasuraIdentity

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HasuraIdentity

Source§

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

Formats the value using the given formatter. Read more

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<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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.