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
impl Client
sourcepub async fn list_app_passwords(&self) -> Result<Vec<AppPassword>, Error>
pub async fn list_app_passwords(&self) -> Result<Vec<AppPassword>, Error>
Lists all existing app passwords.
sourcepub async fn create_app_password(
&self,
app_password: CreateAppPasswordRequest<'_>,
) -> Result<AuthAppPassword, Error>
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
impl Client
sourcepub async fn create_user(
&self,
new_user: CreateUserRequest,
) -> Result<CreatedUser, Error>
pub async fn create_user( &self, new_user: CreateUserRequest, ) -> Result<CreatedUser, Error>
Creates a new user in the authenticated organization.
sourcepub async fn remove_user(
&self,
remove_user: RemoveUserRequest,
) -> Result<(), Error>
pub async fn remove_user( &self, remove_user: RemoveUserRequest, ) -> Result<(), Error>
Removes a user from the authenticated organization.
source§impl Client
impl Client
sourcepub fn new(config: ClientConfig) -> Client
pub fn new(config: ClientConfig) -> Client
Creates a new Client
from its required configuration parameters.
sourcepub fn builder() -> ClientBuilder
pub fn builder() -> ClientBuilder
Creates a builder for a Client
that allows for customization of
optional parameters.
sourcefn build_request<P>(&self, method: Method, path: P) -> RequestBuilder
fn build_request<P>(&self, method: Method, path: P) -> RequestBuilder
Builds a request towards the Client
’s endpoint
sourceasync fn send_request<T>(&self, req: RequestBuilder) -> Result<T, Error>where
T: DeserializeOwned,
async fn send_request<T>(&self, req: RequestBuilder) -> Result<T, Error>where
T: DeserializeOwned,
Sends a requests and adds the authorization bearer token.
async fn send_unauthenticated_request<T>(
&self,
req: RequestBuilder,
) -> Result<T, Error>where
T: DeserializeOwned,
sourcepub async fn auth(&self) -> Result<String, Error>
pub async fn auth(&self) -> Result<String, Error>
Authenticates with the server, if not already authenticated, and returns the authentication token.
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> FutureExt for T
impl<T> FutureExt for T
source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T
in a tonic::Request
source§impl<T, U> OverrideFrom<Option<&T>> for Uwhere
U: OverrideFrom<T>,
impl<T, U> OverrideFrom<Option<&T>> for Uwhere
U: OverrideFrom<T>,
source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
source§fn into_rust(self) -> Result<R, TryFromProtoError>
fn into_rust(self) -> Result<R, TryFromProtoError>
See
RustType::from_proto
.source§fn from_rust(rust: &R) -> P
fn from_rust(rust: &R) -> P
See
RustType::into_proto
.source§impl<'a, S, T> Semigroup<&'a S> for Twhere
T: Semigroup<S>,
impl<'a, S, T> Semigroup<&'a S> for Twhere
T: Semigroup<S>,
source§fn plus_equals(&mut self, rhs: &&'a S)
fn plus_equals(&mut self, rhs: &&'a S)
The method of
std::ops::AddAssign
, for types that do not implement AddAssign
.