Struct oxide_api::silos::Silos

source · [−]

pub struct Silos {
    pub client: Client,
}

Fields

client: Client

Implementations

source

impl Silos

source

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.

source

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.

source

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

Create a new silo.

This function performs a POST to the /silos endpoint.

source

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

source

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

source

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.

source

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.

source

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

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

source

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

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

source

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

source

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

source

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

List 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 retrieve the subsequent page.
sort_by: crate::types::IdSortMode – Supported set of sort modes for scanning by id only.

Currently, we only support scanning in ascending order.

source

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

List users.

This function performs a GET to the /users endpoint.

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

Auto Trait Implementations

impl !RefUnwindSafe for Silos

impl Send for Silos

impl Sync for Silos

impl Unpin for Silos

impl !UnwindSafe for Silos

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> IntoResult<T> for T

type Err = Infallible

source

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct oxide_api::silos::Silos

Fields

Implementations

impl Silos

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

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

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

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

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

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

pub async fn get_all_identity_providers( &self, silo_name: &str, sort_by: NameSortMode) -> Result<Vec<IdentityProvider>>

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

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

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

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

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

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

Auto Trait Implementations

impl !RefUnwindSafe for Silos

impl Send for Silos

impl Sync for Silos

impl Unpin for Silos

impl !UnwindSafe for Silos

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> IntoResult<T> for T

type Err = Infallible

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

pub async fn get_all_identity_providers(
&self,
silo_name: &str,
sort_by: NameSortMode
) -> Result<Vec<IdentityProvider>>

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,