Zoom\Api\UsersApi

All URIs are relative to https://api.zoom.us/v2.

Method	HTTP request	Description
delUserVB()	DELETE /users/{userId}/settings/virtual_backgrounds	Delete Virtual Background files
updatePresenceStatus()	PUT /users/{userId}/presence_status	Update a user's presence status
uploadVBuser()	POST /users/{userId}/settings/virtual_backgrounds	Upload Virtual Background files
user()	GET /users/{userId}	Get a user
userAssistantCreate()	POST /users/{userId}/assistants	Add assistants
userAssistantDelete()	DELETE /users/{userId}/assistants/{assistantId}	Delete a user assistant
userAssistants()	GET /users/{userId}/assistants	List user assistants
userAssistantsDelete()	DELETE /users/{userId}/assistants	Delete user assistants
userCreate()	POST /users	Create users
userDelete()	DELETE /users/{userId}	Delete a user
userEmail()	GET /users/email	Check a user email
userEmailUpdate()	PUT /users/{userId}/email	Update a user's email
userPassword()	PUT /users/{userId}/password	Update a user's password
userPermission()	GET /users/{userId}/permissions	Get user permissions
userPicture()	POST /users/{userId}/picture	Upload a user's profile picture
userPictureDelete()	DELETE /users/{userId}/picture	Delete a user's profile picture
userSSOTokenDelete()	DELETE /users/{userId}/token	Revoke a user's SSO token
userSchedulerDelete()	DELETE /users/{userId}/schedulers/{schedulerId}	Delete a scheduler
userSchedulers()	GET /users/{userId}/schedulers	List user schedulers
userSchedulersDelete()	DELETE /users/{userId}/schedulers	Delete user schedulers
userSettings()	GET /users/{userId}/settings	Get user settings
userSettingsUpdate()	PATCH /users/{userId}/settings	Update user settings
userStatus()	PUT /users/{userId}/status	Update user status
userToken()	GET /users/{userId}/token	Get a user's token
userUpdate()	PATCH /users/{userId}	Update a user
userVanityName()	GET /users/vanity_name	Check a user's PM room
userZak()	GET /users/me/zak	Get user's ZAK
users()	GET /users	List users

`delUserVB()`

delUserVB($user_id, $file_ids)

Delete Virtual Background files

Use this API to delete a user's Virtual Background files. For user-level apps, pass the me value instead of the userId parameter. Scopes: user:write, user:write:admin
Rate Limit Label: Light Prerequisites: * The Virtual Background feature must be enabled on the account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = Zoom\Api\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Zoom\Api\Api\UsersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$user_id = KDcuGIm1QgePTO8WbOqwIQ; // string | The user's ID. To get a user's ID, use the [**List users**](/docs/api-reference/zoom-api/ma#operation/users) API. For user-level apps, pass the `me` value instead of the user ID value.
$file_ids = _l0MP1U7Qn2JgJ4oEJbVZQ; // string | A comma-separated list of the Virtual Background file IDs to delete.

try {
    $apiInstance->delUserVB($user_id, $file_ids);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->delUserVB: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
user_id	string	The user's ID. To get a user's ID, use the List users API. For user-level apps, pass the `me` value instead of the user ID value.
file_ids	string	A comma-separated list of the Virtual Background file IDs to delete.	[optional]

Return type

void (empty response body)

Name	Type	Description	Notes
user_id	string
update_presence_status_request	\Zoom\Api\Model\UpdatePresenceStatusRequest		[optional]

Name	Type	Description	Notes
user_id	GroupAdminsDeleteUserIdParameter	The user ID or email address of the user. For user-level apps, pass the `me` value.
login_type	int	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	[optional]
encrypted_email	bool	Whether the email address passed for the `userId` value is an encrypted email address: * `true` — The email address is encrypted. * `false` — The email address is not encrypted. If you do not query this parameter, this value defaults to null (`false`).	[optional] [default to false]
search_by_unique_id	bool	Whether the queried `userId` value is an employee unique ID: * `true` — The queried ID is an employee's unique ID. * `false` — The queried ID is not an employee's unique ID. This value defaults to `false` (null).	[optional]

Name	Type	Description	Notes
status	string	The user's status: * `active` — The user exists on the account. * `inactive` — The user has been deactivated. * `pending` — The user exists on the account but has not activated their account. See Managing users for details. This value defaults to `active`.	[optional] [default to 'active']
page_size	int	The number of records returned within a single API call.	[optional] [default to 30]
role_id	string	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.	[optional]
page_number	string	The page number of the current page in the returned records.	[optional]
include_fields	string	Use this parameter to display specific attributes in the API call's response: * `custom_attributes` — Return the user's custom attributes.	[optional]
next_page_token	string	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.	[optional]

Files

UsersApi.md

Latest commit

History

UsersApi.md

File metadata and controls

Zoom\Api\UsersApi

delUserVB()

Example

Parameters

Return type

Authorization

HTTP request headers

updatePresenceStatus()

Example

Parameters

Return type

Authorization

HTTP request headers

uploadVBuser()

Example

Parameters

Return type

Authorization

HTTP request headers

user()

Example

Parameters

Return type

Authorization

HTTP request headers

userAssistantCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

userAssistantDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

userAssistants()

Example

Parameters

Return type

Authorization

HTTP request headers

userAssistantsDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

userCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

userDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

userEmail()

Example

Parameters

Return type

Authorization

HTTP request headers

userEmailUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

userPassword()

`delUserVB()`

`updatePresenceStatus()`

`uploadVBuser()`

`user()`

`userAssistantCreate()`

`userAssistantDelete()`

`userAssistants()`

`userAssistantsDelete()`

`userCreate()`

`userDelete()`

`userEmail()`

`userEmailUpdate()`

`userPassword()`

`userPermission()`

`userPicture()`

`userPictureDelete()`

`userSSOTokenDelete()`

`userSchedulerDelete()`

`userSchedulers()`

`userSchedulersDelete()`

`userSettings()`

`userSettingsUpdate()`

`userStatus()`