Struct Api

pub struct Api {
    base_url: Url,
    auth_data: Arc<Mutex<Option<AuthData>>>,
    token_url: Url,
    client_id: String,
    client_secret: Secret<String>,
}

The keycloak admin API.

Fields

base_url: Url

Base url for the Keycloak admin REST API.

auth_data: Arc<Mutex<Option<AuthData>>>

Cached access token (needs to be thread safe). Might be expired, in which case it will be refreshed.

token_url: Url

Url for requesting the access token from the auth server.

client_id: String

The client id for the oauth2 client.

client_secret: Secret<String>

The client secret for the oauth2 client.

Implementations

impl Api

pub fn new(config: Config) -> Self

Creates a new Keycloak API.

Panics

If the config does not contain a valid keycloak auth URI.

async fn get<T: DeserializeOwned>(&self, client: &Client, url: Url) -> Result<T>

Executes a get request authenticated with the access token.

async fn get_or_refresh_access_token( &self, client: &Client, ) -> Result<Secret<String>>

Gets the access token or refreshes it if it is expired.

async fn refresh_access_token(&self, client: &Client) -> Result<AuthData>

Refresh the access token.

fn make_url(&self, path: &str) -> Url

Creates a URL from the base URL and the given path.

Trait Implementations

impl Clone for Api

fn clone(&self) -> Api

Returns a copy of the value.

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

Performs copy-assignment from source.

impl KeycloakApi for Api

fn search_users_by_username<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, search_params: &'life1 UserSearchParameters, pagination: &'life2 PageParameters, client: &'life3 Client, ) -> Pin<Box<dyn Future<Output = Result<Vec<UserDto>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Search for users by their username.

fn get_users_by_ids<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 Client, user_ids: Vec<Uuid>, ) -> Pin<Box<dyn Future<Output = Result<Vec<UserDto>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Gets all users given their ids from the Keycloak API.

fn get_user_by_id<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 Client, user_id: Uuid, ) -> Pin<Box<dyn Future<Output = Result<UserDto>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Gets a user by its id from the Keycloak API.