Struct GroupsClient

pub struct GroupsClient { /* private fields */ }

GroupsClient is a client for the groups service.

Implementations

impl GroupsClient

pub fn new(auth_context: AuthContext, region: CoralogixRegion) -> Result<Self>

Creates a new GroupsClient.

Arguments

• api_key' - The [AuthContext`] to use for authentication.
• region - The CoralogixRegion to connect to.

pub async fn create( &self, name: String, team_id: TeamId, description: String, external_id: Option<String>, role_ids: Vec<RoleId>, user_ids: Vec<UserId>, scope_filters: Option<ScopeFilters>, next_gen_scope_id: Option<String>, ) -> Result<CreateTeamGroupResponse>

Creates a new group.

Arguments

• name - The name of the group.
• team_id - The TeamId of the team the group belongs to.
• description - The description of the group.
• external_id - The external ID of the group.
• role_ids - The RoleIds of the roles in the group.
• user_ids - The UserIds of the users in the group.
• scope_filters - The ScopeFilters of the group.
• next_gen_scope_id - The next-gen scope ID of the group.

pub async fn get(&self, group_id: TeamGroupId) -> Result<GetTeamGroupResponse>

Fetches the groups for an organization.

Arguments

• group_id - The TeamGroupId of the group to fetch.

pub async fn list(&self, team_id: TeamId) -> Result<GetTeamGroupsResponse>

Fetches all groups for a team.

Arguments

• team_id - The TeamId of the team to fetch groups for.

pub async fn add_users( &self, group_id: TeamGroupId, user_ids: Vec<UserId>, ) -> Result<()>

Adds users to a group.

Arguments

• group_id - The TeamGroupId of the group to add roles to.
• user_ids - The UserIds of the users to add to the group.

pub async fn update( &self, group_id: TeamGroupId, name: String, description: String, external_id: Option<String>, role_updates: Option<RoleUpdates>, user_updates: Option<UserUpdates>, scope_filters: Option<ScopeFilters>, next_gen_scope_id: Option<String>, ) -> Result<UpdateTeamGroupResponse>

Updates a group.

• group_id - The TeamGroupId of the group to update.
• name - The name of the group.
• team_id - The TeamId of the team the group belongs to.
• description - The description of the group.
• external_id - The external ID of the group.
• role_updates - The RoleUpdates to apply to the group.
• user_updates - The UserUpdates to apply to the group.
• scope_filters - The ScopeFilters of the group.
• next_gen_scope_id - The next-gen scope ID of the group.

pub async fn remove_users( &self, group_id: TeamGroupId, user_ids: Vec<UserId>, ) -> Result<()>

Removes users from a group.

Arguments

• group_id - The TeamGroupId of the group to remove roles from.
• user_ids - The UserIds of the users to remove from the group.

pub async fn delete(&self, group_id: TeamGroupId) -> Result<()>

Deletes a group.

Arguments

• group_id - The TeamGroupId of the group to delete.