@maxim_mazurok/gapi.client.admin-directory_v1 0.0.20250626 → 0.0.20250707
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +108 -108
- package/package.json +1 -1
- package/readme.md +9 -9
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://admin.googleapis.com/$discovery/rest?version=directory_v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250707
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -393,17 +393,17 @@ declare namespace gapi.client {
|
|
|
393
393
|
macAddress?: string;
|
|
394
394
|
/** (Read-only) The date the device was manufactured in yyyy-mm-dd format. */
|
|
395
395
|
manufactureDate?: string;
|
|
396
|
-
/** The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin
|
|
396
|
+
/** The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices.html#export_meid). */
|
|
397
397
|
meid?: string;
|
|
398
398
|
/** The device's model information. If the device does not have this information, this property is not included in the response. */
|
|
399
399
|
model?: string;
|
|
400
|
-
/** Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin
|
|
400
|
+
/** Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. */
|
|
401
401
|
notes?: string;
|
|
402
402
|
/** The device's order number. Only devices directly purchased from Google have an order number. */
|
|
403
403
|
orderNumber?: string;
|
|
404
|
-
/** The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin
|
|
404
|
+
/** The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). */
|
|
405
405
|
orgUnitId?: string;
|
|
406
|
-
/** The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin
|
|
406
|
+
/** The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). */
|
|
407
407
|
orgUnitPath?: string;
|
|
408
408
|
/** The status of the OS updates for the device. */
|
|
409
409
|
osUpdateStatus?: OsUpdateStatus;
|
|
@@ -488,9 +488,9 @@ declare namespace gapi.client {
|
|
|
488
488
|
printer?: Printer;
|
|
489
489
|
}
|
|
490
490
|
interface CreatePrintServerRequest {
|
|
491
|
-
/** Required. The [unique ID](https://developers.google.com/admin
|
|
491
|
+
/** Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` */
|
|
492
492
|
parent?: string;
|
|
493
|
-
/** Required. A print server to create. If you want to place the print server under a specific organizational unit (OU), then populate the `org_unit_id`. Otherwise the print server is created under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/admin
|
|
493
|
+
/** Required. A print server to create. If you want to place the print server under a specific organizational unit (OU), then populate the `org_unit_id`. Otherwise the print server is created under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units). */
|
|
494
494
|
printServer?: PrintServer;
|
|
495
495
|
}
|
|
496
496
|
interface Customer {
|
|
@@ -506,7 +506,7 @@ declare namespace gapi.client {
|
|
|
506
506
|
id?: string;
|
|
507
507
|
/** Identifies the resource as a customer. Value: `admin#directory#customer` */
|
|
508
508
|
kind?: string;
|
|
509
|
-
/** The customer's ISO 639-2 language code. See the [Language Codes](/admin
|
|
509
|
+
/** The customer's ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`. */
|
|
510
510
|
language?: string;
|
|
511
511
|
/** The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. */
|
|
512
512
|
phoneNumber?: string;
|
|
@@ -784,7 +784,7 @@ declare namespace gapi.client {
|
|
|
784
784
|
deviceId?: string;
|
|
785
785
|
/** DevicePasswordStatus (Read-only) */
|
|
786
786
|
devicePasswordStatus?: string;
|
|
787
|
-
/** The list of the owner's email addresses. If your application needs the current list of user emails, use the [get](/admin
|
|
787
|
+
/** The list of the owner's email addresses. If your application needs the current list of user emails, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For additional information, see the [retrieve a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user) method. */
|
|
788
788
|
email?: string[];
|
|
789
789
|
/** Mobile Device Encryption Status (Read-only) */
|
|
790
790
|
encryptionStatus?: string;
|
|
@@ -810,13 +810,13 @@ declare namespace gapi.client {
|
|
|
810
810
|
manufacturer?: string;
|
|
811
811
|
/** The device's MEID number. */
|
|
812
812
|
meid?: string;
|
|
813
|
-
/** The mobile device's model name, for example Nexus S. This property can be [updated](/admin
|
|
813
|
+
/** The mobile device's model name, for example Nexus S. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile=devices#update_mobile_device). */
|
|
814
814
|
model?: string;
|
|
815
|
-
/** The list of the owner's user names. If your application needs the current list of device owner names, use the [get](/admin
|
|
815
|
+
/** The list of the owner's user names. If your application needs the current list of device owner names, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For more information about retrieving mobile device user information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user). */
|
|
816
816
|
name?: string[];
|
|
817
817
|
/** Mobile Device mobile or network operator (if available) (Read-only) */
|
|
818
818
|
networkOperator?: string;
|
|
819
|
-
/** The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](/admin
|
|
819
|
+
/** The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device). */
|
|
820
820
|
os?: string;
|
|
821
821
|
/** The list of accounts added on device (Read-only) */
|
|
822
822
|
otherAccountsInfo?: string[];
|
|
@@ -838,7 +838,7 @@ declare namespace gapi.client {
|
|
|
838
838
|
type?: string;
|
|
839
839
|
/** Unknown sources enabled or disabled on device (Read-only) */
|
|
840
840
|
unknownSourcesStatus?: boolean;
|
|
841
|
-
/** Gives information about the device such as `os` version. This property can be [updated](/admin
|
|
841
|
+
/** Gives information about the device such as `os` version. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device). */
|
|
842
842
|
userAgent?: string;
|
|
843
843
|
/** The device's MAC address on Wi-Fi networks. */
|
|
844
844
|
wifiMacAddress?: string;
|
|
@@ -870,7 +870,7 @@ declare namespace gapi.client {
|
|
|
870
870
|
name?: string;
|
|
871
871
|
/** The unique ID of the organizational unit. */
|
|
872
872
|
orgUnitId?: string;
|
|
873
|
-
/** The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin
|
|
873
|
+
/** The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user). */
|
|
874
874
|
orgUnitPath?: string;
|
|
875
875
|
/** The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set. */
|
|
876
876
|
parentOrgUnitId?: string;
|
|
@@ -940,7 +940,7 @@ declare namespace gapi.client {
|
|
|
940
940
|
id?: string;
|
|
941
941
|
/** Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` */
|
|
942
942
|
name?: string;
|
|
943
|
-
/** ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin
|
|
943
|
+
/** ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits). */
|
|
944
944
|
orgUnitId?: string;
|
|
945
945
|
/** Editable. Print server URI. */
|
|
946
946
|
uri?: string;
|
|
@@ -966,7 +966,7 @@ declare namespace gapi.client {
|
|
|
966
966
|
kind?: string;
|
|
967
967
|
/** The name of the privilege. */
|
|
968
968
|
privilegeName?: string;
|
|
969
|
-
/** The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin
|
|
969
|
+
/** The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list). */
|
|
970
970
|
serviceId?: string;
|
|
971
971
|
/** The name of the service this privilege is for. */
|
|
972
972
|
serviceName?: string;
|
|
@@ -998,7 +998,7 @@ declare namespace gapi.client {
|
|
|
998
998
|
rolePrivileges?: Array<{
|
|
999
999
|
/** The name of the privilege. */
|
|
1000
1000
|
privilegeName?: string;
|
|
1001
|
-
/** The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin
|
|
1001
|
+
/** The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list). */
|
|
1002
1002
|
serviceId?: string;
|
|
1003
1003
|
}>;
|
|
1004
1004
|
}
|
|
@@ -1007,7 +1007,7 @@ declare namespace gapi.client {
|
|
|
1007
1007
|
assignedTo?: string;
|
|
1008
1008
|
/** Output only. The type of the assignee (`USER` or `GROUP`). */
|
|
1009
1009
|
assigneeType?: string;
|
|
1010
|
-
/** Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview).
|
|
1010
|
+
/** Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition. */
|
|
1011
1011
|
condition?: string;
|
|
1012
1012
|
/** ETag of the resource. */
|
|
1013
1013
|
etag?: string;
|
|
@@ -1078,7 +1078,7 @@ declare namespace gapi.client {
|
|
|
1078
1078
|
/** Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. */
|
|
1079
1079
|
minValue?: number;
|
|
1080
1080
|
};
|
|
1081
|
-
/** Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin
|
|
1081
|
+
/** Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected. */
|
|
1082
1082
|
readAccessType?: string;
|
|
1083
1083
|
}
|
|
1084
1084
|
interface Schemas {
|
|
@@ -1136,7 +1136,7 @@ declare namespace gapi.client {
|
|
|
1136
1136
|
changePasswordAtNextLogin?: boolean;
|
|
1137
1137
|
/** User's G Suite account creation time. (Read-only) */
|
|
1138
1138
|
creationTime?: string;
|
|
1139
|
-
/** Output only. The customer ID to [retrieve all account users](/admin
|
|
1139
|
+
/** Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request. */
|
|
1140
1140
|
customerId?: string;
|
|
1141
1141
|
/** Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`. */
|
|
1142
1142
|
customSchemas?: {[P in string]: UserCustomProperties};
|
|
@@ -1159,7 +1159,7 @@ declare namespace gapi.client {
|
|
|
1159
1159
|
includeInGlobalAddressList?: boolean;
|
|
1160
1160
|
/** If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration. */
|
|
1161
1161
|
ipWhitelisted?: boolean;
|
|
1162
|
-
/** Output only. Indicates a user with super
|
|
1162
|
+
/** Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service. */
|
|
1163
1163
|
isAdmin?: boolean;
|
|
1164
1164
|
/** Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325). */
|
|
1165
1165
|
isDelegatedAdmin?: boolean;
|
|
@@ -2097,7 +2097,7 @@ declare namespace gapi.client {
|
|
|
2097
2097
|
key?: string;
|
|
2098
2098
|
/** OAuth 2.0 token for the current user. */
|
|
2099
2099
|
oauth_token?: string;
|
|
2100
|
-
/** Required. The [unique ID](https://developers.google.com/admin
|
|
2100
|
+
/** Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` */
|
|
2101
2101
|
parent: string;
|
|
2102
2102
|
/** Returns response with indentations and line breaks. */
|
|
2103
2103
|
prettyPrint?: boolean;
|
|
@@ -2126,7 +2126,7 @@ declare namespace gapi.client {
|
|
|
2126
2126
|
key?: string;
|
|
2127
2127
|
/** OAuth 2.0 token for the current user. */
|
|
2128
2128
|
oauth_token?: string;
|
|
2129
|
-
/** Required. The [unique ID](https://developers.google.com/admin
|
|
2129
|
+
/** Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` */
|
|
2130
2130
|
parent: string;
|
|
2131
2131
|
/** Returns response with indentations and line breaks. */
|
|
2132
2132
|
prettyPrint?: boolean;
|
|
@@ -2155,7 +2155,7 @@ declare namespace gapi.client {
|
|
|
2155
2155
|
key?: string;
|
|
2156
2156
|
/** OAuth 2.0 token for the current user. */
|
|
2157
2157
|
oauth_token?: string;
|
|
2158
|
-
/** Required. The [unique ID](https://developers.google.com/admin
|
|
2158
|
+
/** Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{customer.id}` */
|
|
2159
2159
|
parent: string;
|
|
2160
2160
|
/** Returns response with indentations and line breaks. */
|
|
2161
2161
|
prettyPrint?: boolean;
|
|
@@ -2184,7 +2184,7 @@ declare namespace gapi.client {
|
|
|
2184
2184
|
key?: string;
|
|
2185
2185
|
/** OAuth 2.0 token for the current user. */
|
|
2186
2186
|
oauth_token?: string;
|
|
2187
|
-
/** Required. The [unique ID](https://developers.google.com/admin
|
|
2187
|
+
/** Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{customer.id}` */
|
|
2188
2188
|
parent: string;
|
|
2189
2189
|
/** Returns response with indentations and line breaks. */
|
|
2190
2190
|
prettyPrint?: boolean;
|
|
@@ -2213,7 +2213,7 @@ declare namespace gapi.client {
|
|
|
2213
2213
|
key?: string;
|
|
2214
2214
|
/** OAuth 2.0 token for the current user. */
|
|
2215
2215
|
oauth_token?: string;
|
|
2216
|
-
/** Required. The [unique ID](https://developers.google.com/admin
|
|
2216
|
+
/** Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` */
|
|
2217
2217
|
parent: string;
|
|
2218
2218
|
/** Returns response with indentations and line breaks. */
|
|
2219
2219
|
prettyPrint?: boolean;
|
|
@@ -2242,7 +2242,7 @@ declare namespace gapi.client {
|
|
|
2242
2242
|
key?: string;
|
|
2243
2243
|
/** OAuth 2.0 token for the current user. */
|
|
2244
2244
|
oauth_token?: string;
|
|
2245
|
-
/** Required. The [unique ID](https://developers.google.com/admin
|
|
2245
|
+
/** Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` */
|
|
2246
2246
|
parent: string;
|
|
2247
2247
|
/** Returns response with indentations and line breaks. */
|
|
2248
2248
|
prettyPrint?: boolean;
|
|
@@ -2296,7 +2296,7 @@ declare namespace gapi.client {
|
|
|
2296
2296
|
fields?: string;
|
|
2297
2297
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2298
2298
|
key?: string;
|
|
2299
|
-
/** Required. The [unique ID](https://developers.google.com/admin
|
|
2299
|
+
/** Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` */
|
|
2300
2300
|
name: string;
|
|
2301
2301
|
/** OAuth 2.0 token for the current user. */
|
|
2302
2302
|
oauth_token?: string;
|
|
@@ -2335,7 +2335,7 @@ declare namespace gapi.client {
|
|
|
2335
2335
|
pageSize?: number;
|
|
2336
2336
|
/** A generated token to paginate results (the `next_page_token` from a previous call). */
|
|
2337
2337
|
pageToken?: string;
|
|
2338
|
-
/** Required. The [unique ID](https://developers.google.com/admin
|
|
2338
|
+
/** Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` */
|
|
2339
2339
|
parent: string;
|
|
2340
2340
|
/** Returns response with indentations and line breaks. */
|
|
2341
2341
|
prettyPrint?: boolean;
|
|
@@ -2789,17 +2789,17 @@ declare namespace gapi.client {
|
|
|
2789
2789
|
macAddress?: string;
|
|
2790
2790
|
/** (Read-only) The date the device was manufactured in yyyy-mm-dd format. */
|
|
2791
2791
|
manufactureDate?: string;
|
|
2792
|
-
/** The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](/admin
|
|
2792
|
+
/** The Mobile Equipment Identifier (MEID) or the International Mobile Equipment Identity (IMEI) for the 3G mobile card in a mobile device. A MEID/IMEI is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response. For more information on how to export a MEID/IMEI list, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices.html#export_meid). */
|
|
2793
2793
|
meid?: string;
|
|
2794
2794
|
/** The device's model information. If the device does not have this information, this property is not included in the response. */
|
|
2795
2795
|
model?: string;
|
|
2796
|
-
/** Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](/admin
|
|
2796
|
+
/** Notes about this device added by the administrator. This property can be [searched](https://support.google.com/chrome/a/answer/1698333) with the [list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method's `query` parameter. Maximum length is 500 characters. Empty values are allowed. */
|
|
2797
2797
|
notes?: string;
|
|
2798
2798
|
/** The device's order number. Only devices directly purchased from Google have an order number. */
|
|
2799
2799
|
orderNumber?: string;
|
|
2800
|
-
/** The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](/admin
|
|
2800
|
+
/** The unique ID of the organizational unit. orgUnitPath is the human readable version of orgUnitId. While orgUnitPath may change by renaming an organizational unit within the path, orgUnitId is unchangeable for one organizational unit. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). */
|
|
2801
2801
|
orgUnitId?: string;
|
|
2802
|
-
/** The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](/admin
|
|
2802
|
+
/** The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, `/`. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/guides/manage-chrome-devices#move_chrome_devices_to_ou) using the API. For more information about how to create an organizational structure for your device, see the [administration help center](https://support.google.com/a/answer/182433). */
|
|
2803
2803
|
orgUnitPath?: string;
|
|
2804
2804
|
/** The status of the OS updates for the device. */
|
|
2805
2805
|
osUpdateStatus?: OsUpdateStatus;
|
|
@@ -2884,9 +2884,9 @@ declare namespace gapi.client {
|
|
|
2884
2884
|
printer?: Printer;
|
|
2885
2885
|
}
|
|
2886
2886
|
interface CreatePrintServerRequest {
|
|
2887
|
-
/** Required. The [unique ID](https://developers.google.com/admin
|
|
2887
|
+
/** Required. The [unique ID](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customers) of the customer's Google Workspace account. Format: `customers/{id}` */
|
|
2888
2888
|
parent?: string;
|
|
2889
|
-
/** Required. A print server to create. If you want to place the print server under a specific organizational unit (OU), then populate the `org_unit_id`. Otherwise the print server is created under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/admin
|
|
2889
|
+
/** Required. A print server to create. If you want to place the print server under a specific organizational unit (OU), then populate the `org_unit_id`. Otherwise the print server is created under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units). */
|
|
2890
2890
|
printServer?: PrintServer;
|
|
2891
2891
|
}
|
|
2892
2892
|
interface Customer {
|
|
@@ -2902,7 +2902,7 @@ declare namespace gapi.client {
|
|
|
2902
2902
|
id?: string;
|
|
2903
2903
|
/** Identifies the resource as a customer. Value: `admin#directory#customer` */
|
|
2904
2904
|
kind?: string;
|
|
2905
|
-
/** The customer's ISO 639-2 language code. See the [Language Codes](/admin
|
|
2905
|
+
/** The customer's ISO 639-2 language code. See the [Language Codes](https://developers.google.com/workspace/admin/directory/v1/languages) page for the list of supported codes. Valid language codes outside the supported set will be accepted by the API but may lead to unexpected behavior. The default value is `en`. */
|
|
2906
2906
|
language?: string;
|
|
2907
2907
|
/** The customer's contact phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. */
|
|
2908
2908
|
phoneNumber?: string;
|
|
@@ -3180,7 +3180,7 @@ declare namespace gapi.client {
|
|
|
3180
3180
|
deviceId?: string;
|
|
3181
3181
|
/** DevicePasswordStatus (Read-only) */
|
|
3182
3182
|
devicePasswordStatus?: string;
|
|
3183
|
-
/** The list of the owner's email addresses. If your application needs the current list of user emails, use the [get](/admin
|
|
3183
|
+
/** The list of the owner's email addresses. If your application needs the current list of user emails, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For additional information, see the [retrieve a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user) method. */
|
|
3184
3184
|
email?: string[];
|
|
3185
3185
|
/** Mobile Device Encryption Status (Read-only) */
|
|
3186
3186
|
encryptionStatus?: string;
|
|
@@ -3206,13 +3206,13 @@ declare namespace gapi.client {
|
|
|
3206
3206
|
manufacturer?: string;
|
|
3207
3207
|
/** The device's MEID number. */
|
|
3208
3208
|
meid?: string;
|
|
3209
|
-
/** The mobile device's model name, for example Nexus S. This property can be [updated](/admin
|
|
3209
|
+
/** The mobile device's model name, for example Nexus S. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile=devices#update_mobile_device). */
|
|
3210
3210
|
model?: string;
|
|
3211
|
-
/** The list of the owner's user names. If your application needs the current list of device owner names, use the [get](/admin
|
|
3211
|
+
/** The list of the owner's user names. If your application needs the current list of device owner names, use the [get](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/get.html) method. For more information about retrieving mobile device user information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#get_user). */
|
|
3212
3212
|
name?: string[];
|
|
3213
3213
|
/** Mobile Device mobile or network operator (if available) (Read-only) */
|
|
3214
3214
|
networkOperator?: string;
|
|
3215
|
-
/** The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](/admin
|
|
3215
|
+
/** The mobile device's operating system, for example IOS 4.3 or Android 2.3.5. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device). */
|
|
3216
3216
|
os?: string;
|
|
3217
3217
|
/** The list of accounts added on device (Read-only) */
|
|
3218
3218
|
otherAccountsInfo?: string[];
|
|
@@ -3234,7 +3234,7 @@ declare namespace gapi.client {
|
|
|
3234
3234
|
type?: string;
|
|
3235
3235
|
/** Unknown sources enabled or disabled on device (Read-only) */
|
|
3236
3236
|
unknownSourcesStatus?: boolean;
|
|
3237
|
-
/** Gives information about the device such as `os` version. This property can be [updated](/admin
|
|
3237
|
+
/** Gives information about the device such as `os` version. This property can be [updated](https://developers.google.com/workspace/admin/directory/v1/reference/mobiledevices/update.html). For more information, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-mobile-devices#update_mobile_device). */
|
|
3238
3238
|
userAgent?: string;
|
|
3239
3239
|
/** The device's MAC address on Wi-Fi networks. */
|
|
3240
3240
|
wifiMacAddress?: string;
|
|
@@ -3266,7 +3266,7 @@ declare namespace gapi.client {
|
|
|
3266
3266
|
name?: string;
|
|
3267
3267
|
/** The unique ID of the organizational unit. */
|
|
3268
3268
|
orgUnitId?: string;
|
|
3269
|
-
/** The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin
|
|
3269
|
+
/** The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user). */
|
|
3270
3270
|
orgUnitPath?: string;
|
|
3271
3271
|
/** The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set. */
|
|
3272
3272
|
parentOrgUnitId?: string;
|
|
@@ -3336,7 +3336,7 @@ declare namespace gapi.client {
|
|
|
3336
3336
|
id?: string;
|
|
3337
3337
|
/** Identifier. Resource name of the print server. Leave empty when creating. Format: `customers/{customer.id}/printServers/{print_server.id}` */
|
|
3338
3338
|
name?: string;
|
|
3339
|
-
/** ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](/admin
|
|
3339
|
+
/** ID of the organization unit (OU) that owns this print server. This value can only be set when the print server is initially created. If it's not populated, the print server is placed under the root OU. The `org_unit_id` can be retrieved using the [Directory API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/orgunits). */
|
|
3340
3340
|
orgUnitId?: string;
|
|
3341
3341
|
/** Editable. Print server URI. */
|
|
3342
3342
|
uri?: string;
|
|
@@ -3362,7 +3362,7 @@ declare namespace gapi.client {
|
|
|
3362
3362
|
kind?: string;
|
|
3363
3363
|
/** The name of the privilege. */
|
|
3364
3364
|
privilegeName?: string;
|
|
3365
|
-
/** The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin
|
|
3365
|
+
/** The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list). */
|
|
3366
3366
|
serviceId?: string;
|
|
3367
3367
|
/** The name of the service this privilege is for. */
|
|
3368
3368
|
serviceName?: string;
|
|
@@ -3394,7 +3394,7 @@ declare namespace gapi.client {
|
|
|
3394
3394
|
rolePrivileges?: Array<{
|
|
3395
3395
|
/** The name of the privilege. */
|
|
3396
3396
|
privilegeName?: string;
|
|
3397
|
-
/** The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin
|
|
3397
|
+
/** The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list). */
|
|
3398
3398
|
serviceId?: string;
|
|
3399
3399
|
}>;
|
|
3400
3400
|
}
|
|
@@ -3403,7 +3403,7 @@ declare namespace gapi.client {
|
|
|
3403
3403
|
assignedTo?: string;
|
|
3404
3404
|
/** Output only. The type of the assignee (`USER` or `GROUP`). */
|
|
3405
3405
|
assigneeType?: string;
|
|
3406
|
-
/** Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview).
|
|
3406
|
+
/** Optional. The condition associated with this role assignment. Note: Feature is available to Enterprise Standard, Enterprise Plus, Google Workspace for Education Plus and Cloud Identity Premium customers. A `RoleAssignment` with the `condition` field set will only take effect when the resource being accessed meets the condition. If `condition` is empty, the role (`role_id`) is applied to the actor (`assigned_to`) at the scope (`scope_type`) unconditionally. Currently, the following conditions are supported: - To make the `RoleAssignment` only applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` - To make the `RoleAssignment` not applicable to [Security Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.security']) && resource.type == 'cloudidentity.googleapis.com/Group'` Currently, the condition strings have to be verbatim and they only work with the following [pre-built administrator roles](https://support.google.com/a/answer/2405986): - Groups Editor - Groups Reader The condition follows [Cloud IAM condition syntax](https://cloud.google.com/iam/docs/conditions-overview). - To make the `RoleAssignment` not applicable to [Locked Groups](https://cloud.google.com/identity/docs/groups#group_types): `!api.getAttribute('cloudidentity.googleapis.com/groups.labels', []).hasAny(['groups.locked']) && resource.type == 'cloudidentity.googleapis.com/Group'` This condition can also be used in conjunction with a Security-related condition. */
|
|
3407
3407
|
condition?: string;
|
|
3408
3408
|
/** ETag of the resource. */
|
|
3409
3409
|
etag?: string;
|
|
@@ -3474,7 +3474,7 @@ declare namespace gapi.client {
|
|
|
3474
3474
|
/** Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant. */
|
|
3475
3475
|
minValue?: number;
|
|
3476
3476
|
};
|
|
3477
|
-
/** Specifies who can view values of this field. See [Retrieve users as a non-administrator](/admin
|
|
3477
|
+
/** Specifies who can view values of this field. See [Retrieve users as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin) for more information. Note: It may take up to 24 hours for changes to this field to be reflected. */
|
|
3478
3478
|
readAccessType?: string;
|
|
3479
3479
|
}
|
|
3480
3480
|
interface Schemas {
|
|
@@ -3532,7 +3532,7 @@ declare namespace gapi.client {
|
|
|
3532
3532
|
changePasswordAtNextLogin?: boolean;
|
|
3533
3533
|
/** User's G Suite account creation time. (Read-only) */
|
|
3534
3534
|
creationTime?: string;
|
|
3535
|
-
/** Output only. The customer ID to [retrieve all account users](/admin
|
|
3535
|
+
/** Output only. The customer ID to [retrieve all account users](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#get_all_users). You can use the alias `my_customer` to represent your account's `customerId`. As a reseller administrator, you can use the resold customer account's `customerId`. To get a `customerId`, use the account's primary domain in the `domain` parameter of a [users.list](https://developers.google.com/workspace/admin/directory/v1/reference/users/list) request. */
|
|
3536
3536
|
customerId?: string;
|
|
3537
3537
|
/** Custom fields of the user. The key is a `schema_name` and its values are `'field_name': 'field_value'`. */
|
|
3538
3538
|
customSchemas?: {[P in string]: UserCustomProperties};
|
|
@@ -3555,7 +3555,7 @@ declare namespace gapi.client {
|
|
|
3555
3555
|
includeInGlobalAddressList?: boolean;
|
|
3556
3556
|
/** If `true`, the user's IP address is subject to a deprecated IP address [`allowlist`](https://support.google.com/a/answer/60752) configuration. */
|
|
3557
3557
|
ipWhitelisted?: boolean;
|
|
3558
|
-
/** Output only. Indicates a user with super
|
|
3558
|
+
/** Output only. Indicates a user with super administrator privileges. The `isAdmin` property can only be edited in the [Make a user an administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#make_admin) operation ( [makeAdmin](https://developers.google.com/workspace/admin/directory/v1/reference/users/makeAdmin.html) method). If edited in the user [insert](https://developers.google.com/workspace/admin/directory/v1/reference/users/insert.html) or [update](https://developers.google.com/workspace/admin/directory/v1/reference/users/update.html) methods, the edit is ignored by the API service. */
|
|
3559
3559
|
isAdmin?: boolean;
|
|
3560
3560
|
/** Output only. Indicates if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the [Admin console](https://support.google.com/a/answer/33325). */
|
|
3561
3561
|
isDelegatedAdmin?: boolean;
|
|
@@ -3980,7 +3980,7 @@ declare namespace gapi.client {
|
|
|
3980
3980
|
}): Request<Asps>;
|
|
3981
3981
|
}
|
|
3982
3982
|
interface ChromeosdevicesResource {
|
|
3983
|
-
/** Use [BatchChangeChromeOsDeviceStatus](/admin
|
|
3983
|
+
/** Use [BatchChangeChromeOsDeviceStatus](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customer.devices.chromeos/batchChangeStatus) instead. Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the [help center](https://support.google.com/chrome/a/answer/3523633). */
|
|
3984
3984
|
action(request: {
|
|
3985
3985
|
/** V1 error format. */
|
|
3986
3986
|
'$.xgafv'?: string;
|
|
@@ -3990,7 +3990,7 @@ declare namespace gapi.client {
|
|
|
3990
3990
|
alt?: string;
|
|
3991
3991
|
/** JSONP */
|
|
3992
3992
|
callback?: string;
|
|
3993
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
3993
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
3994
3994
|
customerId: string;
|
|
3995
3995
|
/** Selector specifying which fields to include in a partial response. */
|
|
3996
3996
|
fields?: string;
|
|
@@ -4002,7 +4002,7 @@ declare namespace gapi.client {
|
|
|
4002
4002
|
prettyPrint?: boolean;
|
|
4003
4003
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4004
4004
|
quotaUser?: string;
|
|
4005
|
-
/** The unique ID of the device. The `resourceId`s are returned in the response from the [chromeosdevices.list](/admin
|
|
4005
|
+
/** The unique ID of the device. The `resourceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method. */
|
|
4006
4006
|
resourceId: string;
|
|
4007
4007
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4008
4008
|
upload_protocol?: string;
|
|
@@ -4021,7 +4021,7 @@ declare namespace gapi.client {
|
|
|
4021
4021
|
alt?: string;
|
|
4022
4022
|
/** JSONP */
|
|
4023
4023
|
callback?: string;
|
|
4024
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
4024
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
4025
4025
|
customerId: string;
|
|
4026
4026
|
/** Selector specifying which fields to include in a partial response. */
|
|
4027
4027
|
fields?: string;
|
|
@@ -4033,7 +4033,7 @@ declare namespace gapi.client {
|
|
|
4033
4033
|
prettyPrint?: boolean;
|
|
4034
4034
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4035
4035
|
quotaUser?: string;
|
|
4036
|
-
/** The unique ID of the device. The `resourceId`s are returned in the response from the [chromeosdevices.list](/admin
|
|
4036
|
+
/** The unique ID of the device. The `resourceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method. */
|
|
4037
4037
|
resourceId: string;
|
|
4038
4038
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4039
4039
|
upload_protocol?: string;
|
|
@@ -4052,9 +4052,9 @@ declare namespace gapi.client {
|
|
|
4052
4052
|
alt?: string;
|
|
4053
4053
|
/** JSONP */
|
|
4054
4054
|
callback?: string;
|
|
4055
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
4055
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
4056
4056
|
customerId: string;
|
|
4057
|
-
/** The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin
|
|
4057
|
+
/** The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/directory/v1/reference/chromeosdevices/list) method. */
|
|
4058
4058
|
deviceId: string;
|
|
4059
4059
|
/** Selector specifying which fields to include in a partial response. */
|
|
4060
4060
|
fields?: string;
|
|
@@ -4083,7 +4083,7 @@ declare namespace gapi.client {
|
|
|
4083
4083
|
alt?: string;
|
|
4084
4084
|
/** JSONP */
|
|
4085
4085
|
callback?: string;
|
|
4086
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
4086
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
4087
4087
|
customerId: string;
|
|
4088
4088
|
/** Selector specifying which fields to include in a partial response. */
|
|
4089
4089
|
fields?: string;
|
|
@@ -4105,7 +4105,7 @@ declare namespace gapi.client {
|
|
|
4105
4105
|
prettyPrint?: boolean;
|
|
4106
4106
|
/** Determines whether the response contains the full list of properties or only a subset. */
|
|
4107
4107
|
projection?: string;
|
|
4108
|
-
/** Search string in the format given at https://developers.google.com/admin
|
|
4108
|
+
/** Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/list-query-operators */
|
|
4109
4109
|
query?: string;
|
|
4110
4110
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
4111
4111
|
quotaUser?: string;
|
|
@@ -4178,7 +4178,7 @@ declare namespace gapi.client {
|
|
|
4178
4178
|
},
|
|
4179
4179
|
body: ChromeOsMoveDevicesToOu,
|
|
4180
4180
|
): Request<void>;
|
|
4181
|
-
/** Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](/admin
|
|
4181
|
+
/** Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch). */
|
|
4182
4182
|
patch(request: {
|
|
4183
4183
|
/** V1 error format. */
|
|
4184
4184
|
'$.xgafv'?: string;
|
|
@@ -4188,9 +4188,9 @@ declare namespace gapi.client {
|
|
|
4188
4188
|
alt?: string;
|
|
4189
4189
|
/** JSONP */
|
|
4190
4190
|
callback?: string;
|
|
4191
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
4191
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
4192
4192
|
customerId: string;
|
|
4193
|
-
/** The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin
|
|
4193
|
+
/** The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/v1/reference/chromeosdevices/list) method. */
|
|
4194
4194
|
deviceId: string;
|
|
4195
4195
|
/** Selector specifying which fields to include in a partial response. */
|
|
4196
4196
|
fields?: string;
|
|
@@ -4221,9 +4221,9 @@ declare namespace gapi.client {
|
|
|
4221
4221
|
alt?: string;
|
|
4222
4222
|
/** JSONP */
|
|
4223
4223
|
callback?: string;
|
|
4224
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
4224
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
4225
4225
|
customerId: string;
|
|
4226
|
-
/** The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin
|
|
4226
|
+
/** The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/v1/reference/chromeosdevices/list) method. */
|
|
4227
4227
|
deviceId: string;
|
|
4228
4228
|
/** Selector specifying which fields to include in a partial response. */
|
|
4229
4229
|
fields?: string;
|
|
@@ -4254,9 +4254,9 @@ declare namespace gapi.client {
|
|
|
4254
4254
|
alt?: string;
|
|
4255
4255
|
/** JSONP */
|
|
4256
4256
|
callback?: string;
|
|
4257
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
4257
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
4258
4258
|
customerId: string;
|
|
4259
|
-
/** The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin
|
|
4259
|
+
/** The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/v1/reference/chromeosdevices/list) method. */
|
|
4260
4260
|
deviceId: string;
|
|
4261
4261
|
/** Selector specifying which fields to include in a partial response. */
|
|
4262
4262
|
fields?: string;
|
|
@@ -4287,9 +4287,9 @@ declare namespace gapi.client {
|
|
|
4287
4287
|
alt?: string;
|
|
4288
4288
|
/** JSONP */
|
|
4289
4289
|
callback?: string;
|
|
4290
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
4290
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
4291
4291
|
customerId: string;
|
|
4292
|
-
/** The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](/admin
|
|
4292
|
+
/** The unique ID of the device. The `deviceId`s are returned in the response from the [chromeosdevices.list](https://developers.google.com/workspace/admin/v1/reference/chromeosdevices/list) method. */
|
|
4293
4293
|
deviceId: string;
|
|
4294
4294
|
/** Selector specifying which fields to include in a partial response. */
|
|
4295
4295
|
fields?: string;
|
|
@@ -4496,7 +4496,7 @@ declare namespace gapi.client {
|
|
|
4496
4496
|
alt?: string;
|
|
4497
4497
|
/** JSONP */
|
|
4498
4498
|
callback?: string;
|
|
4499
|
-
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin
|
|
4499
|
+
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. */
|
|
4500
4500
|
customer: string;
|
|
4501
4501
|
/** Name of domain alias to be retrieved. */
|
|
4502
4502
|
domainAliasName: string;
|
|
@@ -4583,7 +4583,7 @@ declare namespace gapi.client {
|
|
|
4583
4583
|
alt?: string;
|
|
4584
4584
|
/** JSONP */
|
|
4585
4585
|
callback?: string;
|
|
4586
|
-
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin
|
|
4586
|
+
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. */
|
|
4587
4587
|
customer: string;
|
|
4588
4588
|
/** Selector specifying which fields to include in a partial response. */
|
|
4589
4589
|
fields?: string;
|
|
@@ -4643,7 +4643,7 @@ declare namespace gapi.client {
|
|
|
4643
4643
|
alt?: string;
|
|
4644
4644
|
/** JSONP */
|
|
4645
4645
|
callback?: string;
|
|
4646
|
-
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin
|
|
4646
|
+
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. */
|
|
4647
4647
|
customer: string;
|
|
4648
4648
|
/** Name of domain to be retrieved */
|
|
4649
4649
|
domainName: string;
|
|
@@ -4730,7 +4730,7 @@ declare namespace gapi.client {
|
|
|
4730
4730
|
alt?: string;
|
|
4731
4731
|
/** JSONP */
|
|
4732
4732
|
callback?: string;
|
|
4733
|
-
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin
|
|
4733
|
+
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. */
|
|
4734
4734
|
customer: string;
|
|
4735
4735
|
/** Selector specifying which fields to include in a partial response. */
|
|
4736
4736
|
fields?: string;
|
|
@@ -4983,7 +4983,7 @@ declare namespace gapi.client {
|
|
|
4983
4983
|
alt?: string;
|
|
4984
4984
|
/** JSONP */
|
|
4985
4985
|
callback?: string;
|
|
4986
|
-
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin
|
|
4986
|
+
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. */
|
|
4987
4987
|
customer?: string;
|
|
4988
4988
|
/** The domain name. Use this field to get groups from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. */
|
|
4989
4989
|
domain?: string;
|
|
@@ -5014,7 +5014,7 @@ declare namespace gapi.client {
|
|
|
5014
5014
|
/** Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object. Cannot be used with the `customer` parameter. */
|
|
5015
5015
|
userKey?: string;
|
|
5016
5016
|
}): Request<Groups>;
|
|
5017
|
-
/** Updates a group's properties. This method supports [patch semantics](/admin
|
|
5017
|
+
/** Updates a group's properties. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch). */
|
|
5018
5018
|
patch(request: {
|
|
5019
5019
|
/** V1 error format. */
|
|
5020
5020
|
'$.xgafv'?: string;
|
|
@@ -5278,7 +5278,7 @@ declare namespace gapi.client {
|
|
|
5278
5278
|
},
|
|
5279
5279
|
body: Member,
|
|
5280
5280
|
): Request<Member>;
|
|
5281
|
-
/** Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/admin
|
|
5281
|
+
/** Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes). */
|
|
5282
5282
|
list(request?: {
|
|
5283
5283
|
/** V1 error format. */
|
|
5284
5284
|
'$.xgafv'?: string;
|
|
@@ -5313,7 +5313,7 @@ declare namespace gapi.client {
|
|
|
5313
5313
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5314
5314
|
uploadType?: string;
|
|
5315
5315
|
}): Request<Members>;
|
|
5316
|
-
/** Updates the membership properties of a user in the specified group. This method supports [patch semantics](/admin
|
|
5316
|
+
/** Updates the membership properties of a user in the specified group. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch). */
|
|
5317
5317
|
patch(request: {
|
|
5318
5318
|
/** V1 error format. */
|
|
5319
5319
|
'$.xgafv'?: string;
|
|
@@ -5449,7 +5449,7 @@ declare namespace gapi.client {
|
|
|
5449
5449
|
alt?: string;
|
|
5450
5450
|
/** JSONP */
|
|
5451
5451
|
callback?: string;
|
|
5452
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
5452
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
5453
5453
|
customerId: string;
|
|
5454
5454
|
/** Selector specifying which fields to include in a partial response. */
|
|
5455
5455
|
fields?: string;
|
|
@@ -5480,7 +5480,7 @@ declare namespace gapi.client {
|
|
|
5480
5480
|
alt?: string;
|
|
5481
5481
|
/** JSONP */
|
|
5482
5482
|
callback?: string;
|
|
5483
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
5483
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
5484
5484
|
customerId: string;
|
|
5485
5485
|
/** Selector specifying which fields to include in a partial response. */
|
|
5486
5486
|
fields?: string;
|
|
@@ -5511,7 +5511,7 @@ declare namespace gapi.client {
|
|
|
5511
5511
|
alt?: string;
|
|
5512
5512
|
/** JSONP */
|
|
5513
5513
|
callback?: string;
|
|
5514
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
5514
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
5515
5515
|
customerId: string;
|
|
5516
5516
|
/** Selector specifying which fields to include in a partial response. */
|
|
5517
5517
|
fields?: string;
|
|
@@ -5540,7 +5540,7 @@ declare namespace gapi.client {
|
|
|
5540
5540
|
alt?: string;
|
|
5541
5541
|
/** JSONP */
|
|
5542
5542
|
callback?: string;
|
|
5543
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
5543
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
5544
5544
|
customerId: string;
|
|
5545
5545
|
/** Selector specifying which fields to include in a partial response. */
|
|
5546
5546
|
fields?: string;
|
|
@@ -5561,7 +5561,7 @@ declare namespace gapi.client {
|
|
|
5561
5561
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5562
5562
|
uploadType?: string;
|
|
5563
5563
|
}): Request<MobileDevice>;
|
|
5564
|
-
/** Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/admin
|
|
5564
|
+
/** Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes). */
|
|
5565
5565
|
list(request?: {
|
|
5566
5566
|
/** V1 error format. */
|
|
5567
5567
|
'$.xgafv'?: string;
|
|
@@ -5571,7 +5571,7 @@ declare namespace gapi.client {
|
|
|
5571
5571
|
alt?: string;
|
|
5572
5572
|
/** JSONP */
|
|
5573
5573
|
callback?: string;
|
|
5574
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
5574
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
5575
5575
|
customerId: string;
|
|
5576
5576
|
/** Selector specifying which fields to include in a partial response. */
|
|
5577
5577
|
fields?: string;
|
|
@@ -5589,7 +5589,7 @@ declare namespace gapi.client {
|
|
|
5589
5589
|
prettyPrint?: boolean;
|
|
5590
5590
|
/** Restrict information returned to a set of selected fields. */
|
|
5591
5591
|
projection?: string;
|
|
5592
|
-
/** Search string in the format given at https://developers.google.com/admin
|
|
5592
|
+
/** Search string in the format given at https://developers.google.com/workspace/admin/directory/v1/search-operators */
|
|
5593
5593
|
query?: string;
|
|
5594
5594
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
5595
5595
|
quotaUser?: string;
|
|
@@ -5612,7 +5612,7 @@ declare namespace gapi.client {
|
|
|
5612
5612
|
alt?: string;
|
|
5613
5613
|
/** JSONP */
|
|
5614
5614
|
callback?: string;
|
|
5615
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
5615
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
5616
5616
|
customerId: string;
|
|
5617
5617
|
/** Selector specifying which fields to include in a partial response. */
|
|
5618
5618
|
fields?: string;
|
|
@@ -5641,7 +5641,7 @@ declare namespace gapi.client {
|
|
|
5641
5641
|
alt?: string;
|
|
5642
5642
|
/** JSONP */
|
|
5643
5643
|
callback?: string;
|
|
5644
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
5644
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
5645
5645
|
customerId: string;
|
|
5646
5646
|
/** Selector specifying which fields to include in a partial response. */
|
|
5647
5647
|
fields?: string;
|
|
@@ -5670,7 +5670,7 @@ declare namespace gapi.client {
|
|
|
5670
5670
|
alt?: string;
|
|
5671
5671
|
/** JSONP */
|
|
5672
5672
|
callback?: string;
|
|
5673
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
5673
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
5674
5674
|
customerId: string;
|
|
5675
5675
|
/** Selector specifying which fields to include in a partial response. */
|
|
5676
5676
|
fields?: string;
|
|
@@ -5699,7 +5699,7 @@ declare namespace gapi.client {
|
|
|
5699
5699
|
alt?: string;
|
|
5700
5700
|
/** JSONP */
|
|
5701
5701
|
callback?: string;
|
|
5702
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
5702
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
5703
5703
|
customerId: string;
|
|
5704
5704
|
/** Selector specifying which fields to include in a partial response. */
|
|
5705
5705
|
fields?: string;
|
|
@@ -5728,7 +5728,7 @@ declare namespace gapi.client {
|
|
|
5728
5728
|
alt?: string;
|
|
5729
5729
|
/** JSONP */
|
|
5730
5730
|
callback?: string;
|
|
5731
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
5731
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
5732
5732
|
customerId: string;
|
|
5733
5733
|
/** Selector specifying which fields to include in a partial response. */
|
|
5734
5734
|
fields?: string;
|
|
@@ -5749,7 +5749,7 @@ declare namespace gapi.client {
|
|
|
5749
5749
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5750
5750
|
uploadType?: string;
|
|
5751
5751
|
}): Request<OrgUnits>;
|
|
5752
|
-
/** Updates an organizational unit. This method supports [patch semantics](/admin
|
|
5752
|
+
/** Updates an organizational unit. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch) */
|
|
5753
5753
|
patch(request: {
|
|
5754
5754
|
/** V1 error format. */
|
|
5755
5755
|
'$.xgafv'?: string;
|
|
@@ -5759,7 +5759,7 @@ declare namespace gapi.client {
|
|
|
5759
5759
|
alt?: string;
|
|
5760
5760
|
/** JSONP */
|
|
5761
5761
|
callback?: string;
|
|
5762
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
5762
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
5763
5763
|
customerId: string;
|
|
5764
5764
|
/** Selector specifying which fields to include in a partial response. */
|
|
5765
5765
|
fields?: string;
|
|
@@ -5790,7 +5790,7 @@ declare namespace gapi.client {
|
|
|
5790
5790
|
alt?: string;
|
|
5791
5791
|
/** JSONP */
|
|
5792
5792
|
callback?: string;
|
|
5793
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
5793
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
5794
5794
|
customerId: string;
|
|
5795
5795
|
/** Selector specifying which fields to include in a partial response. */
|
|
5796
5796
|
fields?: string;
|
|
@@ -5821,7 +5821,7 @@ declare namespace gapi.client {
|
|
|
5821
5821
|
alt?: string;
|
|
5822
5822
|
/** JSONP */
|
|
5823
5823
|
callback?: string;
|
|
5824
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
5824
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
5825
5825
|
customerId: string;
|
|
5826
5826
|
/** Selector specifying which fields to include in a partial response. */
|
|
5827
5827
|
fields?: string;
|
|
@@ -5852,7 +5852,7 @@ declare namespace gapi.client {
|
|
|
5852
5852
|
alt?: string;
|
|
5853
5853
|
/** JSONP */
|
|
5854
5854
|
callback?: string;
|
|
5855
|
-
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin
|
|
5855
|
+
/** The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). */
|
|
5856
5856
|
customerId: string;
|
|
5857
5857
|
/** Selector specifying which fields to include in a partial response. */
|
|
5858
5858
|
fields?: string;
|
|
@@ -5885,7 +5885,7 @@ declare namespace gapi.client {
|
|
|
5885
5885
|
alt?: string;
|
|
5886
5886
|
/** JSONP */
|
|
5887
5887
|
callback?: string;
|
|
5888
|
-
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin
|
|
5888
|
+
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. */
|
|
5889
5889
|
customer: string;
|
|
5890
5890
|
/** Selector specifying which fields to include in a partial response. */
|
|
5891
5891
|
fields?: string;
|
|
@@ -6845,7 +6845,7 @@ declare namespace gapi.client {
|
|
|
6845
6845
|
alt?: string;
|
|
6846
6846
|
/** JSONP */
|
|
6847
6847
|
callback?: string;
|
|
6848
|
-
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin
|
|
6848
|
+
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. */
|
|
6849
6849
|
customer: string;
|
|
6850
6850
|
/** Selector specifying which fields to include in a partial response. */
|
|
6851
6851
|
fields?: string;
|
|
@@ -6932,7 +6932,7 @@ declare namespace gapi.client {
|
|
|
6932
6932
|
alt?: string;
|
|
6933
6933
|
/** JSONP */
|
|
6934
6934
|
callback?: string;
|
|
6935
|
-
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin
|
|
6935
|
+
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. */
|
|
6936
6936
|
customer: string;
|
|
6937
6937
|
/** Selector specifying which fields to include in a partial response. */
|
|
6938
6938
|
fields?: string;
|
|
@@ -7000,7 +7000,7 @@ declare namespace gapi.client {
|
|
|
7000
7000
|
alt?: string;
|
|
7001
7001
|
/** JSONP */
|
|
7002
7002
|
callback?: string;
|
|
7003
|
-
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin
|
|
7003
|
+
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. */
|
|
7004
7004
|
customer: string;
|
|
7005
7005
|
/** Selector specifying which fields to include in a partial response. */
|
|
7006
7006
|
fields?: string;
|
|
@@ -7087,7 +7087,7 @@ declare namespace gapi.client {
|
|
|
7087
7087
|
alt?: string;
|
|
7088
7088
|
/** JSONP */
|
|
7089
7089
|
callback?: string;
|
|
7090
|
-
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin
|
|
7090
|
+
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. */
|
|
7091
7091
|
customer: string;
|
|
7092
7092
|
/** Selector specifying which fields to include in a partial response. */
|
|
7093
7093
|
fields?: string;
|
|
@@ -7273,7 +7273,7 @@ declare namespace gapi.client {
|
|
|
7273
7273
|
alt?: string;
|
|
7274
7274
|
/** JSONP */
|
|
7275
7275
|
callback?: string;
|
|
7276
|
-
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin
|
|
7276
|
+
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. */
|
|
7277
7277
|
customerId: string;
|
|
7278
7278
|
/** Selector specifying which fields to include in a partial response. */
|
|
7279
7279
|
fields?: string;
|
|
@@ -7360,7 +7360,7 @@ declare namespace gapi.client {
|
|
|
7360
7360
|
alt?: string;
|
|
7361
7361
|
/** JSONP */
|
|
7362
7362
|
callback?: string;
|
|
7363
|
-
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin
|
|
7363
|
+
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. */
|
|
7364
7364
|
customerId: string;
|
|
7365
7365
|
/** Selector specifying which fields to include in a partial response. */
|
|
7366
7366
|
fields?: string;
|
|
@@ -7853,7 +7853,7 @@ declare namespace gapi.client {
|
|
|
7853
7853
|
/** Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. */
|
|
7854
7854
|
userKey: string;
|
|
7855
7855
|
}): Request<UserPhoto>;
|
|
7856
|
-
/** Adds a photo for the user. This method supports [patch semantics](/admin
|
|
7856
|
+
/** Adds a photo for the user. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch). */
|
|
7857
7857
|
patch(request: {
|
|
7858
7858
|
/** V1 error format. */
|
|
7859
7859
|
'$.xgafv'?: string;
|
|
@@ -8028,7 +8028,7 @@ declare namespace gapi.client {
|
|
|
8028
8028
|
uploadType?: string;
|
|
8029
8029
|
/** Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. */
|
|
8030
8030
|
userKey: string;
|
|
8031
|
-
/** Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin
|
|
8031
|
+
/** Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin). */
|
|
8032
8032
|
viewType?: string;
|
|
8033
8033
|
}): Request<User>;
|
|
8034
8034
|
/** Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected. */
|
|
@@ -8099,7 +8099,7 @@ declare namespace gapi.client {
|
|
|
8099
8099
|
alt?: string;
|
|
8100
8100
|
/** JSONP */
|
|
8101
8101
|
callback?: string;
|
|
8102
|
-
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all users for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin
|
|
8102
|
+
/** The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all users for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. */
|
|
8103
8103
|
customer?: string;
|
|
8104
8104
|
/** A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`. */
|
|
8105
8105
|
customFieldMask?: string;
|
|
@@ -8123,7 +8123,7 @@ declare namespace gapi.client {
|
|
|
8123
8123
|
prettyPrint?: boolean;
|
|
8124
8124
|
/** What subset of fields to fetch for this user. */
|
|
8125
8125
|
projection?: string;
|
|
8126
|
-
/** Query string for searching user fields. For more information on constructing user queries, see [Search for Users](/admin
|
|
8126
|
+
/** Query string for searching user fields. For more information on constructing user queries, see [Search for Users](https://developers.google.com/workspace/admin/directory/v1/guides/search-users). */
|
|
8127
8127
|
query?: string;
|
|
8128
8128
|
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
8129
8129
|
quotaUser?: string;
|
|
@@ -8135,7 +8135,7 @@ declare namespace gapi.client {
|
|
|
8135
8135
|
upload_protocol?: string;
|
|
8136
8136
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8137
8137
|
uploadType?: string;
|
|
8138
|
-
/** Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin
|
|
8138
|
+
/** Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin). */
|
|
8139
8139
|
viewType?: string;
|
|
8140
8140
|
}): Request<Users>;
|
|
8141
8141
|
/** Makes a user a super administrator. */
|
|
@@ -8196,7 +8196,7 @@ declare namespace gapi.client {
|
|
|
8196
8196
|
},
|
|
8197
8197
|
body: UserMakeAdmin,
|
|
8198
8198
|
): Request<void>;
|
|
8199
|
-
/** Updates a user using patch semantics. The update method should be used instead, because it also supports patch semantics and has better performance. If you're mapping an external identity to a Google identity, use the [`update`](https://developers.google.com/admin
|
|
8199
|
+
/** Updates a user using patch semantics. The update method should be used instead, because it also supports patch semantics and has better performance. If you're mapping an external identity to a Google identity, use the [`update`](https://developers.google.com/workspace/admin/directory/v1/reference/users/update) method instead of the `patch` method. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead. */
|
|
8200
8200
|
patch(request: {
|
|
8201
8201
|
/** V1 error format. */
|
|
8202
8202
|
'$.xgafv'?: string;
|
|
@@ -8339,7 +8339,7 @@ declare namespace gapi.client {
|
|
|
8339
8339
|
},
|
|
8340
8340
|
body: UserUndelete,
|
|
8341
8341
|
): Request<void>;
|
|
8342
|
-
/** Updates a user. This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/admin
|
|
8342
|
+
/** Updates a user. This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#update_user) for more information. */
|
|
8343
8343
|
update(request: {
|
|
8344
8344
|
/** V1 error format. */
|
|
8345
8345
|
'$.xgafv'?: string;
|
|
@@ -8443,7 +8443,7 @@ declare namespace gapi.client {
|
|
|
8443
8443
|
upload_protocol?: string;
|
|
8444
8444
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8445
8445
|
uploadType?: string;
|
|
8446
|
-
/** Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin
|
|
8446
|
+
/** Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin). */
|
|
8447
8447
|
viewType?: string;
|
|
8448
8448
|
/** Request body */
|
|
8449
8449
|
resource: Channel;
|
|
@@ -8494,7 +8494,7 @@ declare namespace gapi.client {
|
|
|
8494
8494
|
upload_protocol?: string;
|
|
8495
8495
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8496
8496
|
uploadType?: string;
|
|
8497
|
-
/** Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](/admin
|
|
8497
|
+
/** Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin). */
|
|
8498
8498
|
viewType?: string;
|
|
8499
8499
|
},
|
|
8500
8500
|
body: Channel,
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -176,7 +176,7 @@ Stops watching resources through this channel.
|
|
|
176
176
|
await gapi.client.admin.channels.stop({});
|
|
177
177
|
|
|
178
178
|
/*
|
|
179
|
-
Use [BatchChangeChromeOsDeviceStatus](/admin
|
|
179
|
+
Use [BatchChangeChromeOsDeviceStatus](https://developers.google.com/workspace/admin/directory/reference/rest/v1/customer.devices.chromeos/batchChangeStatus) instead. Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the [help center](https://support.google.com/chrome/a/answer/3523633).
|
|
180
180
|
*/
|
|
181
181
|
await gapi.client.directory.chromeosdevices.action({
|
|
182
182
|
customerId: 'customerId',
|
|
@@ -205,7 +205,7 @@ await gapi.client.directory.chromeosdevices.moveDevicesToOu({
|
|
|
205
205
|
});
|
|
206
206
|
|
|
207
207
|
/*
|
|
208
|
-
Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](/admin
|
|
208
|
+
Updates a device's updatable properties, such as `annotatedUser`, `annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
|
|
209
209
|
*/
|
|
210
210
|
await gapi.client.directory.chromeosdevices.patch({
|
|
211
211
|
customerId: 'customerId',
|
|
@@ -308,7 +308,7 @@ Retrieves all groups of a domain or of a user given a userKey (paginated).
|
|
|
308
308
|
await gapi.client.directory.groups.list({});
|
|
309
309
|
|
|
310
310
|
/*
|
|
311
|
-
Updates a group's properties. This method supports [patch semantics](/admin
|
|
311
|
+
Updates a group's properties. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
|
|
312
312
|
*/
|
|
313
313
|
await gapi.client.directory.groups.patch({groupKey: 'groupKey'});
|
|
314
314
|
|
|
@@ -347,12 +347,12 @@ Adds a user to the specified group.
|
|
|
347
347
|
await gapi.client.directory.members.insert({groupKey: 'groupKey'});
|
|
348
348
|
|
|
349
349
|
/*
|
|
350
|
-
Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/admin
|
|
350
|
+
Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).
|
|
351
351
|
*/
|
|
352
352
|
await gapi.client.directory.members.list({groupKey: 'groupKey'});
|
|
353
353
|
|
|
354
354
|
/*
|
|
355
|
-
Updates the membership properties of a user in the specified group. This method supports [patch semantics](/admin
|
|
355
|
+
Updates the membership properties of a user in the specified group. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).
|
|
356
356
|
*/
|
|
357
357
|
await gapi.client.directory.members.patch({
|
|
358
358
|
groupKey: 'groupKey',
|
|
@@ -392,7 +392,7 @@ await gapi.client.directory.mobiledevices.get({
|
|
|
392
392
|
});
|
|
393
393
|
|
|
394
394
|
/*
|
|
395
|
-
Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/admin
|
|
395
|
+
Retrieves a paginated list of all user-owned mobile devices for an account. To retrieve a list that includes company-owned devices, use the Cloud Identity [Devices API](https://cloud.google.com/identity/docs/concepts/overview-devices) instead. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).
|
|
396
396
|
*/
|
|
397
397
|
await gapi.client.directory.mobiledevices.list({customerId: 'customerId'});
|
|
398
398
|
|
|
@@ -423,7 +423,7 @@ Retrieves a list of all organizational units for an account.
|
|
|
423
423
|
await gapi.client.directory.orgunits.list({customerId: 'customerId'});
|
|
424
424
|
|
|
425
425
|
/*
|
|
426
|
-
Updates an organizational unit. This method supports [patch semantics](/admin
|
|
426
|
+
Updates an organizational unit. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch)
|
|
427
427
|
*/
|
|
428
428
|
await gapi.client.directory.orgunits.patch({
|
|
429
429
|
customerId: 'customerId',
|
|
@@ -602,7 +602,7 @@ Makes a user a super administrator.
|
|
|
602
602
|
await gapi.client.directory.users.makeAdmin({userKey: 'userKey'});
|
|
603
603
|
|
|
604
604
|
/*
|
|
605
|
-
Updates a user using patch semantics. The update method should be used instead, because it also supports patch semantics and has better performance. If you're mapping an external identity to a Google identity, use the [`update`](https://developers.google.com/admin
|
|
605
|
+
Updates a user using patch semantics. The update method should be used instead, because it also supports patch semantics and has better performance. If you're mapping an external identity to a Google identity, use the [`update`](https://developers.google.com/workspace/admin/directory/v1/reference/users/update) method instead of the `patch` method. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead.
|
|
606
606
|
*/
|
|
607
607
|
await gapi.client.directory.users.patch({userKey: 'userKey'});
|
|
608
608
|
|
|
@@ -617,7 +617,7 @@ Undeletes a deleted user.
|
|
|
617
617
|
await gapi.client.directory.users.undelete({userKey: 'userKey'});
|
|
618
618
|
|
|
619
619
|
/*
|
|
620
|
-
Updates a user. This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/admin
|
|
620
|
+
Updates a user. This method supports patch semantics, meaning that you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared. For repeating fields that contain arrays, individual items in the array can't be patched piecemeal; they must be supplied in the request body with the desired values for all items. See the [user accounts guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#update_user) for more information.
|
|
621
621
|
*/
|
|
622
622
|
await gapi.client.directory.users.update({userKey: 'userKey'});
|
|
623
623
|
|