Struct Client

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

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

impl Client

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

Lists all existing app passwords.

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

Creates a new app password with the provided description.

impl Client

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

Lists all available roles.

impl Client

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

Lists all existing users.

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

Creates a new user in the authenticated organization.

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

Removes a user from the authenticated organization.

impl Client

pub fn new(config: ClientConfig) -> Client

Creates a new Client from its required configuration parameters.

pub fn builder() -> ClientBuilder

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

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

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,

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

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

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

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

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.