Struct oxide_api::silos::Silos

pub struct Silos {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Silos

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

This function performs a GET to the /silos endpoint.

Parameters:

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

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

This function performs a GET to the /silos endpoint.

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

pub async fn post(&self, body: &SiloCreate) -> Result<Silo>

Create a new silo.

This function performs a POST to the /silos endpoint.

pub async fn get(&self, silo_name: &str) -> Result<Silo>

Fetch a specific silo.

This function performs a GET to the /silos/{silo_name} endpoint.

Parameters:

• silo_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 ‘-’.

pub async fn delete(&self, silo_name: &str) -> Result<()>

Delete a specific silo.

This function performs a DELETE to the /silos/{silo_name} endpoint.

Parameters:

• silo_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 ‘-’.

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

List Silo identity providers.

This function performs a GET to the /silos/{silo_name}/identity_providers endpoint.

Parameters:

• silo_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 ‘-’.
• limit: u32 – Maximum number of items returned by a single call.
• page_token: &str – Token returned by previous call to retrieve 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_identity_providers(
    &self,
    silo_name: &str,
    sort_by: NameSortMode
) -> Result<Vec<IdentityProvider>>

List Silo identity providers.

This function performs a GET to the /silos/{silo_name}/identity_providers endpoint.

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

pub async fn get_policy(&self, silo_name: &str) -> Result<SiloRolesPolicy>

Fetch the IAM policy for this Silo.

This function performs a GET to the /silos/{silo_name}/policy endpoint.

Parameters:

• silo_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 ‘-’.

pub async fn put_policy(
    &self,
    silo_name: &str,
    body: &SiloRolesPolicy
) -> Result<SiloRolesPolicy>

Update the IAM policy for this Silo.

This function performs a PUT to the /silos/{silo_name}/policy endpoint.

Parameters:

• silo_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 ‘-’.

pub async fn saml_idp_create(
    &self,
    silo_name: &str,
    body: &SamlIdentityProviderCreate
) -> Result<SamlIdentityProvider>

Create a new SAML identity provider for a silo.

This function performs a POST to the /silos/{silo_name}/saml_identity_providers endpoint.

Parameters:

• silo_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 ‘-’.

pub async fn saml_idp_fetch(
    &self,
    provider_name: &str,
    silo_name: &str
) -> Result<SamlIdentityProvider>

GET a silo’s SAML identity provider.

This function performs a GET to the /silos/{silo_name}/saml_identity_providers/{provider_name} endpoint.

Parameters:

• provider_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 ‘-’.
• silo_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 ‘-’.