Struct oxide_api::roles::Roles

pub struct Roles {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Roles

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

List the built-in roles.

This function performs a GET to the /roles endpoint.

Parameters:

• limit: u32 – A count of bytes, typically used either for memory or storage capacity

The maximum supported byte count is i64::MAX. This makes it somewhat inconvenient to define constructors: a u32 constructor can be infallible, but an i64 constructor can fail (if the value is negative) and a u64 constructor can fail (if the value is larger than i64::MAX). We provide all of these for consumers’ convenience.

• page_token: &str – Token returned by previous call to retreive the subsequent page.

pub async fn get_all(&self) -> Result<Vec<Role>>

List the built-in roles.

This function performs a GET to the /roles endpoint.

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

pub async fn get(&self, role_name: &str) -> Result<Role>

Fetch a specific built-in role.

This function performs a GET to the /roles/{role_name} endpoint.

Parameters:

• role_name: &str – human-readable free-form text about a resource.