Struct mz_frontegg_client::client::Client

source ·
pub struct Client {
    pub(crate) inner: Client,
    pub(crate) authentication: Authentication,
    pub(crate) endpoint: Url,
    pub(crate) auth: Mutex<Option<Auth>>,
}
Expand description

An API client for Frontegg.

The API client is designed to be wrapped in an Arc and used from multiple threads simultaneously. A successful authentication response is shared by all threads.

Fields§

§inner: Client§authentication: Authentication§endpoint: Url§auth: Mutex<Option<Auth>>

Implementations§

source§

impl Client

source

pub async fn list_app_passwords(&self) -> Result<Vec<AppPassword>, Error>

Lists all existing app passwords.

source

pub async fn create_app_password( &self, app_password: CreateAppPasswordRequest<'_>, ) -> Result<AuthAppPassword, Error>

Creates a new app password with the provided description.

source§

impl Client

source

pub async fn list_roles(&self) -> Result<Vec<Role>, Error>

Lists all available roles.

source§

impl Client

source

pub async fn list_users(&self) -> Result<Vec<User>, Error>

Lists all existing users.

source

pub async fn create_user( &self, new_user: CreateUserRequest, ) -> Result<CreatedUser, Error>

Creates a new user in the authenticated organization.

source

pub async fn remove_user( &self, remove_user: RemoveUserRequest, ) -> Result<(), Error>

Removes a user from the authenticated organization.

source§

impl Client

source

pub fn new(config: ClientConfig) -> Client

Creates a new Client from its required configuration parameters.

source

pub fn builder() -> ClientBuilder

Creates a builder for a Client that allows for customization of optional parameters.

source

fn build_request<P>(&self, method: Method, path: P) -> RequestBuilder
where P: IntoIterator, P::Item: AsRef<str>,

Builds a request towards the Client’s endpoint

source

async fn send_request<T>(&self, req: RequestBuilder) -> Result<T, Error>

Sends a requests and adds the authorization bearer token.

source

async fn send_unauthenticated_request<T>( &self, req: RequestBuilder, ) -> Result<T, Error>

source

pub async fn auth(&self) -> Result<String, Error>

Authenticates with the server, if not already authenticated, and returns the authentication token.

source

async fn get_jwks(&self) -> Result<JwkSet, Error>

Returns the JSON Web Key Set (JWKS) from the well known endpoint: /.well-known/jwks.json

source

pub async fn claims(&self) -> Result<Claims, Error>

Verifies the JWT signature using a JWK from the well-known endpoint and returns the user claims.

Auto Trait Implementations§

§

impl !Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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, U> CastInto<U> for T
where U: CastFrom<T>,

source§

fn cast_into(self) -> U

Performs the cast.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FutureExt for T

source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<T, U> OverrideFrom<Option<&T>> for U
where U: OverrideFrom<T>,

source§

fn override_from(self, layer: &Option<&T>) -> U

Override the configuration represented by Self with values from the given layer.
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<P, R> ProtoType<R> for P
where R: RustType<P>,

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<'a, S, T> Semigroup<&'a S> for T
where T: Semigroup<S>,

source§

fn plus_equals(&mut self, rhs: &&'a S)

The method of std::ops::AddAssign, for types that do not implement AddAssign.
source§

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

§

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>,

§

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