Struct zoom_api::users::Users

pub struct Users {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Users

pub async fn get_page( &self, status: UsersStatus, page_size: i64, role_id: &str, page_number: &str, include_fields: UsersIncludeFields, next_page_token: &str ) -> Result<Response<Vec<UsersResponse>>, ClientError>

List users.

This function performs a GET to the /users endpoint.

Use this API to list your account’s users.

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

Parameters:

• status: crate::types::UsersStatus – The user’s status: * active — An active user. * inactive — A deactivated user. * pending — A pending user.

This value defaults to active.

• page_size: i64 – The number of records returned within a single API call.
• role_id: &str – The role’s unique ID. Use this parameter to filter the response by a specific role. You can use the List Roles API to get a role’s unique ID value.
• page_number: &str – The page number of the current page in the returned records.
• include_fields: crate::types::UsersIncludeFields – Use this parameter to display one of the following attributes in the API call’s response: * custom_attributes — Return the user’s custom attributes. * host_key — Return the user’s host key.
• 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( &self, status: UsersStatus, role_id: &str, include_fields: UsersIncludeFields ) -> Result<Response<Vec<UsersResponse>>, ClientError>

List users.

This function performs a GET to the /users endpoint.

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

Use this API to list your account’s users.

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

pub async fn create( &self, body: &UserCreateRequest ) -> Result<Response<UserCreateResponse>, ClientError>

Create users.

This function performs a POST to the /users endpoint.

A Zoom account can have one or more users. Use this API to add a new user to your account.

Prerequisites:

• Pro or higher plan
  
  Scopes: user:write:admin user:write
  

Rate Limit Label: Light

pub async fn user( &self, user_id: &str, login_type: LoginType, encrypted_email: bool ) -> Result<Response<UserResponseAllOf>, ClientError>

Get a user.

This function performs a GET to the /users/{userId} endpoint.

View a specific user’s information on a Zoom account. A Zoom account can have one or more users. For user-level apps, pass the me value instead of the userId parameter.

Note: Users who have not activated their account have a status of pending, and the created_at time displays the time at which the API call was made.

Scopes: user:read:admin, user:read, user_info:read

Note: The user_info:read scope is only available when you pass the me value for the $userId value.

Rate Limit Label: Light

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.
• login_type: crate::types::LoginType – The user’s login method:

0 — Facebook OAuth
1 — Google OAuth
24 — Apple OAuth
27 — Microsoft OAuth
97 — Mobile device
98 — RingCentral OAuth
99 — API user
100 — Zoom Work email
101 — Single Sign-On (SSO)

The following login methods are only available in China:

11 — Phone number
21 — WeChat
23 — Alipay.

• encrypted_email: bool – Enable/disable the option for a sub account to use shared Virtual Room Connector(s) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.

pub async fn delete( &self, user_id: &str, action: UserDeleteAction, transfer_email: &str, transfer_meeting: bool, transfer_webinar: bool, transfer_recording: bool ) -> Result<Response<()>, ClientError>

Delete a user.

This function performs a DELETE to the /users/{userId} endpoint.

Use this API to disassociate (unlink) a user or permanently delete a user. For user-level apps, pass the me value instead of the userId parameter.

Deleting a user permanently removes the user and their data from Zoom. Users can create a new Zoom account using the same email address. An account owner or an account admin can transfer meetings, webinars and cloud recordings to another Zoom user account before deleting.

Disassociating a user unlinks the user from the associated Zoom account and provides the user their own basic free Zoom account. The disassociated user can then purchase their own Zoom licenses. An account owner or account admin can transfer the user’s meetings, webinars, and cloud recordings to another user before disassociation.

Scopes: user:write:admin, user:write
Rate Limit Label: Light

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.
• action: crate::types::UserDeleteAction – Delete action options:
  disassociate - Disassociate a user.
  delete- Permanently delete a user.
  Note: To delete pending user in the account, use disassociate.
• transfer_email: &str – User’s first name.
• transfer_meeting: bool – Enable/disable the option for a sub account to use shared Virtual Room Connector(s) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.
• transfer_webinar: bool – Enable/disable the option for a sub account to use shared Virtual Room Connector(s) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.
• transfer_recording: bool – Enable/disable the option for a sub account to use shared Virtual Room Connector(s) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.

pub async fn update( &self, user_id: &str, login_type: LoginType, body: &UserUpdate ) -> Result<Response<()>, ClientError>

Update a user.

This function performs a PATCH to the /users/{userId} endpoint.

Update information on a user’s Zoom profile. For user-level apps, pass the me value instead of the userId parameter.

Scopes: user:write:admin user:write
Rate Limit Label: Light

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.
• login_type: crate::types::LoginType – The user’s login method:

0 — Facebook OAuth
1 — Google OAuth
24 — Apple OAuth
27 — Microsoft OAuth
97 — Mobile device
98 — RingCentral OAuth
99 — API user
100 — Zoom Work email
101 — Single Sign-On (SSO)

The following login methods are only available in China:

11 — Phone number
21 — WeChat
23 — Alipay.

pub async fn zak(&self) -> Result<Response<UserZakResponse>, ClientError>

Get user’s ZAK.

This function performs a GET to the /users/me/zak endpoint.

Get User’s Zoom Access Token (ZAK). You can use a ZAK to enable a non-login user to join a meeting on your app. Non-login users do not need to enter their username and password to join meetings.

Scope: user_zak:read
Rate Limit Label: Light

pub async fn assistant( &self, user_id: &str ) -> Result<Response<UserAssistantsList>, ClientError>

List user assistants.

This function performs a GET to the /users/{userId}/assistants endpoint.

List a user’s assistants. For user-level apps, pass the me value instead of the userId parameter.

Assistants are the users to whom the current user has assigned scheduling privilege. These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled Co-host option on the account.

Scopes: user:read:admin, user:read
Rate Limit Label: Medium

Prerequisites:

• Current user as well as the assistant must have Licensed or an On-prem license.
• Assistants must be under the current user’s account.

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.

pub async fn assistant_create( &self, user_id: &str, body: &UserAssistantsList ) -> Result<Response<AddRoleMembersResponse>, ClientError>

Add assistants.

This function performs a POST to the /users/{userId}/assistants endpoint.

Use this API to assign assistants to a user. In the request body, provide either the user’s ID or the user’s email address. For user-level apps, pass the me value instead of the userId parameter.

Assistants are the users to whom the current user has assigned scheduling privilege. These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled Co-host option on the account.

Scopes: user:write:admin, user:write
Rate Limit Label: Medium

Prerequisites:

• The user as well as the assistant must have Licensed or an On-prem license.
• Assistants must be under the current user’s account.

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.

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

Delete user assistants.

This function performs a DELETE to the /users/{userId}/assistants endpoint.

Delete all assistants of the current user. For user-level apps, pass the me value instead of the userId parameter.

Assistants are the users to whom the current user has assigned scheduling privilege. These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled Co-host option on the account.

Scopes: user:write:admin, user:write
Rate Limit Label: Light

Prerequisites:

• The user as well as the assistant must have Licensed or an On-prem license.
• Assistants must be under the current user’s account.

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.

pub async fn assistant_delete( &self, user_id: &str, assistant_id: &str ) -> Result<Response<()>, ClientError>

Delete a user assistant.

This function performs a DELETE to the /users/{userId}/assistants/{assistantId} endpoint.

Delete a specific assistant of a user. For user-level apps, pass the me value instead of the userId parameter.

Assistants are the users to whom the current user has assigned scheduling privilege. These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled Co-host option on the account.

Scopes: user:write:admin, user:write
Rate Limit Label: Light

Prerequisites:

• The user as well as the assistant must have Licensed or an On-prem license.
• Assistants must be under the current user’s account.

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.
• assistant_id: &str – User’s first name.

pub async fn scheduler( &self, user_id: &str ) -> Result<Response<UserSchedulersList>, ClientError>

List user schedulers.

This function performs a GET to the /users/{userId}/schedulers endpoint.

List all the schedulers of a user. For user-level apps, pass the me value instead of the userId parameter.

Schedulers in this context are the users for whom the current user can schedule meetings for. For example, if the current user (the user whose userId was passed in the path parameter) is “user A”, the response of this API will contain a list of user(s), for whom user A can schedule and manage meetings. User A is the assistant of these users and thus has scheduling privilege for these user(s).

Scopes: user:read:admin, user:read
Rate Limit Label: Medium

Prerequisites:

• Current user must be under the same account as the scheduler.

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.

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

Delete user schedulers.

This function performs a DELETE to the /users/{userId}/schedulers endpoint.

Delete all of a user’s schedulers. For user-level apps, pass the me value instead of the userId parameter.

Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of any user.

Scopes: user:write:admin, user:write
Rate Limit Label: Light

Prerequisites:

• Current user (assistant) must be under the same account as the scheduler.

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.

pub async fn scheduler_delete( &self, user_id: &str, scheduler_id: &str ) -> Result<Response<()>, ClientError>

Delete a scheduler.

This function performs a DELETE to the /users/{userId}/schedulers/{schedulerId} endpoint.

Delete a scheduler. For user-level apps, pass the me value instead of the userId parameter.

Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of this scheduler.

Scopes: user:write:admin, user:write
Rate Limit Label: Light

Prerequisites:

• Current user must be under the same account as the scheduler.

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.
• scheduler_id: &str – User’s first name.

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

Upload a user’s profile picture.

This function performs a POST to the /users/{userId}/picture endpoint.

Upload a user’s profile picture. For user-level apps, pass the me value instead of the userId parameter.

Provide multipart/form-data as the value of the content-type header for this request. This API supports .jpeg and .png file formats.

Scopes: user:write:admin, user:write
Rate Limit Label: Medium

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.

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

Get user settings.

This function performs a GET to the /users/{userId}/settings endpoint.

Retrieve a user’s settings. For user-level apps, pass the me value instead of the userId parameter.

Scopes: user:read:admin, user:read
Rate Limit Label: Medium

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.
• login_type: crate::types::LoginType – The user’s login method:

0 — Facebook OAuth
1 — Google OAuth
24 — Apple OAuth
27 — Microsoft OAuth
97 — Mobile device
98 — RingCentral OAuth
99 — API user
100 — Zoom Work email
101 — Single Sign-On (SSO)

The following login methods are only available in China:

11 — Phone number
21 — WeChat
23 — Alipay.

• 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 – 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 settings_user( &self, user_id: &str, login_type: LoginType, option: OptionData, custom_query_fields: &str ) -> Result<Response<UserSettings>, ClientError>

Get user settings.

This function performs a GET to the /users/{userId}/settings endpoint.

Retrieve a user’s settings. For user-level apps, pass the me value instead of the userId parameter.

Scopes: user:read:admin, user:read
Rate Limit Label: Medium

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.
• login_type: crate::types::LoginType – The user’s login method:

0 — Facebook OAuth
1 — Google OAuth
24 — Apple OAuth
27 — Microsoft OAuth
97 — Mobile device
98 — RingCentral OAuth
99 — API user
100 — Zoom Work email
101 — Single Sign-On (SSO)

The following login methods are only available in China:

11 — Phone number
21 — WeChat
23 — Alipay.

• 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 – 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 settings_meeting_security( &self, user_id: &str, login_type: LoginType, option: OptionData, custom_query_fields: &str ) -> Result<Response<MeetingSecuritySettings>, ClientError>

Get user settings.

This function performs a GET to the /users/{userId}/settings endpoint.

Retrieve a user’s settings. For user-level apps, pass the me value instead of the userId parameter.

Scopes: user:read:admin, user:read
Rate Limit Label: Medium

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.
• login_type: crate::types::LoginType – The user’s login method:

0 — Facebook OAuth
1 — Google OAuth
24 — Apple OAuth
27 — Microsoft OAuth
97 — Mobile device
98 — RingCentral OAuth
99 — API user
100 — Zoom Work email
101 — Single Sign-On (SSO)

The following login methods are only available in China:

11 — Phone number
21 — WeChat
23 — Alipay.

• 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 – 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 setting( &self, user_id: &str, login_type: LoginType, option: OptionData, custom_query_fields: &str ) -> Result<Response<UserSettingsResponseOneOf>, ClientError>

Get user settings.

This function performs a GET to the /users/{userId}/settings endpoint.

Retrieve a user’s settings. For user-level apps, pass the me value instead of the userId parameter.

Scopes: user:read:admin, user:read
Rate Limit Label: Medium

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.
• login_type: crate::types::LoginType – The user’s login method:

0 — Facebook OAuth
1 — Google OAuth
24 — Apple OAuth
27 — Microsoft OAuth
97 — Mobile device
98 — RingCentral OAuth
99 — API user
100 — Zoom Work email
101 — Single Sign-On (SSO)

The following login methods are only available in China:

11 — Phone number
21 — WeChat
23 — Alipay.

• 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 – 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 settings_update( &self, option: UserSettingsUpdateOption, user_id: &str, body: &UserSettingsUpdateRequestOneOf ) -> Result<Response<()>, ClientError>

Update user settings.

This function performs a PATCH to the /users/{userId}/settings endpoint.

Update a user’s settings. For user-level apps, pass the me value instead of the userId parameter.

Scopes: user:write:admin, user:write
Rate Limit Label: Medium

Parameters:

• option: crate::types::UserSettingsUpdateOption
• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.

pub async fn status( &self, user_id: &str, body: &UserStatusRequest ) -> Result<Response<()>, ClientError>

Update user status.

This function performs a PUT to the /users/{userId}/status endpoint.

Use this API to deactivate an active user or to reactivate a deactivated user. For user-level apps, pass the me value instead of the userId parameter.

An account owner or admins can deactivate as well as activate a user in a Zoom account. Deactivating a user will remove all licenses associated with a user. It will prevent the deactivated user from logging into their Zoom account. A deactivated user can be reactivated. Reactivating a user grants the user access to login to their Zoom account.

Scopes: user:write:admin, user:write
Rate Limit Label: Light

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.

pub async fn password( &self, user_id: &str, body: &UserPasswordRequest ) -> Result<Response<()>, ClientError>

Update a user’s password.

This function performs a PUT to the /users/{userId}/password endpoint.

Update the password of a user using which the user can login to Zoom. For user-level apps, pass the me value instead of the userId parameter.

After this request is processed successfully, an email notification will be sent to the user stating that the password was changed.
Scopes: user:write:admin user:write

Rate Limit Label: Medium Prerequisites:

• Owner or admin of the Zoom account.

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.

pub async fn permission( &self, user_id: &str ) -> Result<Response<UserPermissions>, ClientError>

Get user permissions.

This function performs a GET to the /users/{userId}/permissions endpoint.

Use this API to get permissions that have been granted to the user. For user-level apps, pass the me value instead of the userId parameter.

Users can be assigned a set of permissions that allows them to access only the pages/information that a user needs to view or edit.

Scopes: user:read:admin, user:read
Rate Limit Label: Light

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.

pub async fn token( &self, user_id: &str, type_: UserTokenType, ttl: i64 ) -> Result<Response<UserZakResponse>, ClientError>

Get a user token.

This function performs a GET to the /users/{userId}/token endpoint.

Retrieve a user’s token. For user-level apps, pass the me value instead of the userId parameter.

This token is used for starting meetings with the Client SDK. If a user signed into Zoom using Google or Facebook, a null value will be returned for the token. To get the token with this API, ask the user to sign into Zoom using their email and password instead.

Scopes: user:read:admin, user:read
Rate Limit Label: Light

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.
• type_: crate::types::UserTokenType – User token types:
  token - Used for starting meetings with the client SDK. This token expires in 14 days and a new token will be returned after the expiry.
  zak - Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days.
• ttl: i64 – Use this field in conjunction with the type field where the value of type field is zak. The value of this field denotes the expiry time of the zak token in seconds. For example, if you would like the zak token to be expired after one hour of the token generation, the value of this field should be 3600.

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

Revoke a user’s SSO token.

This function performs a DELETE to the /users/{userId}/token endpoint.

Revoke a user’s SSO token. For user-level apps, pass the me value instead of the userId parameter.

After calling this API, the SSO user will be logged out of their current Zoom session.

Scopes: user:write:admin, user:write
Rate Limit Label: Light

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.

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

Check a user email.

This function performs a GET to the /users/email endpoint.

Verify if a user’s email is registered with Zoom.

Note: You can successfully check if a user is a registered Zoom user only if the user signed up for Zoom via email and is within your account. If you provide an email address of a user who is not in your account, the value of “existed_email” parameter will be “false” irrespective of whether or not the user is registered with Zoom. The response of this API call will not include users who joined Zoom using options such as “Sign in with SSO”, “Sign in with Google” or “Sign in with Facebook” even if they are in the same account as yours.

Scopes: user:read:admin user:read

Rate Limit Label: Light

Parameters:

• email: &str – The email address to be verified.

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

Update a user’s email.

This function performs a PUT to the /users/{userId}/email endpoint.

Change a user’s email address on a Zoom account that has managed domain set up. For user-level apps, pass the me value instead of the userId parameter.

• If the Zoom account in which the user belongs has multiple managed domains, then the email to be updated must match one of the managed domains.
• A user’s email address can only be changed for a maximum of 3 times in a day (24 hours).

Scopes: user:write:admin, user:write
Rate Limit Label: Light

Prerequisites:

• Managed domain must be enabled in the account.
• The new email address should not already exist in Zoom.

Parameters:

• user_id: &str – The user ID or email address of the user. For user-level apps, pass me as the value for userId.

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

Check a user’s PM room.

This function performs a GET to the /users/vanity_name endpoint.

A personal meeting room is a virtual meeting room that can be permanently assigned to a user. Use this API to check if a personal meeting room with the given name exists or not.

Scopes: user:read:admin user:read

Rate Limit Label: Light

Parameters:

• vanity_name: &str – Personal meeting room name.

pub async fn switch_account( &self, account_id: &str, user_id: &str, body: &SwitchUserAccountRequest ) -> Result<Response<()>, ClientError>

Switch a user’s account.

This function performs a PUT to the /accounts/{accountId}/users/{userId}/account endpoint.

Disassociate a user from one Account and move the user to another Account under the same master account.

With this API, a user under a master account or a sub account can be moved to another sub account within the same master account. To move a user from a master account to a sub account, use me as the value for accountId. In this scenario, “me” refers to the Account ID of the master account.

To move a user from one sub account to another sub account, provide the sub account’s Account ID as the value for accountId.

Prerequisites:

• The account should have Pro or a higher plan with master account option enabled.
• The user whose account needs to be switched should not be an admin or an owner of that account.
• The user should not have the same managed domain as the account owner.

Scope: user:master

Rate Limit Label: Light

Parameters:

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

pub async fn update_presence_status( &self, user_id: &str, body: &UpdatePresenceStatusRequestData ) -> Result<Response<()>, ClientError>

Update a user’s presence status.

This function performs a PUT to the /users/{userId}/presence_status endpoint.

Use this API to update a user’s presence status. For user-level apps, pass the me value instead of the userId parameter.

A user’s status cannot be updated more than once per minute. For example, you can only submit a maximum of one update request per minute for a single user.

Users in the Zoom desktop client and mobile apps are assigned with a presence status. The presence status informs users of their contact’s availability. Users can also change their own presence status to one the following:

• Away
• Do not disturb
• Available
• In a calendar event
• Presenting
• In a Zoom meeting
• On a call

Note that a user’s presence status cannot be updated via this API if the user is not logged in to the Zoom client.

Scopes: user:write, user:write:admin
Rate Limit Label: Medium

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

Upload virtual background files.

This function performs a POST to the /users/{userId}/settings/virtual_backgrounds endpoint.

Use this API to upload virtual background files to a user’s profile. For user-level apps, pass the me value instead of the userId parameter.

Note: A user profile cannot exceed more than 10 files.

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

Prerequisites:

• Virtual background feature must be enabled on the account.

Parameters:

• user_id: &str – Unique identifier of the user. Retrieve the value for this field by calling the List users API.

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

Delete virtual background files.

This function performs a DELETE to the /users/{userId}/settings/virtual_backgrounds endpoint.

Delete existing virtual background file(s) of a user. For user-level apps, pass the me value instead of the userId parameter.

Scopes: user:write:admin
Rate Limit Label: Light

Prerequisites:

• Virtual background feature must be enabled on the account.

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.
• user_id: &str – Unique identifier of the user. Retrieve the value of this field by calling the List users API. .