Struct zoom_api::accounts::Accounts

pub struct Accounts {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Accounts

pub async fn get( &self, page_size: i64, page_number: i64, next_page_token: &str ) -> Result<Response<Domains>, ClientError>

List sub accounts.

This function performs a GET to the /accounts endpoint.

List all the sub accounts that have been created by a master account.

Zoom allows only approved partners to use master APIs and manage sub accounts. Email the partner programs team at partner-success@zoom.us for more details.

Prerequisites:

• Pro or a higher paid account with master account option enabled.
  

Scope: account:read:admin
Rate Limit Label: Medium

Parameters:

• 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 create( &self, body: &AccountCreateRequest ) -> Result<Response<AccountCreateResponse>, ClientError>

Create a sub account.

This function performs a POST to the /accounts endpoint.

Create a sub account under a master account. Your account must be a master account in order to create sub accounts.

Zoom allows only approved partners to use master APIs and manage sub accounts. Email the partner programs team at partner-success@zoom.us. for more details. Please note that the created account user will receive a confirmation email.


Prerequisites:

• Pro or a higher paid account with master account option enabled.
  

Scope: account:write:admin
Rate Limit Label: Light

pub async fn account( &self, account_id: &str ) -> Result<Response<AccountResponse>, ClientError>

Get sub account details.

This function performs a GET to the /accounts/{accountId} endpoint.

Get details of a sub account that is listed under a master account. Your account must be a master account in order to retrieve sub accounts’ details. Zoom allows only approved partners to use master APIs and create sub accounts. Email the partner programs team at partner-success@zoom.us for more details.

Prerequisites:

• Pro or a higher paid account with master account option enabled.
  

Scope: account:write:admin
Rate Limit Label: Light

Parameters:

• account_id: &str – User’s first name.

pub async fn disassociate( &self, account_id: &str ) -> Result<Response<()>, ClientError>

Disassociate a sub account.

This function performs a DELETE to the /accounts/{accountId} endpoint.

Disassociate a sub account from its master account. This will leave the sub account intact but it will no longer be associated with the master account.

Prerequisites:

• Pro or a higher paid account with master account option enabled.
  
• The account making this API request must be a master account.
  
  

Scope: account:write:admin
Rate Limit Label: Light

Parameters:

• account_id: &str – User’s first name.

pub async fn options_update( &self, account_id: &str, body: &Options ) -> Result<Response<()>, ClientError>

Update options.

This function performs a PATCH to the /accounts/{accountId}/options endpoint.

Update a sub account’s options under the master account.

Your account must be a master account in order to update the options for sub accounts. Zoom only assigns this privilege to trusted partners.

Prerequisites:

• Pro or a higher paid account with master account option enabled.
• The account making this API request must be a master account.
  
  

Scope: account:write:admin
Rate Limit Label: Light

Parameters:

• account_id: &str – User’s first name.

pub async fn settings_domains( &self, account_id: &str, option: OptionData, custom_query_fields: &str ) -> Result<Response<Domains>, ClientError>

Get settings.

This function performs a GET to the /accounts/{accountId}/settings endpoint.

Use this API to get an account’s settings information.

To get the settings of a master account, use me as the value for the accountId path parameter.

Scopes: account:read:admin
Rate Limit Label: Medium

Prerequisites:

• The account must be a paid account

Parameters:

• account_id: &str – User’s first name.

• 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.

• custom_query_fields: &str – The name of the field by which to filter the response. For example, if you provide the host_video value for this field, you will get a response similar to the following:

  { "schedule_meeting": { "host_video": false } }

  To use multiple values, comma-separate each value. For example: host_video,participant_video.

pub async fn settings_security( &self, account_id: &str, option: OptionData, custom_query_fields: &str ) -> Result<Response<Security>, ClientError>

Get settings.

This function performs a GET to the /accounts/{accountId}/settings endpoint.

Use this API to get an account’s settings information.

To get the settings of a master account, use me as the value for the accountId path parameter.

Scopes: account:read:admin
Rate Limit Label: Medium

Prerequisites:

• The account must be a paid account

Parameters:

• account_id: &str – User’s first name.

• 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.

• custom_query_fields: &str – The name of the field by which to filter the response. For example, if you provide the host_video value for this field, you will get a response similar to the following:

  { "schedule_meeting": { "host_video": false } }

  To use multiple values, comma-separate each value. For example: host_video,participant_video.

pub async fn settings_account( &self, account_id: &str, option: OptionData, custom_query_fields: &str ) -> Result<Response<AccountSettings>, ClientError>

Get settings.

This function performs a GET to the /accounts/{accountId}/settings endpoint.

Use this API to get an account’s settings information.

To get the settings of a master account, use me as the value for the accountId path parameter.

Scopes: account:read:admin
Rate Limit Label: Medium

Prerequisites:

• The account must be a paid account

Parameters:

• account_id: &str – User’s first name.

• 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.

• custom_query_fields: &str – The name of the field by which to filter the response. For example, if you provide the host_video value for this field, you will get a response similar to the following:

  { "schedule_meeting": { "host_video": false } }

  To use multiple values, comma-separate each value. For example: host_video,participant_video.

pub async fn settings_meeting_security( &self, account_id: &str, option: OptionData, custom_query_fields: &str ) -> Result<Response<MeetingSecuritySettings>, ClientError>

Get settings.

This function performs a GET to the /accounts/{accountId}/settings endpoint.

Use this API to get an account’s settings information.

To get the settings of a master account, use me as the value for the accountId path parameter.

Scopes: account:read:admin
Rate Limit Label: Medium

Prerequisites:

• The account must be a paid account

Parameters:

• account_id: &str – User’s first name.

• 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.

• custom_query_fields: &str – The name of the field by which to filter the response. For example, if you provide the host_video value for this field, you will get a response similar to the following:

  { "schedule_meeting": { "host_video": false } }

  To use multiple values, comma-separate each value. For example: host_video,participant_video.

pub async fn setting( &self, account_id: &str, option: OptionData, custom_query_fields: &str ) -> Result<Response<AccountSettingsResponseOneOf>, ClientError>

Get settings.

This function performs a GET to the /accounts/{accountId}/settings endpoint.

Use this API to get an account’s settings information.

To get the settings of a master account, use me as the value for the accountId path parameter.

Scopes: account:read:admin
Rate Limit Label: Medium

Prerequisites:

• The account must be a paid account

Parameters:

• account_id: &str – User’s first name.

• 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.

• custom_query_fields: &str – The name of the field by which to filter the response. For example, if you provide the host_video value for this field, you will get a response similar to the following:

  { "schedule_meeting": { "host_video": false } }

  To use multiple values, comma-separate each value. For example: host_video,participant_video.

pub async fn settings_update( &self, account_id: &str, option: AccountSettingsUpdateOption, body: &AccountSettingsUpdateRequestOneOf ) -> Result<Response<()>, ClientError>

Update settings.

This function performs a PATCH to the /accounts/{accountId}/settings endpoint.

Update the settings of a sub account that is under a master account.
To update the settings of the master account, use me as the value of the accountId path parameter.

Prerequisites:

• The sub account must be a paid account.
  Scopes: account:write:admin
  Rate Limit Label: Medium

Parameters:

• account_id: &str – User’s first name.
• option: crate::types::AccountSettingsUpdateOption

pub async fn managed_domain( &self, account_id: &str ) -> Result<Response<DomainsList>, ClientError>

Get managed domains.

This function performs a GET to the /accounts/{accountId}/managed_domains endpoint.

Get a sub account’s managed domains.

Note: This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled.

To get managed domains of the master account, provide me as the value for accountId in the path parameter. Provide the sub account’s Account ID as the value of accountId path parameter to get managed domains of the sub account.

Prerequisites:

• Pro or a higher paid account with master account option enabled.
  

Scope: account:read:admin
Rate Limit Label: Light

Parameters:

• account_id: &str – Unique Identifier of the account. To retrieve locked settings of the master account or a regular account, provide “me” as the value of this field.
  To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field.

pub async fn trusted_domain( &self, account_id: &str ) -> Result<Response<AccountTrustedDomainResponse>, ClientError>

Get trusted domains.

This function performs a GET to the /accounts/{accountId}/trusted_domains endpoint.

Get trusted domains of a sub account. To get the trusted domains of a master account, use me as the value for the accountId path parameter.

Prerequisites:

• The sub account must be a paid account.
  Scope: account:read:admin
  Rate Limit Label: Light

Parameters:

• account_id: &str – User’s first name.

pub async fn get_lock_setting( &self, account_id: &str, option: &str, custom_query_fields: &str ) -> Result<Response<Domains>, ClientError>

Get locked settings.

This function performs a GET to the /accounts/{accountId}/lock_settings endpoint.

Account Locked Settings allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to retrieve an account’s locked settings.

Note: This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled.

Prerequisites:

• Pro or a higher paid account.
  

Scope: account:read:admin.
Rate Limit Label: Medium

Scope: account:read:admin

Parameters:

• account_id: &str – Unique Identifier of the account. To retrieve locked settings of the master account or a regular account, provide “me” as the value of this field.
  To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field.
• option: &str – meeting_security: Use this query parameter to view meeting security settings applied on the account.
  .
• custom_query_fields: &str – Provide the name of the field by which you would like to filter the response. For example, if you provide “host_video” as the value of this field, you will get a response similar to the following:
  { “schedule_meeting”: { “host_video”: false } }
  You can provide multiple values by separating them with commas(example: “host_video,participant_video”).

pub async fn update_lock_settings( &self, account_id: &str ) -> Result<Response<()>, ClientError>

Update locked settings.

This function performs a PATCH to the /accounts/{accountId}/lock_settings endpoint.

Account Locked Settings allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to update an account’s locked settings.

Note: This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled.

Prerequisites:

• Pro or a higher paid account.
  

Scope: account:write:admin
Rate Limit Label: Medium

Parameters:

• account_id: &str – Unique Identifier of the account. To retrieve locked settings of the master account or a regular account, provide “me” as the value of this field.
  To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field.

pub async fn update_owner( &self, account_id: &str, body: &Members ) -> Result<Response<()>, ClientError>

Update the account owner.

This function performs a PUT to the /accounts/{accountId}/owner endpoint.

Use this API to change an account’s owner.

An account’s current owner can change the account’s owner to another user on the same account.

Scopes: account:write:admin or account:master
Rate Limit Label: Heavy

Prerequisites:

• An account owner or admin permissions of an account
• The account making this API request must be on a Pro or a higher account plan with Master account privileges

Parameters:

• account_id: &str – The account’s account ID.

pub async fn upload_vb( &self, account_id: &str, body: &UploadVbRequest ) -> Result<Response<Files>, ClientError>

Upload virtual background files.

This function performs a POST to the /accounts/{accountId}/settings/virtual_backgrounds endpoint.

Use this API to upload virtual background files for all users on the account to use.

Prerequisites:

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

Parameters:

• account_id: &str – Unique identifier of the account.

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

Delete virtual background files.

This function performs a DELETE to the /accounts/{accountId}/settings/virtual_backgrounds endpoint.

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

Prerequisites:

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

Parameters:

• 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.