Struct zoom_api::groups::Groups

pub struct Groups {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Groups

pub async fn get(&self) -> Result<GroupList>

List groups.

This function performs a GET to the /groups endpoint.

List groups under an account.

Prerequisite: Pro or higher account.
Scopes: group:read:admin

Rate Limit Label: Medium

pub async fn create(&self, body: &GroupCreateRequest) -> Result<()>

Create a group.

This function performs a POST to the /groups endpoint.

Create a group under an account.

You can add a maximum of 100 groups in one account per day. If you go over, you will get an error. You can add a maximum of 5000 groups in one account.

Prerequisite: Pro or higher account.
Scopes: group:write:admin

Rate Limit Label: Light

pub async fn group(&self, group_id: &str) -> Result<GroupResponse>

Get a group.

This function performs a GET to the /groups/{groupId} endpoint.

Get a group under an account.

Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin

Rate Limit Label: Light

Parameters:

• group_id: &str – The group ID.
  Can be retrieved by calling GET /groups.

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

Delete a group.

This function performs a DELETE to the /groups/{groupId} endpoint.

Delete a group.

Prerequisite: Pro, Business, or Education account
Scopes: group:write:admin

Rate Limit Label: Light

Parameters:

• group_id: &str – The group ID.
  Can be retrieved by calling GET /groups.

pub async fn update(
    &self,
    group_id: &str,
    body: &GroupCreateRequest
) -> Result<()>

Update a group.

This function performs a PATCH to the /groups/{groupId} endpoint.

Update a group under your account.

Prerequisite: Pro, Business, or Education account
Scopes: group:write:admin

Rate Limit Label: Light

Parameters:

• group_id: &str – The group ID.
  Can be retrieved by calling GET /groups.

pub async fn members(
    &self,
    group_id: &str,
    page_size: i64,
    page_number: i64,
    next_page_token: &str
) -> Result<Vec<UserCreateResponse>>

List group members .

This function performs a GET to the /groups/{groupId}/members endpoint.

List the members of a group under your account.

Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin

Rate Limit Label: Medium

Parameters:

• group_id: &str – The group ID.
  Can be retrieved by calling GET /groups.

• page_size: i64 – The number of records returned within a single API call.

• page_number: i64 – Deprecated - This field has been deprecated and we will stop supporting it completely in a future release. Please use “next_page_token” for pagination instead of this field.

  The page number of the current page in the returned records.

• next_page_token: &str – The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

pub async fn get_all_members(
    &self,
    group_id: &str
) -> Result<Vec<UserCreateResponse>>

List group members .

This function performs a GET to the /groups/{groupId}/members endpoint.

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

List the members of a group under your account.

Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin

Rate Limit Label: Medium

pub async fn members_create(
    &self,
    group_id: &str,
    body: &AddRoleMembersRequest
) -> Result<()>

Add group members.

This function performs a POST to the /groups/{groupId}/members endpoint.

Add members to a group under your account.

Prerequisite: Pro, Business, or Education account
Scopes: group:write:admin

Rate Limit Label: Medium

Parameters:

• group_id: &str – The group ID.
  Can be retrieved by calling GET /groups.

pub async fn members_delete(&self, group_id: &str, member_id: &str) -> Result<()>

Delete a group member.

This function performs a DELETE to the /groups/{groupId}/members/{memberId} endpoint.

Delete a member from a group in a Zoom account.

Prerequisite: Pro, Business, or Education account
Scopes: group:write:admin

Rate Limit Label: Light

Parameters:

• group_id: &str – The group ID.
  Can be retrieved by calling GET /groups.
• member_id: &str – User’s first name.

pub async fn update_member(
    &self,
    group_id: &str,
    member_id: &str,
    body: &UpdateGroupMemberRequest
) -> Result<()>

Update a group member.

This function performs a PATCH to the /groups/{groupId}/members/{memberId} endpoint.

Use this API to perform either of the following tasks:

• Remove a group member from one group and move them to a different group.
• Set a user’s primary group. By default, the primary group is the first group that user is added to.

If a user is a member of multiple groups, you can assign the user a primary group. The user will use the primary group’s settings by default. However, if the user is a member of a group with locked settings, those group settings will remain locked to the user.

Scopes: group:write:admin
Rate Limit Label: Medium

Prerequisites:

• A Pro or higher account

Parameters:

• group_id: &str – The group’s unique ID. To get this value, use the List Groups API.
  • To set a user’s primary group, use the target_group_id value for this parameter’s value.
  • To move a group member from one group to another, use the groupId of the designated group.
• member_id: &str – The group member’s unique ID. To get this value, use the List Group Members API.

pub async fn get_settings_domains(
    &self,
    group_id: &str,
    custom_query_fields: &str,
    option: OptionData
) -> Result<Domains>

Get a group’s settings.

This function performs a GET to the /groups/{groupId}/settings endpoint.

Get settings for a group. Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin

Rate Limit Label: Medium

Parameters:

• option: crate::types::OptionData – Use the following options to filter the results of the account’s information: * meeting_authentication — View the account’s meeting authentication settings. * recording_authentication — View the account’s recording authentication settings. * security — View the account’s security settings. For example, password requirements for user login or two-factor authentication.
  * meeting_security — View the account’s meeting security settings.

pub async fn get_settings_meeting_security(
    &self,
    group_id: &str,
    custom_query_fields: &str,
    option: OptionData
) -> Result<MeetingSecuritySettings>

Get a group’s settings.

This function performs a GET to the /groups/{groupId}/settings endpoint.

Get settings for a group. Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin

Rate Limit Label: Medium

Parameters:

• option: crate::types::OptionData – Use the following options to filter the results of the account’s information: * meeting_authentication — View the account’s meeting authentication settings. * recording_authentication — View the account’s recording authentication settings. * security — View the account’s security settings. For example, password requirements for user login or two-factor authentication.
  * meeting_security — View the account’s meeting security settings.

pub async fn get_settings_group_response(
    &self,
    group_id: &str,
    custom_query_fields: &str,
    option: OptionData
) -> Result<GetGroupSettingsResponse>

Get a group’s settings.

This function performs a GET to the /groups/{groupId}/settings endpoint.

Get settings for a group. Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin

Rate Limit Label: Medium

Parameters:

• option: crate::types::OptionData – Use the following options to filter the results of the account’s information: * meeting_authentication — View the account’s meeting authentication settings. * recording_authentication — View the account’s recording authentication settings. * security — View the account’s security settings. For example, password requirements for user login or two-factor authentication.
  * meeting_security — View the account’s meeting security settings.

pub async fn get_setting(
    &self,
    group_id: &str,
    custom_query_fields: &str,
    option: OptionData
) -> Result<GetGroupSettingsResponseOneOf>

Get a group’s settings.

This function performs a GET to the /groups/{groupId}/settings endpoint.

Get settings for a group. Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin

Rate Limit Label: Medium

Parameters:

• option: crate::types::OptionData – Use the following options to filter the results of the account’s information: * meeting_authentication — View the account’s meeting authentication settings. * recording_authentication — View the account’s recording authentication settings. * security — View the account’s security settings. For example, password requirements for user login or two-factor authentication.
  * meeting_security — View the account’s meeting security settings.

pub async fn update_settings(
    &self,
    group_id: &str,
    custom_query_fields: &str,
    option: UpdateGroupSettingsOption,
    body: &UpdateGroupSettingsRequestOneOf
) -> Result<()>

Update a group’s settings.

This function performs a PATCH to the /groups/{groupId}/settings endpoint.

Update settings for a group.

Note: The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

Prerequisite: Pro, Business, or Education account
Scopes: group:write:admin

Rate Limit Label: Medium

Parameters:

• group_id: &str – User’s first name.
• option: crate::types::UpdateGroupSettingsOption

pub async fn get_lock_settings_meeting_security(
    &self,
    group_id: &str,
    custom_query_fields: &str,
    option: &str
) -> Result<MeetingSecuritySettings>

Get locked settings.

This function performs a GET to the /groups/{groupId}/lock_settings endpoint.

Retrieve a group’s locked settings. If you lock a setting, the group members will not be able to modify it individually.

Note: The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin

Rate Limit Label: Medium

Parameters:

• group_id: &str – User’s first name.
• option: &str – Specify meeting_security as the value of this field if you would like to view security settings applied on a meeting hosted by the users in this group.

pub async fn get_lock_settings_group_response(
    &self,
    group_id: &str,
    custom_query_fields: &str,
    option: &str
) -> Result<GetGroupLockSettingsResponse>

Get locked settings.

This function performs a GET to the /groups/{groupId}/lock_settings endpoint.

Retrieve a group’s locked settings. If you lock a setting, the group members will not be able to modify it individually.

Note: The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin

Rate Limit Label: Medium

Parameters:

• group_id: &str – User’s first name.
• option: &str – Specify meeting_security as the value of this field if you would like to view security settings applied on a meeting hosted by the users in this group.

pub async fn get_lock_setting(
    &self,
    group_id: &str,
    custom_query_fields: &str,
    option: &str
) -> Result<GetGroupLockSettingsResponseOneOf>

Get locked settings.

This function performs a GET to the /groups/{groupId}/lock_settings endpoint.

Retrieve a group’s locked settings. If you lock a setting, the group members will not be able to modify it individually.

Note: The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin

Rate Limit Label: Medium

Parameters:

• group_id: &str – User’s first name.
• option: &str – Specify meeting_security as the value of this field if you would like to view security settings applied on a meeting hosted by the users in this group.

pub async fn locked_settings(
    &self,
    group_id: &str,
    custom_query_fields: &str,
    option: &str,
    body: &GroupLockedSettingsRequestOneOf
) -> Result<()>

Update locked settings.

This function performs a PATCH to the /groups/{groupId}/lock_settings endpoint.

Update a group’s locked settings. If you lock a setting, the group members will not be able to modify it individually.

Note: The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.

Prerequisite: Pro, Business, or Education account
Scopes: group:write:admin

Rate Limit Label: Medium

Parameters:

• group_id: &str – User’s first name.
• option: &str – Specify meeting_security as the value of this field if you would like to view security settings applied on a meeting hosted by the users in this group.

pub async fn upload_vb(
    &self,
    file_ids: &str,
    group_id: &str,
    body: &UploadVbRequest
) -> Result<Files>

Upload virtual background files.

This function performs a POST to the /groups/{groupId}/settings/virtual_backgrounds endpoint.

Use this API to upload virtual background files for all users in a group to use.

Prerequisites:

• Virtual background feature must be enabled on the account.
  Scope: group:write:admin
  
  Rate Limit Label: Medium
  

`

Parameters:

• group_id: &str – Unique identifier of the group. Retrieve the value for this field by calling the List groups API.

pub async fn del_vb(&self, file_ids: &str, group_id: &str) -> Result<()>

Delete virtual background files.

This function performs a DELETE to the /groups/{groupId}/settings/virtual_backgrounds endpoint.

Delete existing virtual background file(s) from an account.

Prerequisites:

• Virtual background feature must be enabled on the account.
  Scope: group:write:admin
  
  Rate Limit Label: Light
  

Parameters:

• group_id: &str – Unique identifier of the group. Retrieve the value for this field by calling the List groups API.
• file_ids: &str – Provide the id of the file that is to be deleted. To delete multiple files, provide comma separated values for this field.