pub struct Silos {
pub client: Client,
}Fields
client: ClientImplementations
sourceimpl Silos
impl Silos
sourcepub async fn policy_get(&self) -> Result<SiloRolePolicy>
pub async fn policy_get(&self) -> Result<SiloRolePolicy>
Fetch the current silo’s IAM policy.
This function performs a GET to the /policy endpoint.
sourcepub async fn policy_put(&self, body: &SiloRolePolicy) -> Result<SiloRolePolicy>
pub async fn policy_put(&self, body: &SiloRolePolicy) -> Result<SiloRolePolicy>
Update the current silo’s IAM policy.
This function performs a PUT to the /policy endpoint.
sourcepub async fn get_page(
&self,
limit: u32,
page_token: &str,
sort_by: NameOrIdSortMode
) -> Result<Vec<Silo>>
pub async fn get_page(
&self,
limit: u32,
page_token: &str,
sort_by: NameOrIdSortMode
) -> Result<Vec<Silo>>
List silos.
This function performs a GET to the /silos endpoint.
Lists silos that are discoverable based on the current permissions.
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.
sourcepub async fn get_all(&self, sort_by: NameOrIdSortMode) -> Result<Vec<Silo>>
pub async fn get_all(&self, sort_by: NameOrIdSortMode) -> Result<Vec<Silo>>
List silos.
This function performs a GET to the /silos endpoint.
As opposed to get, this function returns all the pages of the request at once.
Lists silos that are discoverable based on the current permissions.
sourcepub async fn post(&self, body: &SiloCreate) -> Result<Silo>
pub async fn post(&self, body: &SiloCreate) -> Result<Silo>
Create a silo.
This function performs a POST to the /silos endpoint.
sourcepub async fn get(&self, silo_name: &str) -> Result<Silo>
pub async fn get(&self, silo_name: &str) -> Result<Silo>
Fetch a silo.
This function performs a GET to the /silos/{silo_name} endpoint.
Fetch a silo by name.
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 ‘-’. Names cannot be a UUID though they may contain a UUID.
sourcepub async fn delete(&self, silo_name: &str) -> Result<()>
pub async fn delete(&self, silo_name: &str) -> Result<()>
Delete a silo.
This function performs a DELETE to the /silos/{silo_name} endpoint.
Delete a silo by name.
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 ‘-’. Names cannot be a UUID though they may contain a UUID.
sourcepub async fn get_identity_providers(
&self,
limit: u32,
page_token: &str,
silo_name: &str,
sort_by: NameSortMode
) -> Result<Vec<IdentityProvider>>
pub async fn get_identity_providers(
&self,
limit: u32,
page_token: &str,
silo_name: &str,
sort_by: NameSortMode
) -> Result<Vec<IdentityProvider>>
List a silo’s IDPs.
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 ‘-’. Names cannot be a UUID though they may contain a UUID.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.
sourcepub async fn get_all_identity_providers(
&self,
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>>
List a silo’s IDPs.
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.
sourcepub async fn get_policy(&self, silo_name: &str) -> Result<SiloRolePolicy>
pub async fn get_policy(&self, silo_name: &str) -> Result<SiloRolePolicy>
Fetch a silo’s IAM policy.
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 ‘-’. Names cannot be a UUID though they may contain a UUID.
sourcepub async fn put_policy(
&self,
silo_name: &str,
body: &SiloRolePolicy
) -> Result<SiloRolePolicy>
pub async fn put_policy(
&self,
silo_name: &str,
body: &SiloRolePolicy
) -> Result<SiloRolePolicy>
Update a silo’s IAM policy.
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 ‘-’. Names cannot be a UUID though they may contain a UUID.
sourcepub async fn saml_idp_fetch(
&self,
silo_name: &str,
body: &SamlIdentityProviderCreate
) -> Result<SamlIdentityProvider>
pub async fn saml_idp_fetch(
&self,
silo_name: &str,
body: &SamlIdentityProviderCreate
) -> Result<SamlIdentityProvider>
Create a SAML IDP.
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 ‘-’. Names cannot be a UUID though they may contain a UUID.
sourcepub async fn saml_idp_create(
&self,
provider_name: &str,
silo_name: &str
) -> Result<SamlIdentityProvider>
pub async fn saml_idp_create(
&self,
provider_name: &str,
silo_name: &str
) -> Result<SamlIdentityProvider>
Fetch a SAML IDP.
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 ‘-’. Names cannot be a UUID though they may contain a UUID.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 ‘-’. Names cannot be a UUID though they may contain a UUID.
sourcepub async fn users_get(
&self,
limit: u32,
page_token: &str,
sort_by: IdSortMode
) -> Result<Vec<User>>
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.
sourcepub async fn users_get_all(&self, sort_by: IdSortMode) -> Result<Vec<User>>
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
type Err = Infallible
fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more