Struct oxide_api::users::Users

pub struct Users {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Users

pub async fn get_page(
    &self,
    limit: u32,
    page_token: &str,
    sort_by: NameSortMode
) -> Result<Vec<User>>

List the built-in system users.

This function performs a GET to the /users endpoint.

Parameters:

• limit: u32 – Maximum number of items returned by a single call.
• page_token: &str – Token returned by previous call to retreive the subsequent page.
• sort_by: crate::types::NameSortMode – Supported set of sort modes for scanning by name only

Currently, we only support scanning in ascending order.

pub async fn get_all(&self, sort_by: NameSortMode) -> Result<Vec<User>>

List the built-in system users.

This function performs a GET to the /users endpoint.

As opposed to get, this function returns all the pages of the request at once.

pub async fn get(&self, user_name: &str) -> Result<User>

Fetch a specific built-in system user.

This function performs a GET to the /users/{user_name} endpoint.

Parameters:

• user_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’.