Struct gsuite_api::members::Members
source · pub struct Members {
pub client: Client,
}Fields
client: ClientImplementations
sourceimpl Members
impl Members
sourcepub async fn has(
&self,
group_key: &str,
member_key: &str
) -> Result<MembersHasMember>
pub async fn has(
&self,
group_key: &str,
member_key: &str
) -> Result<MembersHasMember>
This function performs a GET to the /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey} endpoint.
Checks whether the given user is a member of the group. Membership can be direct or nested.
Parameters:
group_key: &str– Identifies the group in the API request. The value can be the group’s email address, group alias, or the unique group ID.member_key: &str– Identifies the user member in the API request. The value can be the user’s primary email address, alias, or unique ID.
sourcepub async fn list(
&self,
group_key: &str,
include_derived_membership: bool,
max_results: i64,
page_token: &str,
roles: &str
) -> Result<Vec<Member>>
pub async fn list(
&self,
group_key: &str,
include_derived_membership: bool,
max_results: i64,
page_token: &str,
roles: &str
) -> Result<Vec<Member>>
This function performs a GET to the /admin/directory/v1/groups/{groupKey}/members endpoint.
Retrieves a paginated list of all members in a group.
Parameters:
group_key: &str– Identifies the group in the API request. The value can be the group’s email address, group alias, or the unique group ID.include_derived_membership: bool– A Boolean value to indicate whether payload is wanted. Optional.max_results: i64– Maximum number of results to return. Max allowed value is 200.page_token: &str– Token to specify next page in the list.roles: &str– Therolesquery parameter allows you to retrieve group members by role. Allowed values areOWNER,MANAGER, andMEMBER.
sourcepub async fn list_all(
&self,
group_key: &str,
include_derived_membership: bool,
roles: &str
) -> Result<Vec<Member>>
pub async fn list_all(
&self,
group_key: &str,
include_derived_membership: bool,
roles: &str
) -> Result<Vec<Member>>
This function performs a GET to the /admin/directory/v1/groups/{groupKey}/members endpoint.
As opposed to list, this function returns all the pages of the request at once.
Retrieves a paginated list of all members in a group.
sourcepub async fn insert(&self, group_key: &str, body: &Member) -> Result<Member>
pub async fn insert(&self, group_key: &str, body: &Member) -> Result<Member>
This function performs a POST to the /admin/directory/v1/groups/{groupKey}/members endpoint.
Adds a user to the specified group.
Parameters:
group_key: &str– Identifies the group in the API request. The value can be the group’s email address, group alias, or the unique group ID.
sourcepub async fn get(&self, group_key: &str, member_key: &str) -> Result<Member>
pub async fn get(&self, group_key: &str, member_key: &str) -> Result<Member>
This function performs a GET to the /admin/directory/v1/groups/{groupKey}/members/{memberKey} endpoint.
Retrieves a group member’s properties.
Parameters:
group_key: &str– Identifies the group in the API request. The value can be the group’s email address, group alias, or the unique group ID.member_key: &str– Identifies the group member in the API request. A group member can be a user or another group. The value can be the member’s (group or user) primary email address, alias, or unique ID.
sourcepub async fn update(
&self,
group_key: &str,
member_key: &str,
body: &Member
) -> Result<Member>
pub async fn update(
&self,
group_key: &str,
member_key: &str,
body: &Member
) -> Result<Member>
This function performs a PUT to the /admin/directory/v1/groups/{groupKey}/members/{memberKey} endpoint.
Updates the membership of a user in the specified group.
Parameters:
group_key: &str– Identifies the group in the API request. The value can be the group’s email address, group alias, or the unique group ID.member_key: &str– Identifies the group member in the API request. A group member can be a user or another group. The value can be the member’s (group or user) primary email address, alias, or unique ID.
sourcepub async fn delete(&self, group_key: &str, member_key: &str) -> Result<()>
pub async fn delete(&self, group_key: &str, member_key: &str) -> Result<()>
This function performs a DELETE to the /admin/directory/v1/groups/{groupKey}/members/{memberKey} endpoint.
Removes a member from a group.
Parameters:
group_key: &str– Identifies the group in the API request. The value can be the group’s email address, group alias, or the unique group ID.member_key: &str– Identifies the group member in the API request. A group member can be a user or another group. The value can be the member’s (group or user) primary email address, alias, or unique ID.
sourcepub async fn patch(
&self,
group_key: &str,
member_key: &str,
body: &Member
) -> Result<Member>
pub async fn patch(
&self,
group_key: &str,
member_key: &str,
body: &Member
) -> Result<Member>
This function performs a PATCH to the /admin/directory/v1/groups/{groupKey}/members/{memberKey} endpoint.
Updates the membership properties of a user in the specified group. This method supports patch semantics.
Parameters:
group_key: &str– Identifies the group in the API request. The value can be the group’s email address, group alias, or the unique group ID.member_key: &str– Identifies the group member in the API request. A group member can be a user or another group. The value can be the member’s (group or user) primary email address, alias, or unique ID.