pub struct Organizations {
pub client: Client,
}Fields§
§client: ClientImplementations§
Source§impl Organizations
impl Organizations
Sourcepub async fn view(&self, id: &str) -> Result<Organization>
pub async fn view(&self, id: &str) -> Result<Organization>
Fetch an organization by id.
This function performs a GET to the /by-id/organizations/{id} endpoint.
Parameters:
id: &str
Sourcepub async fn get_page(
&self,
limit: u32,
page_token: &str,
sort_by: NameOrIdSortMode,
) -> Result<Vec<Organization>>
pub async fn get_page( &self, limit: u32, page_token: &str, sort_by: NameOrIdSortMode, ) -> Result<Vec<Organization>>
List organizations.
This function performs a GET to the /organizations 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.
Sourcepub async fn get_all(
&self,
sort_by: NameOrIdSortMode,
) -> Result<Vec<Organization>>
pub async fn get_all( &self, sort_by: NameOrIdSortMode, ) -> Result<Vec<Organization>>
List organizations.
This function performs a GET to the /organizations endpoint.
As opposed to get, this function returns all the pages of the request at once.
Sourcepub async fn post(&self, body: &OrganizationCreate) -> Result<Organization>
pub async fn post(&self, body: &OrganizationCreate) -> Result<Organization>
Create an organization.
This function performs a POST to the /organizations endpoint.
Sourcepub async fn get(&self, organization_name: &str) -> Result<Organization>
pub async fn get(&self, organization_name: &str) -> Result<Organization>
Fetch an organization.
This function performs a GET to the /organizations/{organization_name} endpoint.
Parameters:
organization_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(
&self,
organization_name: &str,
body: &OrganizationUpdate,
) -> Result<Organization>
pub async fn put( &self, organization_name: &str, body: &OrganizationUpdate, ) -> Result<Organization>
Update an organization.
This function performs a PUT to the /organizations/{organization_name} endpoint.
Parameters:
organization_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, organization_name: &str) -> Result<()>
pub async fn delete(&self, organization_name: &str) -> Result<()>
Delete an organization.
This function performs a DELETE to the /organizations/{organization_name} endpoint.
Parameters:
organization_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_policy(
&self,
organization_name: &str,
) -> Result<OrganizationRolePolicy>
pub async fn get_policy( &self, organization_name: &str, ) -> Result<OrganizationRolePolicy>
Fetch an organization’s IAM policy.
This function performs a GET to the /organizations/{organization_name}/policy endpoint.
Parameters:
organization_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,
organization_name: &str,
body: &OrganizationRolePolicy,
) -> Result<OrganizationRolePolicy>
pub async fn put_policy( &self, organization_name: &str, body: &OrganizationRolePolicy, ) -> Result<OrganizationRolePolicy>
Update an organization’s IAM policy.
This function performs a PUT to the /organizations/{organization_name}/policy endpoint.
Parameters:
organization_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.