Struct frontegg::Client

pub struct Client { /* private fields */ }

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.

Implementations

impl Client

pub async fn list_tenants(&self) -> Result<Vec<Tenant>, Error>

Lists all tenants in the workspace.

The returned vector is sorted by tenant ID.

pub async fn create_tenant( &self, tenant: &TenantRequest<'_> ) -> Result<Tenant, Error>

Creates a new tenant.

pub async fn delete_tenant(&self, id: Uuid) -> Result<(), Error>

Deletes a tenant by ID.

impl Client

pub fn list_users( &self, config: UserListConfig ) -> impl Stream<Item = Result<User, Error>> + '_

Lists users, either for all tenants or for a single tenant.

The underlying API call is paginated. The returned stream will fetch additional pages as it is consumed.

pub async fn create_user( &self, user: &UserRequest<'_> ) -> Result<CreatedUser, Error>

Creates a new user.

Only partial information about the created user is returned. To fetch the full information about the user, call Client::get_user.

pub async fn get_user(&self, id: Uuid) -> Result<User, Error>

Gets a user by ID.

pub async fn delete_user(&self, id: Uuid) -> Result<(), Error>

Deletes a user by ID.

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.

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.