Struct okta::Okta

pub struct Okta { /* fields omitted */ }

Entrypoint for interacting with the Okta API.

Implementations

impl Okta

pub fn new<K, D>(key: K, domain: D) -> Self where
    K: ToString,
    D: ToString, 

Create a new Okta client struct. It takes a type that can convert into an &str (String or Vec<u8> for example). As long as the function is given a valid API Key your requests will work.

pub fn new_from_env() -> Self

Create a new Okta client struct from environment variables. It takes a type that can convert into an &str (String or Vec<u8> for example). As long as the function is given a valid API your requests will work.

pub fn get_key(&self) -> &str

Get the currently set API key.

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

List users.

pub async fn create_user(&self, profile: Profile) -> Result<User, APIError>

Create a user.

pub async fn get_user(&self, email: &str) -> Result<User, APIError>

Get a user by their email.

pub async fn update_user(&self, profile: Profile) -> Result<User, APIError>

Update a user.

pub async fn list_groups(&self, query: &str) -> Result<Vec<Group>, APIError>

List groups.

pub async fn create_group(
    &self,
    profile: GroupProfile
) -> Result<Group, APIError>

Create a group.

pub async fn get_group(&self, name: &str) -> Result<Group, APIError>

Get a group by its name.

pub async fn update_group(
    &self,
    profile: GroupProfile
) -> Result<Group, APIError>

Update a group.

pub async fn add_user_to_group(
    &self,
    group_id: &str,
    user: &str
) -> Result<(), APIError>

Add user to a group.

pub async fn delete_user_from_group(
    &self,
    group_id: &str,
    user: &str
) -> Result<(), APIError>

Delete a user from a group.