Skip to content

Latest commit

 

History

History
258 lines (175 loc) · 13 KB

AccountsApi.md

File metadata and controls

258 lines (175 loc) · 13 KB

Zoom\Api\AccountsApi

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

Method HTTP request Description
accountManagedDomain() GET /accounts/{accountId}/managed_domains Get account's managed domains
accountSettings() GET /accounts/{accountId}/settings Get account settings
accountSettingsUpdate() PATCH /accounts/{accountId}/settings Update account settings
accountTrustedDomain() GET /accounts/{accountId}/trusted_domains Get account's trusted domains

accountManagedDomain()

accountManagedDomain($account_id): \Zoom\Api\Model\DomainsList

Get account's managed domains

Use this API to get an account's managed domains. To get the Master account's managed domains, pass the me value for the accountId path parameter. Scopes: account:read:admin
Rate Limit Label: Light Prerequisites: * A Pro or a higher paid account with the Master account option enabled.

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\AccountsApi(
    // 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
);
$account_id = q6gBJVO5TzexKYTb_I2rpg; // string | The account's ID. For the Master account, pass the `me` value for this parameter.

try {
    $result = $apiInstance->accountManagedDomain($account_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->accountManagedDomain: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
account_id string The account's ID. For the Master account, pass the `me` value for this parameter.

Return type

\Zoom\Api\Model\DomainsList

Authorization

OAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountSettings()

accountSettings($account_id, $option, $custom_query_fields): \Zoom\Api\Model\AccountSettings200Response

Get account settings

Use this API to get an account's settings. To get the Master account's settings, use the me value for the accountId path parameter. Scopes: account:read:admin
Rate Limit Label: Medium Prerequisites: * The account must be a paid 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\AccountsApi(
    // 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
);
$account_id = me; // string | The account's ID. For the Master account, pass the `me` value for this parameter.
$option = security; // string | Optional query parameters:  * `meeting_authentication` — Use this query parameter to view the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account.  * `recording_authentication` — Use this query parameter to view the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account.  * `security` — Use this query parameter to view the account's security settings. For example, password requirements for user login or two-factor authentication.  * `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.
$custom_query_fields = in_meeting; // string | 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`

try {
    $result = $apiInstance->accountSettings($account_id, $option, $custom_query_fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->accountSettings: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
account_id string The account's ID. For the Master account, pass the `me` value for this parameter.
option string Optional query parameters: * `meeting_authentication` — Use this query parameter to view the meeting authentication settings applied to the user's account. * `recording_authentication` — Use this query parameter to view the recording authentication settings applied to the user's account. * `security` — Use this query parameter to view the account's security settings. For example, password requirements for user login or two-factor authentication. * `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account. [optional]
custom_query_fields string 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: `{ &quot;schedule_meeting&quot;: { &quot;host_video&quot;: false } }` To use multiple values, comma-separate each value. For example: `host_video,participant_video` [optional]

Return type

\Zoom\Api\Model\AccountSettings200Response

Authorization

OAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountSettingsUpdate()

accountSettingsUpdate($account_id, $account_settings_update_request, $option)

Update account settings

Use this API to update an account's settings. To update the Master account's settings, pass the me value for the accountId path parameter. Scopes: account:write:admin
Rate Limit Label: Medium Prerequisites: * The account must be a paid 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\AccountsApi(
    // 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
);
$account_id = me; // string | The account's ID. For the Master account, pass the `me` value for this parameter.
$account_settings_update_request = new \Zoom\Api\Model\AccountSettingsUpdateRequest(); // \Zoom\Api\Model\AccountSettingsUpdateRequest
$option = meeting_security; // string | Optional query parameters:  * `meeting_authentication` — Use this query parameter to view the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account.  * `recording_authentication` — Use this query parameter to view the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account.  * `security` — Use this query parameter to view the account's security settings. For example, password requirements for user login or two-factor authentication.  * `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account.

try {
    $apiInstance->accountSettingsUpdate($account_id, $account_settings_update_request, $option);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->accountSettingsUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
account_id string The account's ID. For the Master account, pass the `me` value for this parameter.
account_settings_update_request \Zoom\Api\Model\AccountSettingsUpdateRequest
option string Optional query parameters: * `meeting_authentication` — Use this query parameter to view the meeting authentication settings applied to the user's account. * `recording_authentication` — Use this query parameter to view the recording authentication settings applied to the user's account. * `security` — Use this query parameter to view the account's security settings. For example, password requirements for user login or two-factor authentication. * `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account. [optional]

Return type

void (empty response body)

Authorization

OAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

accountTrustedDomain()

accountTrustedDomain($account_id): \Zoom\Api\Model\AccountTrustedDomain200Response

Get account's trusted domains

Use this API to get an account's trusted domains. To get the Master account's trusted domains, use the me value for the accountId path parameter. Scopes: account:read:admin
Rate Limit Label: Light Prerequisites: * The account must be a paid 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\AccountsApi(
    // 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
);
$account_id = q6gBJVO5TzexKYTb_I2rpg; // string | The account's ID. For the Master account, pass the `me` value for this parameter.

try {
    $result = $apiInstance->accountTrustedDomain($account_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->accountTrustedDomain: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
account_id string The account's ID. For the Master account, pass the `me` value for this parameter.

Return type

\Zoom\Api\Model\AccountTrustedDomain200Response

Authorization

OAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]