@maxim_mazurok/gapi.client.cloudidentity-v1beta1 0.0.20220808
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 +2827 -0
- package/package.json +20 -0
- package/readme.md +167 -0
- package/tests.ts +534 -0
- package/tsconfig.json +18 -0
- package/tslint.json +6 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,2827 @@
|
|
|
1
|
+
/* Type definitions for non-npm package Cloud Identity API v1beta1 0.0 */
|
|
2
|
+
// Project: https://cloud.google.com/identity/
|
|
3
|
+
// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
|
|
4
|
+
// Nick Amoscato <https://github.com/namoscato>
|
|
5
|
+
// Declan Vong <https://github.com/declanvong>
|
|
6
|
+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
7
|
+
// TypeScript Version: 2.8
|
|
8
|
+
|
|
9
|
+
// IMPORTANT
|
|
10
|
+
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
11
|
+
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
12
|
+
// Generated from: https://cloudidentity.googleapis.com/$discovery/rest?version=v1beta1
|
|
13
|
+
// Revision: 20220808
|
|
14
|
+
|
|
15
|
+
/// <reference types="gapi.client" />
|
|
16
|
+
|
|
17
|
+
declare namespace gapi.client {
|
|
18
|
+
/** Load Cloud Identity API v1beta1 */
|
|
19
|
+
function load(urlOrObject: "https://cloudidentity.googleapis.com/$discovery/rest?version=v1beta1"): Promise<void>;
|
|
20
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
21
|
+
function load(name: "cloudidentity", version: "v1beta1"): Promise<void>;
|
|
22
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
23
|
+
function load(name: "cloudidentity", version: "v1beta1", callback: () => any): void;
|
|
24
|
+
|
|
25
|
+
namespace cloudidentity {
|
|
26
|
+
interface AndroidAttributes {
|
|
27
|
+
/** Whether applications from unknown sources can be installed on device. */
|
|
28
|
+
enabledUnknownSources?: boolean;
|
|
29
|
+
/** Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles. */
|
|
30
|
+
ownerProfileAccount?: boolean;
|
|
31
|
+
/** Ownership privileges on device. */
|
|
32
|
+
ownershipPrivilege?: string;
|
|
33
|
+
/** Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy. */
|
|
34
|
+
supportsWorkProfile?: boolean;
|
|
35
|
+
}
|
|
36
|
+
// tslint:disable-next-line:no-empty-interface
|
|
37
|
+
interface ApproveDeviceUserRequest {
|
|
38
|
+
}
|
|
39
|
+
interface ApproveDeviceUserResponse {
|
|
40
|
+
/** Resultant DeviceUser object for the action. */
|
|
41
|
+
deviceUser?: DeviceUser;
|
|
42
|
+
}
|
|
43
|
+
// tslint:disable-next-line:no-empty-interface
|
|
44
|
+
interface BlockDeviceUserRequest {
|
|
45
|
+
}
|
|
46
|
+
interface BlockDeviceUserResponse {
|
|
47
|
+
/** Resultant DeviceUser object for the action. */
|
|
48
|
+
deviceUser?: DeviceUser;
|
|
49
|
+
}
|
|
50
|
+
// tslint:disable-next-line:no-empty-interface
|
|
51
|
+
interface CancelUserInvitationRequest {
|
|
52
|
+
}
|
|
53
|
+
// tslint:disable-next-line:no-empty-interface
|
|
54
|
+
interface CancelWipeDeviceRequest {
|
|
55
|
+
}
|
|
56
|
+
interface CancelWipeDeviceResponse {
|
|
57
|
+
/** Resultant Device object for the action. Note that asset tags will not be returned in the device object. */
|
|
58
|
+
device?: Device;
|
|
59
|
+
}
|
|
60
|
+
// tslint:disable-next-line:no-empty-interface
|
|
61
|
+
interface CancelWipeDeviceUserRequest {
|
|
62
|
+
}
|
|
63
|
+
interface CancelWipeDeviceUserResponse {
|
|
64
|
+
/** Resultant DeviceUser object for the action. */
|
|
65
|
+
deviceUser?: DeviceUser;
|
|
66
|
+
}
|
|
67
|
+
interface CertificateAttributes {
|
|
68
|
+
/** The X.509 extension for CertificateTemplate. */
|
|
69
|
+
certificateTemplate?: CertificateTemplate;
|
|
70
|
+
/** The encoded certificate fingerprint. */
|
|
71
|
+
fingerprint?: string;
|
|
72
|
+
/** The name of the issuer of this certificate. */
|
|
73
|
+
issuer?: string;
|
|
74
|
+
/** Serial number of the certificate, Example: "123456789". */
|
|
75
|
+
serialNumber?: string;
|
|
76
|
+
/** The subject name of this certificate. */
|
|
77
|
+
subject?: string;
|
|
78
|
+
/** The certificate thumbprint. */
|
|
79
|
+
thumbprint?: string;
|
|
80
|
+
/** Validation state of this certificate. */
|
|
81
|
+
validationState?: string;
|
|
82
|
+
/** Certificate not valid at or after this timestamp. */
|
|
83
|
+
validityExpirationTime?: string;
|
|
84
|
+
/** Certificate not valid before this timestamp. */
|
|
85
|
+
validityStartTime?: string;
|
|
86
|
+
}
|
|
87
|
+
interface CertificateTemplate {
|
|
88
|
+
/** The template id of the template. Example: "1.3.6.1.4.1.311.21.8.15608621.11768144.5720724.16068415.6889630.81.2472537.7784047". */
|
|
89
|
+
id?: string;
|
|
90
|
+
/** The Major version of the template. Example: 100. */
|
|
91
|
+
majorVersion?: number;
|
|
92
|
+
/** The minor version of the template. Example: 12. */
|
|
93
|
+
minorVersion?: number;
|
|
94
|
+
}
|
|
95
|
+
interface CheckTransitiveMembershipResponse {
|
|
96
|
+
/**
|
|
97
|
+
* Response does not include the possible roles of a member since the behavior of this rpc is not all-or-nothing unlike the other rpcs. So, it may not be possible to list all the roles
|
|
98
|
+
* definitively, due to possible lack of authorization in some of the paths.
|
|
99
|
+
*/
|
|
100
|
+
hasMembership?: boolean;
|
|
101
|
+
}
|
|
102
|
+
interface ClientState {
|
|
103
|
+
/** The caller can specify asset tags for this resource */
|
|
104
|
+
assetTags?: string[];
|
|
105
|
+
/** The compliance state of the resource as specified by the API client. */
|
|
106
|
+
complianceState?: string;
|
|
107
|
+
/** Output only. The time the client state data was created. */
|
|
108
|
+
createTime?: string;
|
|
109
|
+
/** This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field. */
|
|
110
|
+
customId?: string;
|
|
111
|
+
/** The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest */
|
|
112
|
+
etag?: string;
|
|
113
|
+
/** The Health score of the resource */
|
|
114
|
+
healthScore?: string;
|
|
115
|
+
/**
|
|
116
|
+
* The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes
|
|
117
|
+
* in a map.
|
|
118
|
+
*/
|
|
119
|
+
keyValuePairs?: { [P in string]: CustomAttributeValue };
|
|
120
|
+
/** Output only. The time the client state data was last updated. */
|
|
121
|
+
lastUpdateTime?: string;
|
|
122
|
+
/** The management state of the resource as specified by the API client. */
|
|
123
|
+
managed?: string;
|
|
124
|
+
/**
|
|
125
|
+
* Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format:
|
|
126
|
+
* `devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}`, where partner_id corresponds to the partner storing the data.
|
|
127
|
+
*/
|
|
128
|
+
name?: string;
|
|
129
|
+
/** Output only. The owner of the ClientState */
|
|
130
|
+
ownerType?: string;
|
|
131
|
+
/** A descriptive cause of the health score. */
|
|
132
|
+
scoreReason?: string;
|
|
133
|
+
}
|
|
134
|
+
interface CreateDeviceRequest {
|
|
135
|
+
/**
|
|
136
|
+
* Required. The device to be created. The name field within this device is ignored in the create method. A new name is created by the method, and returned within the response. Only
|
|
137
|
+
* the fields `device_type`, `serial_number` and `asset_tag` (if present) are used to create the device. All other fields are ignored. The `device_type` and `serial_number` fields are
|
|
138
|
+
* required.
|
|
139
|
+
*/
|
|
140
|
+
device?: Device;
|
|
141
|
+
}
|
|
142
|
+
interface CustomAttributeValue {
|
|
143
|
+
/** Represents a boolean value. */
|
|
144
|
+
boolValue?: boolean;
|
|
145
|
+
/** Represents a double value. */
|
|
146
|
+
numberValue?: number;
|
|
147
|
+
/** Represents a string value. */
|
|
148
|
+
stringValue?: string;
|
|
149
|
+
}
|
|
150
|
+
interface Device {
|
|
151
|
+
/** Output only. Attributes specific to Android devices. */
|
|
152
|
+
androidSpecificAttributes?: AndroidAttributes;
|
|
153
|
+
/** Asset tag of the device. */
|
|
154
|
+
assetTag?: string;
|
|
155
|
+
/** Output only. Baseband version of the device. */
|
|
156
|
+
basebandVersion?: string;
|
|
157
|
+
/** Output only. Device bootloader version. Example: 0.6.7. */
|
|
158
|
+
bootloaderVersion?: string;
|
|
159
|
+
/** Output only. Device brand. Example: Samsung. */
|
|
160
|
+
brand?: string;
|
|
161
|
+
/** Output only. Build number of the device. */
|
|
162
|
+
buildNumber?: string;
|
|
163
|
+
/** Output only. Represents whether the Device is compromised. */
|
|
164
|
+
compromisedState?: string;
|
|
165
|
+
/** Output only. When the Company-Owned device was imported. This field is empty for BYOD devices. */
|
|
166
|
+
createTime?: string;
|
|
167
|
+
/** Unique identifier for the device. */
|
|
168
|
+
deviceId?: string;
|
|
169
|
+
/** Output only. Type of device. */
|
|
170
|
+
deviceType?: string;
|
|
171
|
+
/** Output only. Whether developer options is enabled on device. */
|
|
172
|
+
enabledDeveloperOptions?: boolean;
|
|
173
|
+
/** Output only. Whether USB debugging is enabled on device. */
|
|
174
|
+
enabledUsbDebugging?: boolean;
|
|
175
|
+
/** Output only. Device encryption state. */
|
|
176
|
+
encryptionState?: string;
|
|
177
|
+
/** Output only. Attributes specific to Endpoint Verification devices. */
|
|
178
|
+
endpointVerificationSpecificAttributes?: EndpointVerificationSpecificAttributes;
|
|
179
|
+
/** Output only. IMEI number of device if GSM device; empty otherwise. */
|
|
180
|
+
imei?: string;
|
|
181
|
+
/** Output only. Kernel version of the device. */
|
|
182
|
+
kernelVersion?: string;
|
|
183
|
+
/** Most recent time when device synced with this service. */
|
|
184
|
+
lastSyncTime?: string;
|
|
185
|
+
/** Output only. Management state of the device */
|
|
186
|
+
managementState?: string;
|
|
187
|
+
/** Output only. Device manufacturer. Example: Motorola. */
|
|
188
|
+
manufacturer?: string;
|
|
189
|
+
/** Output only. MEID number of device if CDMA device; empty otherwise. */
|
|
190
|
+
meid?: string;
|
|
191
|
+
/** Output only. Model name of device. Example: Pixel 3. */
|
|
192
|
+
model?: string;
|
|
193
|
+
/**
|
|
194
|
+
* Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique id assigned to the
|
|
195
|
+
* Device.
|
|
196
|
+
*/
|
|
197
|
+
name?: string;
|
|
198
|
+
/** Output only. Mobile or network operator of device, if available. */
|
|
199
|
+
networkOperator?: string;
|
|
200
|
+
/** Output only. OS version of the device. Example: Android 8.1.0. */
|
|
201
|
+
osVersion?: string;
|
|
202
|
+
/**
|
|
203
|
+
* Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownership_privilege| is |PROFILE_OWNER| or
|
|
204
|
+
* |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com".
|
|
205
|
+
*/
|
|
206
|
+
otherAccounts?: string[];
|
|
207
|
+
/** Output only. Whether the device is owned by the company or an individual */
|
|
208
|
+
ownerType?: string;
|
|
209
|
+
/** Output only. OS release version. Example: 6.0. */
|
|
210
|
+
releaseVersion?: string;
|
|
211
|
+
/** Output only. OS security patch update time on device. */
|
|
212
|
+
securityPatchTime?: string;
|
|
213
|
+
/** Serial Number of device. Example: HT82V1A01076. */
|
|
214
|
+
serialNumber?: string;
|
|
215
|
+
/** WiFi MAC addresses of device. */
|
|
216
|
+
wifiMacAddresses?: string[];
|
|
217
|
+
}
|
|
218
|
+
interface DeviceUser {
|
|
219
|
+
/** Compromised State of the DeviceUser object */
|
|
220
|
+
compromisedState?: string;
|
|
221
|
+
/** When the user first signed in to the device */
|
|
222
|
+
createTime?: string;
|
|
223
|
+
/** Output only. Most recent time when user registered with this service. */
|
|
224
|
+
firstSyncTime?: string;
|
|
225
|
+
/** Output only. Default locale used on device, in IETF BCP-47 format. */
|
|
226
|
+
languageCode?: string;
|
|
227
|
+
/** Output only. Last time when user synced with policies. */
|
|
228
|
+
lastSyncTime?: string;
|
|
229
|
+
/** Output only. Management state of the user on the device. */
|
|
230
|
+
managementState?: string;
|
|
231
|
+
/**
|
|
232
|
+
* Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where
|
|
233
|
+
* `device_user_id` uniquely identifies a user's use of a device.
|
|
234
|
+
*/
|
|
235
|
+
name?: string;
|
|
236
|
+
/** Password state of the DeviceUser object */
|
|
237
|
+
passwordState?: string;
|
|
238
|
+
/** Output only. User agent on the device for this specific user */
|
|
239
|
+
userAgent?: string;
|
|
240
|
+
/** Email address of the user registered on the device. */
|
|
241
|
+
userEmail?: string;
|
|
242
|
+
}
|
|
243
|
+
interface DynamicGroupMetadata {
|
|
244
|
+
/** Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups. */
|
|
245
|
+
queries?: DynamicGroupQuery[];
|
|
246
|
+
/** Output only. Status of the dynamic group. */
|
|
247
|
+
status?: DynamicGroupStatus;
|
|
248
|
+
}
|
|
249
|
+
interface DynamicGroupQuery {
|
|
250
|
+
/**
|
|
251
|
+
* Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org,
|
|
252
|
+
* org.department=='engineering')` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area=='foo' &&
|
|
253
|
+
* loc.building_id=='bar')` All users with any variation of the name John Doe (case-insensitive queries add `equalsIgnoreCase()` to the value being queried).
|
|
254
|
+
* `user.name.value.equalsIgnoreCase('jOhn DoE')`
|
|
255
|
+
*/
|
|
256
|
+
query?: string;
|
|
257
|
+
resourceType?: string;
|
|
258
|
+
}
|
|
259
|
+
interface DynamicGroupStatus {
|
|
260
|
+
/** Status of the dynamic group. */
|
|
261
|
+
status?: string;
|
|
262
|
+
/**
|
|
263
|
+
* The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be
|
|
264
|
+
* up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created.
|
|
265
|
+
*/
|
|
266
|
+
statusTime?: string;
|
|
267
|
+
}
|
|
268
|
+
interface EndpointVerificationSpecificAttributes {
|
|
269
|
+
/** Details of certificates. */
|
|
270
|
+
certificateAttributes?: CertificateAttributes[];
|
|
271
|
+
}
|
|
272
|
+
interface EntityKey {
|
|
273
|
+
/**
|
|
274
|
+
* The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string
|
|
275
|
+
* conforming to the Identity Source's requirements. Must be unique within a `namespace`.
|
|
276
|
+
*/
|
|
277
|
+
id?: string;
|
|
278
|
+
/**
|
|
279
|
+
* The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey`
|
|
280
|
+
* represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of
|
|
281
|
+
* `identitysources/{identity_source_id}`.
|
|
282
|
+
*/
|
|
283
|
+
namespace?: string;
|
|
284
|
+
}
|
|
285
|
+
interface ExpiryDetail {
|
|
286
|
+
/** The time at which the `MembershipRole` will expire. */
|
|
287
|
+
expireTime?: string;
|
|
288
|
+
}
|
|
289
|
+
interface GetMembershipGraphResponse {
|
|
290
|
+
/** The membership graph's path information represented as an adjacency list. */
|
|
291
|
+
adjacencyList?: MembershipAdjacencyList[];
|
|
292
|
+
/**
|
|
293
|
+
* The resources representing each group in the adjacency list. Each group in this list can be correlated to a 'group' of the MembershipAdjacencyList using the 'name' of the Group
|
|
294
|
+
* resource.
|
|
295
|
+
*/
|
|
296
|
+
groups?: Group[];
|
|
297
|
+
}
|
|
298
|
+
interface GoogleAppsCloudidentityDevicesV1AndroidAttributes {
|
|
299
|
+
/** Whether applications from unknown sources can be installed on device. */
|
|
300
|
+
enabledUnknownSources?: boolean;
|
|
301
|
+
/** Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles. */
|
|
302
|
+
ownerProfileAccount?: boolean;
|
|
303
|
+
/** Ownership privileges on device. */
|
|
304
|
+
ownershipPrivilege?: string;
|
|
305
|
+
/** Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy. */
|
|
306
|
+
supportsWorkProfile?: boolean;
|
|
307
|
+
}
|
|
308
|
+
// tslint:disable-next-line:no-empty-interface
|
|
309
|
+
interface GoogleAppsCloudidentityDevicesV1ApproveDeviceUserMetadata {
|
|
310
|
+
}
|
|
311
|
+
interface GoogleAppsCloudidentityDevicesV1ApproveDeviceUserResponse {
|
|
312
|
+
/** Resultant DeviceUser object for the action. */
|
|
313
|
+
deviceUser?: GoogleAppsCloudidentityDevicesV1DeviceUser;
|
|
314
|
+
}
|
|
315
|
+
// tslint:disable-next-line:no-empty-interface
|
|
316
|
+
interface GoogleAppsCloudidentityDevicesV1BlockDeviceUserMetadata {
|
|
317
|
+
}
|
|
318
|
+
interface GoogleAppsCloudidentityDevicesV1BlockDeviceUserResponse {
|
|
319
|
+
/** Resultant DeviceUser object for the action. */
|
|
320
|
+
deviceUser?: GoogleAppsCloudidentityDevicesV1DeviceUser;
|
|
321
|
+
}
|
|
322
|
+
// tslint:disable-next-line:no-empty-interface
|
|
323
|
+
interface GoogleAppsCloudidentityDevicesV1CancelWipeDeviceMetadata {
|
|
324
|
+
}
|
|
325
|
+
interface GoogleAppsCloudidentityDevicesV1CancelWipeDeviceResponse {
|
|
326
|
+
/** Resultant Device object for the action. Note that asset tags will not be returned in the device object. */
|
|
327
|
+
device?: GoogleAppsCloudidentityDevicesV1Device;
|
|
328
|
+
}
|
|
329
|
+
// tslint:disable-next-line:no-empty-interface
|
|
330
|
+
interface GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserMetadata {
|
|
331
|
+
}
|
|
332
|
+
interface GoogleAppsCloudidentityDevicesV1CancelWipeDeviceUserResponse {
|
|
333
|
+
/** Resultant DeviceUser object for the action. */
|
|
334
|
+
deviceUser?: GoogleAppsCloudidentityDevicesV1DeviceUser;
|
|
335
|
+
}
|
|
336
|
+
interface GoogleAppsCloudidentityDevicesV1ClientState {
|
|
337
|
+
/** The caller can specify asset tags for this resource */
|
|
338
|
+
assetTags?: string[];
|
|
339
|
+
/** The compliance state of the resource as specified by the API client. */
|
|
340
|
+
complianceState?: string;
|
|
341
|
+
/** Output only. The time the client state data was created. */
|
|
342
|
+
createTime?: string;
|
|
343
|
+
/** This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field. */
|
|
344
|
+
customId?: string;
|
|
345
|
+
/** The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest */
|
|
346
|
+
etag?: string;
|
|
347
|
+
/**
|
|
348
|
+
* The Health score of the resource. The Health score is the callers specification of the condition of the device from a usability point of view. For example, a third-party device
|
|
349
|
+
* management provider may specify a health score based on its compliance with organizational policies.
|
|
350
|
+
*/
|
|
351
|
+
healthScore?: string;
|
|
352
|
+
/**
|
|
353
|
+
* The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes
|
|
354
|
+
* in a map.
|
|
355
|
+
*/
|
|
356
|
+
keyValuePairs?: { [P in string]: GoogleAppsCloudidentityDevicesV1CustomAttributeValue };
|
|
357
|
+
/** Output only. The time the client state data was last updated. */
|
|
358
|
+
lastUpdateTime?: string;
|
|
359
|
+
/** The management state of the resource as specified by the API client. */
|
|
360
|
+
managed?: string;
|
|
361
|
+
/**
|
|
362
|
+
* Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device}/deviceUsers/{device_user}/clientState/{partner}`,
|
|
363
|
+
* where partner corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other
|
|
364
|
+
* callers, this is a string of the form: `{customer}-suffix`, where `customer` is your customer ID. The *suffix* is any string the caller specifies. This string will be displayed
|
|
365
|
+
* verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL:
|
|
366
|
+
* `GET https://www.googleapis.com/admin/directory/v1/customers/my_customer` The `id` field in the response contains the customer ID starting with the letter 'C'. The customer ID to be
|
|
367
|
+
* used in this API is the string after the letter 'C' (not including 'C')
|
|
368
|
+
*/
|
|
369
|
+
name?: string;
|
|
370
|
+
/** Output only. The owner of the ClientState */
|
|
371
|
+
ownerType?: string;
|
|
372
|
+
/** A descriptive cause of the health score. */
|
|
373
|
+
scoreReason?: string;
|
|
374
|
+
}
|
|
375
|
+
// tslint:disable-next-line:no-empty-interface
|
|
376
|
+
interface GoogleAppsCloudidentityDevicesV1CreateDeviceMetadata {
|
|
377
|
+
}
|
|
378
|
+
interface GoogleAppsCloudidentityDevicesV1CustomAttributeValue {
|
|
379
|
+
/** Represents a boolean value. */
|
|
380
|
+
boolValue?: boolean;
|
|
381
|
+
/** Represents a double value. */
|
|
382
|
+
numberValue?: number;
|
|
383
|
+
/** Represents a string value. */
|
|
384
|
+
stringValue?: string;
|
|
385
|
+
}
|
|
386
|
+
// tslint:disable-next-line:no-empty-interface
|
|
387
|
+
interface GoogleAppsCloudidentityDevicesV1DeleteDeviceMetadata {
|
|
388
|
+
}
|
|
389
|
+
// tslint:disable-next-line:no-empty-interface
|
|
390
|
+
interface GoogleAppsCloudidentityDevicesV1DeleteDeviceUserMetadata {
|
|
391
|
+
}
|
|
392
|
+
interface GoogleAppsCloudidentityDevicesV1Device {
|
|
393
|
+
/** Output only. Attributes specific to Android devices. */
|
|
394
|
+
androidSpecificAttributes?: GoogleAppsCloudidentityDevicesV1AndroidAttributes;
|
|
395
|
+
/** Asset tag of the device. */
|
|
396
|
+
assetTag?: string;
|
|
397
|
+
/** Output only. Baseband version of the device. */
|
|
398
|
+
basebandVersion?: string;
|
|
399
|
+
/** Output only. Device bootloader version. Example: 0.6.7. */
|
|
400
|
+
bootloaderVersion?: string;
|
|
401
|
+
/** Output only. Device brand. Example: Samsung. */
|
|
402
|
+
brand?: string;
|
|
403
|
+
/** Output only. Build number of the device. */
|
|
404
|
+
buildNumber?: string;
|
|
405
|
+
/** Output only. Represents whether the Device is compromised. */
|
|
406
|
+
compromisedState?: string;
|
|
407
|
+
/** Output only. When the Company-Owned device was imported. This field is empty for BYOD devices. */
|
|
408
|
+
createTime?: string;
|
|
409
|
+
/** Unique identifier for the device. */
|
|
410
|
+
deviceId?: string;
|
|
411
|
+
/** Output only. Type of device. */
|
|
412
|
+
deviceType?: string;
|
|
413
|
+
/** Output only. Whether developer options is enabled on device. */
|
|
414
|
+
enabledDeveloperOptions?: boolean;
|
|
415
|
+
/** Output only. Whether USB debugging is enabled on device. */
|
|
416
|
+
enabledUsbDebugging?: boolean;
|
|
417
|
+
/** Output only. Device encryption state. */
|
|
418
|
+
encryptionState?: string;
|
|
419
|
+
/** Output only. IMEI number of device if GSM device; empty otherwise. */
|
|
420
|
+
imei?: string;
|
|
421
|
+
/** Output only. Kernel version of the device. */
|
|
422
|
+
kernelVersion?: string;
|
|
423
|
+
/** Most recent time when device synced with this service. */
|
|
424
|
+
lastSyncTime?: string;
|
|
425
|
+
/** Output only. Management state of the device */
|
|
426
|
+
managementState?: string;
|
|
427
|
+
/** Output only. Device manufacturer. Example: Motorola. */
|
|
428
|
+
manufacturer?: string;
|
|
429
|
+
/** Output only. MEID number of device if CDMA device; empty otherwise. */
|
|
430
|
+
meid?: string;
|
|
431
|
+
/** Output only. Model name of device. Example: Pixel 3. */
|
|
432
|
+
model?: string;
|
|
433
|
+
/** Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device}`, where device is the unique id assigned to the Device. */
|
|
434
|
+
name?: string;
|
|
435
|
+
/** Output only. Mobile or network operator of device, if available. */
|
|
436
|
+
networkOperator?: string;
|
|
437
|
+
/** Output only. OS version of the device. Example: Android 8.1.0. */
|
|
438
|
+
osVersion?: string;
|
|
439
|
+
/**
|
|
440
|
+
* Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownership_privilege| is |PROFILE_OWNER| or
|
|
441
|
+
* |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com".
|
|
442
|
+
*/
|
|
443
|
+
otherAccounts?: string[];
|
|
444
|
+
/** Output only. Whether the device is owned by the company or an individual */
|
|
445
|
+
ownerType?: string;
|
|
446
|
+
/** Output only. OS release version. Example: 6.0. */
|
|
447
|
+
releaseVersion?: string;
|
|
448
|
+
/** Output only. OS security patch update time on device. */
|
|
449
|
+
securityPatchTime?: string;
|
|
450
|
+
/** Serial Number of device. Example: HT82V1A01076. */
|
|
451
|
+
serialNumber?: string;
|
|
452
|
+
/** WiFi MAC addresses of device. */
|
|
453
|
+
wifiMacAddresses?: string[];
|
|
454
|
+
}
|
|
455
|
+
interface GoogleAppsCloudidentityDevicesV1DeviceUser {
|
|
456
|
+
/** Compromised State of the DeviceUser object */
|
|
457
|
+
compromisedState?: string;
|
|
458
|
+
/** When the user first signed in to the device */
|
|
459
|
+
createTime?: string;
|
|
460
|
+
/** Output only. Most recent time when user registered with this service. */
|
|
461
|
+
firstSyncTime?: string;
|
|
462
|
+
/** Output only. Default locale used on device, in IETF BCP-47 format. */
|
|
463
|
+
languageCode?: string;
|
|
464
|
+
/** Output only. Last time when user synced with policies. */
|
|
465
|
+
lastSyncTime?: string;
|
|
466
|
+
/** Output only. Management state of the user on the device. */
|
|
467
|
+
managementState?: string;
|
|
468
|
+
/**
|
|
469
|
+
* Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device}/deviceUsers/{device_user}`, where `device_user`
|
|
470
|
+
* uniquely identifies a user's use of a device.
|
|
471
|
+
*/
|
|
472
|
+
name?: string;
|
|
473
|
+
/** Password state of the DeviceUser object */
|
|
474
|
+
passwordState?: string;
|
|
475
|
+
/** Output only. User agent on the device for this specific user */
|
|
476
|
+
userAgent?: string;
|
|
477
|
+
/** Email address of the user registered on the device. */
|
|
478
|
+
userEmail?: string;
|
|
479
|
+
}
|
|
480
|
+
// tslint:disable-next-line:no-empty-interface
|
|
481
|
+
interface GoogleAppsCloudidentityDevicesV1ListEndpointAppsMetadata {
|
|
482
|
+
}
|
|
483
|
+
// tslint:disable-next-line:no-empty-interface
|
|
484
|
+
interface GoogleAppsCloudidentityDevicesV1SignoutDeviceUserMetadata {
|
|
485
|
+
}
|
|
486
|
+
// tslint:disable-next-line:no-empty-interface
|
|
487
|
+
interface GoogleAppsCloudidentityDevicesV1UpdateClientStateMetadata {
|
|
488
|
+
}
|
|
489
|
+
// tslint:disable-next-line:no-empty-interface
|
|
490
|
+
interface GoogleAppsCloudidentityDevicesV1UpdateDeviceMetadata {
|
|
491
|
+
}
|
|
492
|
+
// tslint:disable-next-line:no-empty-interface
|
|
493
|
+
interface GoogleAppsCloudidentityDevicesV1WipeDeviceMetadata {
|
|
494
|
+
}
|
|
495
|
+
interface GoogleAppsCloudidentityDevicesV1WipeDeviceResponse {
|
|
496
|
+
/** Resultant Device object for the action. Note that asset tags will not be returned in the device object. */
|
|
497
|
+
device?: GoogleAppsCloudidentityDevicesV1Device;
|
|
498
|
+
}
|
|
499
|
+
// tslint:disable-next-line:no-empty-interface
|
|
500
|
+
interface GoogleAppsCloudidentityDevicesV1WipeDeviceUserMetadata {
|
|
501
|
+
}
|
|
502
|
+
interface GoogleAppsCloudidentityDevicesV1WipeDeviceUserResponse {
|
|
503
|
+
/** Resultant DeviceUser object for the action. */
|
|
504
|
+
deviceUser?: GoogleAppsCloudidentityDevicesV1DeviceUser;
|
|
505
|
+
}
|
|
506
|
+
interface Group {
|
|
507
|
+
/** Output only. The time when the `Group` was created. */
|
|
508
|
+
createTime?: string;
|
|
509
|
+
/** An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters. */
|
|
510
|
+
description?: string;
|
|
511
|
+
/** The display name of the `Group`. */
|
|
512
|
+
displayName?: string;
|
|
513
|
+
/** Optional. Dynamic group metadata like queries and status. */
|
|
514
|
+
dynamicGroupMetadata?: DynamicGroupMetadata;
|
|
515
|
+
/** Required. The `EntityKey` of the `Group`. */
|
|
516
|
+
groupKey?: EntityKey;
|
|
517
|
+
/**
|
|
518
|
+
* Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a
|
|
519
|
+
* label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of
|
|
520
|
+
* `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups
|
|
521
|
+
* have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty
|
|
522
|
+
* value.
|
|
523
|
+
*/
|
|
524
|
+
labels?: { [P in string]: string };
|
|
525
|
+
/** Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. */
|
|
526
|
+
name?: string;
|
|
527
|
+
/**
|
|
528
|
+
* Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form
|
|
529
|
+
* `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example,
|
|
530
|
+
* 'C046psxkn').
|
|
531
|
+
*/
|
|
532
|
+
parent?: string;
|
|
533
|
+
/** Optional. The POSIX groups associated with the `Group`. */
|
|
534
|
+
posixGroups?: PosixGroup[];
|
|
535
|
+
/** Output only. The time when the `Group` was last updated. */
|
|
536
|
+
updateTime?: string;
|
|
537
|
+
}
|
|
538
|
+
interface GroupRelation {
|
|
539
|
+
/** Display name for this group. */
|
|
540
|
+
displayName?: string;
|
|
541
|
+
/** Resource name for this group. */
|
|
542
|
+
group?: string;
|
|
543
|
+
/** Entity key has an id and a namespace. In case of discussion forums, the id will be an email address without a namespace. */
|
|
544
|
+
groupKey?: EntityKey;
|
|
545
|
+
/** Labels for Group resource. */
|
|
546
|
+
labels?: { [P in string]: string };
|
|
547
|
+
/** The relation between the member and the transitive group. */
|
|
548
|
+
relationType?: string;
|
|
549
|
+
/** Membership roles of the member for the group. */
|
|
550
|
+
roles?: TransitiveMembershipRole[];
|
|
551
|
+
}
|
|
552
|
+
interface IsInvitableUserResponse {
|
|
553
|
+
/** Returns true if the email address is invitable. */
|
|
554
|
+
isInvitableUser?: boolean;
|
|
555
|
+
}
|
|
556
|
+
interface ListClientStatesResponse {
|
|
557
|
+
/** Client states meeting the list restrictions. */
|
|
558
|
+
clientStates?: ClientState[];
|
|
559
|
+
/** Token to retrieve the next page of results. Empty if there are no more results. */
|
|
560
|
+
nextPageToken?: string;
|
|
561
|
+
}
|
|
562
|
+
interface ListDevicesResponse {
|
|
563
|
+
/** Devices meeting the list restrictions. */
|
|
564
|
+
devices?: Device[];
|
|
565
|
+
/** Token to retrieve the next page of results. Empty if there are no more results. */
|
|
566
|
+
nextPageToken?: string;
|
|
567
|
+
}
|
|
568
|
+
interface ListDeviceUsersResponse {
|
|
569
|
+
/** Devices meeting the list restrictions. */
|
|
570
|
+
deviceUsers?: DeviceUser[];
|
|
571
|
+
/** Token to retrieve the next page of results. Empty if there are no more results. */
|
|
572
|
+
nextPageToken?: string;
|
|
573
|
+
}
|
|
574
|
+
interface ListGroupsResponse {
|
|
575
|
+
/** The `Group` resources under the specified `parent`. */
|
|
576
|
+
groups?: Group[];
|
|
577
|
+
/** A continuation token to retrieve the next page of results, or empty if there are no more results available. */
|
|
578
|
+
nextPageToken?: string;
|
|
579
|
+
}
|
|
580
|
+
interface ListMembershipsResponse {
|
|
581
|
+
/** The `Membership`s under the specified `parent`. */
|
|
582
|
+
memberships?: Membership[];
|
|
583
|
+
/** A continuation token to retrieve the next page of results, or empty if there are no more results available. */
|
|
584
|
+
nextPageToken?: string;
|
|
585
|
+
}
|
|
586
|
+
interface ListOrgMembershipsResponse {
|
|
587
|
+
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. */
|
|
588
|
+
nextPageToken?: string;
|
|
589
|
+
/** The non-vacuous membership in an orgUnit. */
|
|
590
|
+
orgMemberships?: OrgMembership[];
|
|
591
|
+
}
|
|
592
|
+
interface ListUserInvitationsResponse {
|
|
593
|
+
/**
|
|
594
|
+
* The token for the next page. If not empty, indicates that there may be more `UserInvitation` resources that match the listing request; this value can be used in a subsequent
|
|
595
|
+
* ListUserInvitationsRequest to get continued results with the current list call.
|
|
596
|
+
*/
|
|
597
|
+
nextPageToken?: string;
|
|
598
|
+
/** The list of UserInvitation resources. */
|
|
599
|
+
userInvitations?: UserInvitation[];
|
|
600
|
+
}
|
|
601
|
+
interface LookupGroupNameResponse {
|
|
602
|
+
/** Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Group`. */
|
|
603
|
+
name?: string;
|
|
604
|
+
}
|
|
605
|
+
interface LookupMembershipNameResponse {
|
|
606
|
+
/** The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Membership`. Must be of the form `groups/{group_id}/memberships/{membership_id}`. */
|
|
607
|
+
name?: string;
|
|
608
|
+
}
|
|
609
|
+
interface LookupSelfDeviceUsersResponse {
|
|
610
|
+
/** The obfuscated customer Id that may be passed back to other Devices API methods such as List, Get, etc. */
|
|
611
|
+
customer?: string;
|
|
612
|
+
/**
|
|
613
|
+
* [Resource names](https://cloud.google.com/apis/design/resource_names) of the DeviceUsers in the format: `devices/{device_id}/deviceUsers/{user_resource_id}`, where device_id is the
|
|
614
|
+
* unique ID assigned to a Device and user_resource_id is the unique user ID
|
|
615
|
+
*/
|
|
616
|
+
names?: string[];
|
|
617
|
+
/** Token to retrieve the next page of results. Empty if there are no more results. */
|
|
618
|
+
nextPageToken?: string;
|
|
619
|
+
}
|
|
620
|
+
interface MemberRelation {
|
|
621
|
+
/** Resource name for this member. */
|
|
622
|
+
member?: string;
|
|
623
|
+
/** Entity key has an id and a namespace. In case of discussion forums, the id will be an email address without a namespace. */
|
|
624
|
+
preferredMemberKey?: EntityKey[];
|
|
625
|
+
/** The relation between the group and the transitive membership. */
|
|
626
|
+
relationType?: string;
|
|
627
|
+
/** The membership role details (i.e name of role and expiry time). */
|
|
628
|
+
roles?: TransitiveMembershipRole[];
|
|
629
|
+
}
|
|
630
|
+
interface MemberRestriction {
|
|
631
|
+
/** The evaluated state of this restriction on a group. */
|
|
632
|
+
evaluation?: RestrictionEvaluation;
|
|
633
|
+
/**
|
|
634
|
+
* Member Restriction as defined by CEL expression. Supported restrictions are: `member.customer_id` and `member.type`. Valid values for `member.type` are `1`, `2` and `3`. They
|
|
635
|
+
* correspond to USER, SERVICE_ACCOUNT, and GROUP respectively. The value for `member.customer_id` only supports `groupCustomerId()` currently which means the customer id of the group
|
|
636
|
+
* will be used for restriction. Supported operators are `&&`, `||` and `==`, corresponding to AND, OR, and EQUAL. Examples: Allow only service accounts of given customer to be
|
|
637
|
+
* members. `member.type == 2 && member.customer_id == groupCustomerId()` Allow only users or groups to be members. `member.type == 1 || member.type == 3`
|
|
638
|
+
*/
|
|
639
|
+
query?: string;
|
|
640
|
+
}
|
|
641
|
+
interface Membership {
|
|
642
|
+
/** Output only. The time when the `Membership` was created. */
|
|
643
|
+
createTime?: string;
|
|
644
|
+
/**
|
|
645
|
+
* Immutable. The `EntityKey` of the member. Either `member_key` or `preferred_member_key` must be set when calling MembershipsService.CreateMembership but not both; both shall be set
|
|
646
|
+
* when returned.
|
|
647
|
+
*/
|
|
648
|
+
memberKey?: EntityKey;
|
|
649
|
+
/** Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership`. Shall be of the form `groups/{group_id}/memberships/{membership_id}`. */
|
|
650
|
+
name?: string;
|
|
651
|
+
/**
|
|
652
|
+
* Required. Immutable. The `EntityKey` of the member. Either `member_key` or `preferred_member_key` must be set when calling MembershipsService.CreateMembership but not both; both
|
|
653
|
+
* shall be set when returned.
|
|
654
|
+
*/
|
|
655
|
+
preferredMemberKey?: EntityKey;
|
|
656
|
+
/**
|
|
657
|
+
* The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with
|
|
658
|
+
* the same `name`.
|
|
659
|
+
*/
|
|
660
|
+
roles?: MembershipRole[];
|
|
661
|
+
/** Output only. The type of the membership. */
|
|
662
|
+
type?: string;
|
|
663
|
+
/** Output only. The time when the `Membership` was last updated. */
|
|
664
|
+
updateTime?: string;
|
|
665
|
+
}
|
|
666
|
+
interface MembershipAdjacencyList {
|
|
667
|
+
/**
|
|
668
|
+
* Each edge contains information about the member that belongs to this group. Note: Fields returned here will help identify the specific Membership resource (e.g name,
|
|
669
|
+
* preferred_member_key and role), but may not be a comprehensive list of all fields.
|
|
670
|
+
*/
|
|
671
|
+
edges?: Membership[];
|
|
672
|
+
/** Resource name of the group that the members belong to. */
|
|
673
|
+
group?: string;
|
|
674
|
+
}
|
|
675
|
+
interface MembershipRole {
|
|
676
|
+
/**
|
|
677
|
+
* The expiry details of the `MembershipRole`. Expiry details are only supported for `MEMBER` `MembershipRoles`. May be set if `name` is `MEMBER`. Must not be set if `name` is any
|
|
678
|
+
* other value.
|
|
679
|
+
*/
|
|
680
|
+
expiryDetail?: ExpiryDetail;
|
|
681
|
+
/** The name of the `MembershipRole`. Must be one of `OWNER`, `MANAGER`, `MEMBER`. */
|
|
682
|
+
name?: string;
|
|
683
|
+
/** Evaluations of restrictions applied to parent group on this membership. */
|
|
684
|
+
restrictionEvaluations?: RestrictionEvaluations;
|
|
685
|
+
}
|
|
686
|
+
interface MembershipRoleRestrictionEvaluation {
|
|
687
|
+
/** Output only. The current state of the restriction */
|
|
688
|
+
state?: string;
|
|
689
|
+
}
|
|
690
|
+
interface ModifyMembershipRolesRequest {
|
|
691
|
+
/** The `MembershipRole`s to be added. Adding or removing roles in the same request as updating roles is not supported. Must not be set if `update_roles_params` is set. */
|
|
692
|
+
addRoles?: MembershipRole[];
|
|
693
|
+
/**
|
|
694
|
+
* The `name`s of the `MembershipRole`s to be removed. Adding or removing roles in the same request as updating roles is not supported. It is not possible to remove the `MEMBER`
|
|
695
|
+
* `MembershipRole`. If you wish to delete a `Membership`, call MembershipsService.DeleteMembership instead. Must not contain `MEMBER`. Must not be set if `update_roles_params` is set.
|
|
696
|
+
*/
|
|
697
|
+
removeRoles?: string[];
|
|
698
|
+
/** The `MembershipRole`s to be updated. Updating roles in the same request as adding or removing roles is not supported. Must not be set if either `add_roles` or `remove_roles` is set. */
|
|
699
|
+
updateRolesParams?: UpdateMembershipRolesParams[];
|
|
700
|
+
}
|
|
701
|
+
interface ModifyMembershipRolesResponse {
|
|
702
|
+
/** The `Membership` resource after modifying its `MembershipRole`s. */
|
|
703
|
+
membership?: Membership;
|
|
704
|
+
}
|
|
705
|
+
interface MoveOrgMembershipRequest {
|
|
706
|
+
/**
|
|
707
|
+
* Required. Immutable. Customer on whose membership change is made. All authorization will happen on the role assignments of this customer. Format: customers/{$customerId} where
|
|
708
|
+
* `$customerId` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may also use
|
|
709
|
+
* `customers/my_customer` to specify your own organization.
|
|
710
|
+
*/
|
|
711
|
+
customer?: string;
|
|
712
|
+
/**
|
|
713
|
+
* Required. Immutable. OrgUnit where the membership will be moved to. Format: orgUnits/{$orgUnitId} where `$orgUnitId` is the `orgUnitId` from the [Admin SDK `OrgUnit`
|
|
714
|
+
* resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/orgunits).
|
|
715
|
+
*/
|
|
716
|
+
destinationOrgUnit?: string;
|
|
717
|
+
}
|
|
718
|
+
interface Operation {
|
|
719
|
+
/** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
|
|
720
|
+
done?: boolean;
|
|
721
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
722
|
+
error?: Status;
|
|
723
|
+
/**
|
|
724
|
+
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such
|
|
725
|
+
* metadata. Any method that returns a long-running operation should document the metadata type, if any.
|
|
726
|
+
*/
|
|
727
|
+
metadata?: { [P in string]: any };
|
|
728
|
+
/**
|
|
729
|
+
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending
|
|
730
|
+
* with `operations/{unique_id}`.
|
|
731
|
+
*/
|
|
732
|
+
name?: string;
|
|
733
|
+
/**
|
|
734
|
+
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the
|
|
735
|
+
* original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the
|
|
736
|
+
* original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
|
|
737
|
+
*/
|
|
738
|
+
response?: { [P in string]: any };
|
|
739
|
+
}
|
|
740
|
+
interface OrgMembership {
|
|
741
|
+
/**
|
|
742
|
+
* Immutable. Org member id as full resource name. Format for shared drive resource: //drive.googleapis.com/drives/{$memberId} where `$memberId` is the `id` from [Drive API (V3)
|
|
743
|
+
* `Drive` resource](https://developers.google.com/drive/api/v3/reference/drives#resource).
|
|
744
|
+
*/
|
|
745
|
+
member?: string;
|
|
746
|
+
/**
|
|
747
|
+
* Uri with which you can read the member. This follows https://aip.dev/122 Format for shared drive resource: https://drive.googleapis.com/drive/v3/drives/{$memberId} where `$memberId`
|
|
748
|
+
* is the `id` from [Drive API (V3) `Drive` resource](https://developers.google.com/drive/api/v3/reference/drives#resource).
|
|
749
|
+
*/
|
|
750
|
+
memberUri?: string;
|
|
751
|
+
/**
|
|
752
|
+
* Required. Immutable. The [resource name](https://cloud.google.com/apis/design/resource_names) of the OrgMembership. Format: orgUnits/{$orgUnitId}/memberships/{$membership} The
|
|
753
|
+
* `$orgUnitId` is the `orgUnitId` from the [Admin SDK `OrgUnit` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/orgunits). The `$membership` shall be of
|
|
754
|
+
* the form `{$entityType};{$memberId}`, where `$entityType` is the enum value of [OrgMembership.EntityType], and `memberId` is the `id` from [Drive API (V3) `Drive`
|
|
755
|
+
* resource](https://developers.google.com/drive/api/v3/reference/drives#resource) for OrgMembership.EntityType.SHARED_DRIVE.
|
|
756
|
+
*/
|
|
757
|
+
name?: string;
|
|
758
|
+
/** Immutable. Entity type for the org member. */
|
|
759
|
+
type?: string;
|
|
760
|
+
}
|
|
761
|
+
interface PosixGroup {
|
|
762
|
+
/** GID of the POSIX group. */
|
|
763
|
+
gid?: string;
|
|
764
|
+
/** Name of the POSIX group. */
|
|
765
|
+
name?: string;
|
|
766
|
+
/** System identifier for which group name and gid apply to. If not specified it will default to empty value. */
|
|
767
|
+
systemId?: string;
|
|
768
|
+
}
|
|
769
|
+
interface RestrictionEvaluation {
|
|
770
|
+
/** Output only. The current state of the restriction */
|
|
771
|
+
state?: string;
|
|
772
|
+
}
|
|
773
|
+
interface RestrictionEvaluations {
|
|
774
|
+
/** Evaluation of the member restriction applied to this membership. Empty if the user lacks permission to view the restriction evaluation. */
|
|
775
|
+
memberRestrictionEvaluation?: MembershipRoleRestrictionEvaluation;
|
|
776
|
+
}
|
|
777
|
+
interface SearchGroupsResponse {
|
|
778
|
+
/** The `Group` resources that match the search query. */
|
|
779
|
+
groups?: Group[];
|
|
780
|
+
/** A continuation token to retrieve the next page of results, or empty if there are no more results available. */
|
|
781
|
+
nextPageToken?: string;
|
|
782
|
+
}
|
|
783
|
+
interface SearchTransitiveGroupsResponse {
|
|
784
|
+
/** List of transitive groups satisfying the query. */
|
|
785
|
+
memberships?: GroupRelation[];
|
|
786
|
+
/** Token to retrieve the next page of results, or empty if there are no more results available for listing. */
|
|
787
|
+
nextPageToken?: string;
|
|
788
|
+
}
|
|
789
|
+
interface SearchTransitiveMembershipsResponse {
|
|
790
|
+
/** List of transitive memberships satisfying the query. */
|
|
791
|
+
memberships?: MemberRelation[];
|
|
792
|
+
/** Token to retrieve the next page of results, or empty if there are no more results. */
|
|
793
|
+
nextPageToken?: string;
|
|
794
|
+
}
|
|
795
|
+
interface SecuritySettings {
|
|
796
|
+
/** The Member Restriction value */
|
|
797
|
+
memberRestriction?: MemberRestriction;
|
|
798
|
+
/** Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`. */
|
|
799
|
+
name?: string;
|
|
800
|
+
}
|
|
801
|
+
// tslint:disable-next-line:no-empty-interface
|
|
802
|
+
interface SendUserInvitationRequest {
|
|
803
|
+
}
|
|
804
|
+
interface Status {
|
|
805
|
+
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
806
|
+
code?: number;
|
|
807
|
+
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
808
|
+
details?: Array<{ [P in string]: any }>;
|
|
809
|
+
/**
|
|
810
|
+
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the
|
|
811
|
+
* client.
|
|
812
|
+
*/
|
|
813
|
+
message?: string;
|
|
814
|
+
}
|
|
815
|
+
interface TransitiveMembershipRole {
|
|
816
|
+
/** TransitiveMembershipRole in string format. Currently supported TransitiveMembershipRoles: `"MEMBER"`, `"OWNER"`, and `"MANAGER"`. */
|
|
817
|
+
role?: string;
|
|
818
|
+
}
|
|
819
|
+
interface UpdateMembershipRolesParams {
|
|
820
|
+
/** The fully-qualified names of fields to update. May only contain the field `expiry_detail.expire_time`. */
|
|
821
|
+
fieldMask?: string;
|
|
822
|
+
/** The `MembershipRole`s to be updated. Only `MEMBER` `MembershipRoles` can currently be updated. May only contain a `MembershipRole` with `name` `MEMBER`. */
|
|
823
|
+
membershipRole?: MembershipRole;
|
|
824
|
+
}
|
|
825
|
+
interface UserInvitation {
|
|
826
|
+
/** Number of invitation emails sent to the user. */
|
|
827
|
+
mailsSentCount?: string;
|
|
828
|
+
/** Shall be of the form `customers/{customer}/userinvitations/{user_email_address}`. */
|
|
829
|
+
name?: string;
|
|
830
|
+
/** State of the `UserInvitation`. */
|
|
831
|
+
state?: string;
|
|
832
|
+
/** Time when the `UserInvitation` was last updated. */
|
|
833
|
+
updateTime?: string;
|
|
834
|
+
}
|
|
835
|
+
interface WipeDeviceRequest {
|
|
836
|
+
/**
|
|
837
|
+
* Optional. Specifies if a user is able to factory reset a device after a Device Wipe. On iOS, this is called "Activation Lock", while on Android, this is known as "Factory Reset
|
|
838
|
+
* Protection". If true, this protection will be removed from the device, so that a user can successfully factory reset. If false, the setting is untouched on the device.
|
|
839
|
+
*/
|
|
840
|
+
removeResetLock?: boolean;
|
|
841
|
+
}
|
|
842
|
+
interface WipeDeviceResponse {
|
|
843
|
+
/** Resultant Device object for the action. Note that asset tags will not be returned in the device object. */
|
|
844
|
+
device?: Device;
|
|
845
|
+
}
|
|
846
|
+
// tslint:disable-next-line:no-empty-interface
|
|
847
|
+
interface WipeDeviceUserRequest {
|
|
848
|
+
}
|
|
849
|
+
interface WipeDeviceUserResponse {
|
|
850
|
+
/** Resultant DeviceUser object for the action. */
|
|
851
|
+
deviceUser?: DeviceUser;
|
|
852
|
+
}
|
|
853
|
+
interface UserinvitationsResource {
|
|
854
|
+
/** Cancels a UserInvitation that was already sent. */
|
|
855
|
+
cancel(request: {
|
|
856
|
+
/** V1 error format. */
|
|
857
|
+
"$.xgafv"?: string;
|
|
858
|
+
/** OAuth access token. */
|
|
859
|
+
access_token?: string;
|
|
860
|
+
/** Data format for response. */
|
|
861
|
+
alt?: string;
|
|
862
|
+
/** JSONP */
|
|
863
|
+
callback?: string;
|
|
864
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
865
|
+
fields?: string;
|
|
866
|
+
/** 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. */
|
|
867
|
+
key?: string;
|
|
868
|
+
/** Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}` */
|
|
869
|
+
name: string;
|
|
870
|
+
/** OAuth 2.0 token for the current user. */
|
|
871
|
+
oauth_token?: string;
|
|
872
|
+
/** Returns response with indentations and line breaks. */
|
|
873
|
+
prettyPrint?: boolean;
|
|
874
|
+
/** 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. */
|
|
875
|
+
quotaUser?: string;
|
|
876
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
877
|
+
upload_protocol?: string;
|
|
878
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
879
|
+
uploadType?: string;
|
|
880
|
+
/** Request body */
|
|
881
|
+
resource: CancelUserInvitationRequest;
|
|
882
|
+
}): Request<Operation>;
|
|
883
|
+
cancel(request: {
|
|
884
|
+
/** V1 error format. */
|
|
885
|
+
"$.xgafv"?: string;
|
|
886
|
+
/** OAuth access token. */
|
|
887
|
+
access_token?: string;
|
|
888
|
+
/** Data format for response. */
|
|
889
|
+
alt?: string;
|
|
890
|
+
/** JSONP */
|
|
891
|
+
callback?: string;
|
|
892
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
893
|
+
fields?: string;
|
|
894
|
+
/** 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. */
|
|
895
|
+
key?: string;
|
|
896
|
+
/** Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}` */
|
|
897
|
+
name: string;
|
|
898
|
+
/** OAuth 2.0 token for the current user. */
|
|
899
|
+
oauth_token?: string;
|
|
900
|
+
/** Returns response with indentations and line breaks. */
|
|
901
|
+
prettyPrint?: boolean;
|
|
902
|
+
/** 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. */
|
|
903
|
+
quotaUser?: string;
|
|
904
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
905
|
+
upload_protocol?: string;
|
|
906
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
907
|
+
uploadType?: string;
|
|
908
|
+
},
|
|
909
|
+
body: CancelUserInvitationRequest): Request<Operation>;
|
|
910
|
+
/**
|
|
911
|
+
* Retrieves a UserInvitation resource. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This
|
|
912
|
+
* delay also applies to newly-verified domains.
|
|
913
|
+
*/
|
|
914
|
+
get(request?: {
|
|
915
|
+
/** V1 error format. */
|
|
916
|
+
"$.xgafv"?: string;
|
|
917
|
+
/** OAuth access token. */
|
|
918
|
+
access_token?: string;
|
|
919
|
+
/** Data format for response. */
|
|
920
|
+
alt?: string;
|
|
921
|
+
/** JSONP */
|
|
922
|
+
callback?: string;
|
|
923
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
924
|
+
fields?: string;
|
|
925
|
+
/** 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. */
|
|
926
|
+
key?: string;
|
|
927
|
+
/** Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}` */
|
|
928
|
+
name: string;
|
|
929
|
+
/** OAuth 2.0 token for the current user. */
|
|
930
|
+
oauth_token?: string;
|
|
931
|
+
/** Returns response with indentations and line breaks. */
|
|
932
|
+
prettyPrint?: boolean;
|
|
933
|
+
/** 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. */
|
|
934
|
+
quotaUser?: string;
|
|
935
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
936
|
+
upload_protocol?: string;
|
|
937
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
938
|
+
uploadType?: string;
|
|
939
|
+
}): Request<UserInvitation>;
|
|
940
|
+
/**
|
|
941
|
+
* Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). Eligibility is based on the following criteria: * the email address is a consumer
|
|
942
|
+
* account and it's the primary email address of the account, and * the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain If both
|
|
943
|
+
* conditions are met, the user is eligible. **Note:** This method is not supported for Workspace Essentials customers.
|
|
944
|
+
*/
|
|
945
|
+
isInvitableUser(request?: {
|
|
946
|
+
/** V1 error format. */
|
|
947
|
+
"$.xgafv"?: string;
|
|
948
|
+
/** OAuth access token. */
|
|
949
|
+
access_token?: string;
|
|
950
|
+
/** Data format for response. */
|
|
951
|
+
alt?: string;
|
|
952
|
+
/** JSONP */
|
|
953
|
+
callback?: string;
|
|
954
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
955
|
+
fields?: string;
|
|
956
|
+
/** 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. */
|
|
957
|
+
key?: string;
|
|
958
|
+
/** Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}` */
|
|
959
|
+
name: string;
|
|
960
|
+
/** OAuth 2.0 token for the current user. */
|
|
961
|
+
oauth_token?: string;
|
|
962
|
+
/** Returns response with indentations and line breaks. */
|
|
963
|
+
prettyPrint?: boolean;
|
|
964
|
+
/** 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. */
|
|
965
|
+
quotaUser?: string;
|
|
966
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
967
|
+
upload_protocol?: string;
|
|
968
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
969
|
+
uploadType?: string;
|
|
970
|
+
}): Request<IsInvitableUserResponse>;
|
|
971
|
+
/**
|
|
972
|
+
* Retrieves a list of UserInvitation resources. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result.
|
|
973
|
+
* This delay also applies to newly-verified domains.
|
|
974
|
+
*/
|
|
975
|
+
list(request?: {
|
|
976
|
+
/** V1 error format. */
|
|
977
|
+
"$.xgafv"?: string;
|
|
978
|
+
/** OAuth access token. */
|
|
979
|
+
access_token?: string;
|
|
980
|
+
/** Data format for response. */
|
|
981
|
+
alt?: string;
|
|
982
|
+
/** JSONP */
|
|
983
|
+
callback?: string;
|
|
984
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
985
|
+
fields?: string;
|
|
986
|
+
/** Optional. A query string for filtering `UserInvitation` results by their current state, in the format: `"state=='invited'"`. */
|
|
987
|
+
filter?: string;
|
|
988
|
+
/** 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. */
|
|
989
|
+
key?: string;
|
|
990
|
+
/** OAuth 2.0 token for the current user. */
|
|
991
|
+
oauth_token?: string;
|
|
992
|
+
/**
|
|
993
|
+
* Optional. The sort order of the list results. You can sort the results in descending order based on either email or last update timestamp but not both, using `order_by="email
|
|
994
|
+
* desc"`. Currently, sorting is supported for `update_time asc`, `update_time desc`, `email asc`, and `email desc`. If not specified, results will be returned based on `email asc`
|
|
995
|
+
* order.
|
|
996
|
+
*/
|
|
997
|
+
orderBy?: string;
|
|
998
|
+
/**
|
|
999
|
+
* Optional. The maximum number of UserInvitation resources to return. If unspecified, at most 100 resources will be returned. The maximum value is 200; values above 200 will be
|
|
1000
|
+
* set to 200.
|
|
1001
|
+
*/
|
|
1002
|
+
pageSize?: number;
|
|
1003
|
+
/**
|
|
1004
|
+
* Optional. A page token, received from a previous `ListUserInvitations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
|
|
1005
|
+
* `ListBooks` must match the call that provided the page token.
|
|
1006
|
+
*/
|
|
1007
|
+
pageToken?: string;
|
|
1008
|
+
/** Required. The customer ID of the Google Workspace or Cloud Identity account the UserInvitation resources are associated with. */
|
|
1009
|
+
parent: string;
|
|
1010
|
+
/** Returns response with indentations and line breaks. */
|
|
1011
|
+
prettyPrint?: boolean;
|
|
1012
|
+
/** 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. */
|
|
1013
|
+
quotaUser?: string;
|
|
1014
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1015
|
+
upload_protocol?: string;
|
|
1016
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1017
|
+
uploadType?: string;
|
|
1018
|
+
}): Request<ListUserInvitationsResponse>;
|
|
1019
|
+
/**
|
|
1020
|
+
* Sends a UserInvitation to email. If the `UserInvitation` does not exist for this request and it is a valid request, the request creates a `UserInvitation`. **Note:** The `get` and
|
|
1021
|
+
* `list` methods have a 48-hour delay where newly-created consumer accounts will not appear in the results. You can still send a `UserInvitation` to those accounts if you know the
|
|
1022
|
+
* unmanaged email address and IsInvitableUser==True.
|
|
1023
|
+
*/
|
|
1024
|
+
send(request: {
|
|
1025
|
+
/** V1 error format. */
|
|
1026
|
+
"$.xgafv"?: string;
|
|
1027
|
+
/** OAuth access token. */
|
|
1028
|
+
access_token?: string;
|
|
1029
|
+
/** Data format for response. */
|
|
1030
|
+
alt?: string;
|
|
1031
|
+
/** JSONP */
|
|
1032
|
+
callback?: string;
|
|
1033
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1034
|
+
fields?: string;
|
|
1035
|
+
/** 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. */
|
|
1036
|
+
key?: string;
|
|
1037
|
+
/** Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}` */
|
|
1038
|
+
name: string;
|
|
1039
|
+
/** OAuth 2.0 token for the current user. */
|
|
1040
|
+
oauth_token?: string;
|
|
1041
|
+
/** Returns response with indentations and line breaks. */
|
|
1042
|
+
prettyPrint?: boolean;
|
|
1043
|
+
/** 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. */
|
|
1044
|
+
quotaUser?: string;
|
|
1045
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1046
|
+
upload_protocol?: string;
|
|
1047
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1048
|
+
uploadType?: string;
|
|
1049
|
+
/** Request body */
|
|
1050
|
+
resource: SendUserInvitationRequest;
|
|
1051
|
+
}): Request<Operation>;
|
|
1052
|
+
send(request: {
|
|
1053
|
+
/** V1 error format. */
|
|
1054
|
+
"$.xgafv"?: string;
|
|
1055
|
+
/** OAuth access token. */
|
|
1056
|
+
access_token?: string;
|
|
1057
|
+
/** Data format for response. */
|
|
1058
|
+
alt?: string;
|
|
1059
|
+
/** JSONP */
|
|
1060
|
+
callback?: string;
|
|
1061
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1062
|
+
fields?: string;
|
|
1063
|
+
/** 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. */
|
|
1064
|
+
key?: string;
|
|
1065
|
+
/** Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}` */
|
|
1066
|
+
name: string;
|
|
1067
|
+
/** OAuth 2.0 token for the current user. */
|
|
1068
|
+
oauth_token?: string;
|
|
1069
|
+
/** Returns response with indentations and line breaks. */
|
|
1070
|
+
prettyPrint?: boolean;
|
|
1071
|
+
/** 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. */
|
|
1072
|
+
quotaUser?: string;
|
|
1073
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1074
|
+
upload_protocol?: string;
|
|
1075
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1076
|
+
uploadType?: string;
|
|
1077
|
+
},
|
|
1078
|
+
body: SendUserInvitationRequest): Request<Operation>;
|
|
1079
|
+
}
|
|
1080
|
+
interface CustomersResource {
|
|
1081
|
+
userinvitations: UserinvitationsResource;
|
|
1082
|
+
}
|
|
1083
|
+
interface ClientStatesResource {
|
|
1084
|
+
/** Gets the client state for the device user */
|
|
1085
|
+
get(request?: {
|
|
1086
|
+
/** V1 error format. */
|
|
1087
|
+
"$.xgafv"?: string;
|
|
1088
|
+
/** OAuth access token. */
|
|
1089
|
+
access_token?: string;
|
|
1090
|
+
/** Data format for response. */
|
|
1091
|
+
alt?: string;
|
|
1092
|
+
/** JSONP */
|
|
1093
|
+
callback?: string;
|
|
1094
|
+
/**
|
|
1095
|
+
* Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer`
|
|
1096
|
+
* If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
|
|
1097
|
+
*/
|
|
1098
|
+
customer?: string;
|
|
1099
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1100
|
+
fields?: string;
|
|
1101
|
+
/** 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. */
|
|
1102
|
+
key?: string;
|
|
1103
|
+
/**
|
|
1104
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format:
|
|
1105
|
+
* `devices/{device_id}/deviceUsers/{device_user_id}/clientStates/{partner_id}`, where `device_id` is the unique ID assigned to the Device, `device_user_id` is the unique ID
|
|
1106
|
+
* assigned to the User and `partner_id` identifies the partner storing the data. To get the client state for devices belonging to your own organization, the `partnerId` is in the
|
|
1107
|
+
* format: `customerId-*anystring*`. Where the `customerId` is your organization's customer ID and `anystring` is any suffix. This suffix is used in setting up Custom Access Levels
|
|
1108
|
+
* in Context-Aware Access. You may use `my_customer` instead of the customer ID for devices managed by your own organization. You may specify `-` in place of the `{device_id}`, so
|
|
1109
|
+
* the ClientState resource name can be: `devices/-/deviceUsers/{device_user_resource_id}/clientStates/{partner_id}`.
|
|
1110
|
+
*/
|
|
1111
|
+
name: string;
|
|
1112
|
+
/** OAuth 2.0 token for the current user. */
|
|
1113
|
+
oauth_token?: string;
|
|
1114
|
+
/** Returns response with indentations and line breaks. */
|
|
1115
|
+
prettyPrint?: boolean;
|
|
1116
|
+
/** 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. */
|
|
1117
|
+
quotaUser?: string;
|
|
1118
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1119
|
+
upload_protocol?: string;
|
|
1120
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1121
|
+
uploadType?: string;
|
|
1122
|
+
}): Request<ClientState>;
|
|
1123
|
+
/**
|
|
1124
|
+
* Updates the client state for the device user **Note**: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus,
|
|
1125
|
+
* Enterprise for Education, and Cloud Identity Premium
|
|
1126
|
+
*/
|
|
1127
|
+
patch(request: {
|
|
1128
|
+
/** V1 error format. */
|
|
1129
|
+
"$.xgafv"?: string;
|
|
1130
|
+
/** OAuth access token. */
|
|
1131
|
+
access_token?: string;
|
|
1132
|
+
/** Data format for response. */
|
|
1133
|
+
alt?: string;
|
|
1134
|
+
/** JSONP */
|
|
1135
|
+
callback?: string;
|
|
1136
|
+
/**
|
|
1137
|
+
* Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer`
|
|
1138
|
+
* If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
|
|
1139
|
+
*/
|
|
1140
|
+
customer?: string;
|
|
1141
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1142
|
+
fields?: string;
|
|
1143
|
+
/** 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. */
|
|
1144
|
+
key?: string;
|
|
1145
|
+
/**
|
|
1146
|
+
* Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format:
|
|
1147
|
+
* `devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}`, where partner_id corresponds to the partner storing the data.
|
|
1148
|
+
*/
|
|
1149
|
+
name: string;
|
|
1150
|
+
/** OAuth 2.0 token for the current user. */
|
|
1151
|
+
oauth_token?: string;
|
|
1152
|
+
/** Returns response with indentations and line breaks. */
|
|
1153
|
+
prettyPrint?: boolean;
|
|
1154
|
+
/** 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. */
|
|
1155
|
+
quotaUser?: string;
|
|
1156
|
+
/** Optional. Comma-separated list of fully qualified names of fields to be updated. If not specified, all updatable fields in ClientState are updated. */
|
|
1157
|
+
updateMask?: string;
|
|
1158
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1159
|
+
upload_protocol?: string;
|
|
1160
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1161
|
+
uploadType?: string;
|
|
1162
|
+
/** Request body */
|
|
1163
|
+
resource: ClientState;
|
|
1164
|
+
}): Request<Operation>;
|
|
1165
|
+
patch(request: {
|
|
1166
|
+
/** V1 error format. */
|
|
1167
|
+
"$.xgafv"?: string;
|
|
1168
|
+
/** OAuth access token. */
|
|
1169
|
+
access_token?: string;
|
|
1170
|
+
/** Data format for response. */
|
|
1171
|
+
alt?: string;
|
|
1172
|
+
/** JSONP */
|
|
1173
|
+
callback?: string;
|
|
1174
|
+
/**
|
|
1175
|
+
* Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you're using this API for your own organization, use `customers/my_customer`
|
|
1176
|
+
* If you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
|
|
1177
|
+
*/
|
|
1178
|
+
customer?: string;
|
|
1179
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1180
|
+
fields?: string;
|
|
1181
|
+
/** 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. */
|
|
1182
|
+
key?: string;
|
|
1183
|
+
/**
|
|
1184
|
+
* Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format:
|
|
1185
|
+
* `devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}`, where partner_id corresponds to the partner storing the data.
|
|
1186
|
+
*/
|
|
1187
|
+
name: string;
|
|
1188
|
+
/** OAuth 2.0 token for the current user. */
|
|
1189
|
+
oauth_token?: string;
|
|
1190
|
+
/** Returns response with indentations and line breaks. */
|
|
1191
|
+
prettyPrint?: boolean;
|
|
1192
|
+
/** 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. */
|
|
1193
|
+
quotaUser?: string;
|
|
1194
|
+
/** Optional. Comma-separated list of fully qualified names of fields to be updated. If not specified, all updatable fields in ClientState are updated. */
|
|
1195
|
+
updateMask?: string;
|
|
1196
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1197
|
+
upload_protocol?: string;
|
|
1198
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1199
|
+
uploadType?: string;
|
|
1200
|
+
},
|
|
1201
|
+
body: ClientState): Request<Operation>;
|
|
1202
|
+
}
|
|
1203
|
+
interface DeviceUsersResource {
|
|
1204
|
+
/** Approves device to access user data. */
|
|
1205
|
+
approve(request: {
|
|
1206
|
+
/** V1 error format. */
|
|
1207
|
+
"$.xgafv"?: string;
|
|
1208
|
+
/** OAuth access token. */
|
|
1209
|
+
access_token?: string;
|
|
1210
|
+
/** Data format for response. */
|
|
1211
|
+
alt?: string;
|
|
1212
|
+
/** JSONP */
|
|
1213
|
+
callback?: string;
|
|
1214
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1215
|
+
fields?: string;
|
|
1216
|
+
/** 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. */
|
|
1217
|
+
key?: string;
|
|
1218
|
+
/**
|
|
1219
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is
|
|
1220
|
+
* the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
|
|
1221
|
+
*/
|
|
1222
|
+
name: string;
|
|
1223
|
+
/** OAuth 2.0 token for the current user. */
|
|
1224
|
+
oauth_token?: string;
|
|
1225
|
+
/** Returns response with indentations and line breaks. */
|
|
1226
|
+
prettyPrint?: boolean;
|
|
1227
|
+
/** 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. */
|
|
1228
|
+
quotaUser?: string;
|
|
1229
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1230
|
+
upload_protocol?: string;
|
|
1231
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1232
|
+
uploadType?: string;
|
|
1233
|
+
/** Request body */
|
|
1234
|
+
resource: ApproveDeviceUserRequest;
|
|
1235
|
+
}): Request<Operation>;
|
|
1236
|
+
approve(request: {
|
|
1237
|
+
/** V1 error format. */
|
|
1238
|
+
"$.xgafv"?: string;
|
|
1239
|
+
/** OAuth access token. */
|
|
1240
|
+
access_token?: string;
|
|
1241
|
+
/** Data format for response. */
|
|
1242
|
+
alt?: string;
|
|
1243
|
+
/** JSONP */
|
|
1244
|
+
callback?: string;
|
|
1245
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1246
|
+
fields?: string;
|
|
1247
|
+
/** 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. */
|
|
1248
|
+
key?: string;
|
|
1249
|
+
/**
|
|
1250
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is
|
|
1251
|
+
* the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
|
|
1252
|
+
*/
|
|
1253
|
+
name: string;
|
|
1254
|
+
/** OAuth 2.0 token for the current user. */
|
|
1255
|
+
oauth_token?: string;
|
|
1256
|
+
/** Returns response with indentations and line breaks. */
|
|
1257
|
+
prettyPrint?: boolean;
|
|
1258
|
+
/** 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. */
|
|
1259
|
+
quotaUser?: string;
|
|
1260
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1261
|
+
upload_protocol?: string;
|
|
1262
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1263
|
+
uploadType?: string;
|
|
1264
|
+
},
|
|
1265
|
+
body: ApproveDeviceUserRequest): Request<Operation>;
|
|
1266
|
+
/** Blocks device from accessing user data */
|
|
1267
|
+
block(request: {
|
|
1268
|
+
/** V1 error format. */
|
|
1269
|
+
"$.xgafv"?: string;
|
|
1270
|
+
/** OAuth access token. */
|
|
1271
|
+
access_token?: string;
|
|
1272
|
+
/** Data format for response. */
|
|
1273
|
+
alt?: string;
|
|
1274
|
+
/** JSONP */
|
|
1275
|
+
callback?: string;
|
|
1276
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1277
|
+
fields?: string;
|
|
1278
|
+
/** 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. */
|
|
1279
|
+
key?: string;
|
|
1280
|
+
/**
|
|
1281
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is
|
|
1282
|
+
* the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
|
|
1283
|
+
*/
|
|
1284
|
+
name: string;
|
|
1285
|
+
/** OAuth 2.0 token for the current user. */
|
|
1286
|
+
oauth_token?: string;
|
|
1287
|
+
/** Returns response with indentations and line breaks. */
|
|
1288
|
+
prettyPrint?: boolean;
|
|
1289
|
+
/** 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. */
|
|
1290
|
+
quotaUser?: string;
|
|
1291
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1292
|
+
upload_protocol?: string;
|
|
1293
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1294
|
+
uploadType?: string;
|
|
1295
|
+
/** Request body */
|
|
1296
|
+
resource: BlockDeviceUserRequest;
|
|
1297
|
+
}): Request<Operation>;
|
|
1298
|
+
block(request: {
|
|
1299
|
+
/** V1 error format. */
|
|
1300
|
+
"$.xgafv"?: string;
|
|
1301
|
+
/** OAuth access token. */
|
|
1302
|
+
access_token?: string;
|
|
1303
|
+
/** Data format for response. */
|
|
1304
|
+
alt?: string;
|
|
1305
|
+
/** JSONP */
|
|
1306
|
+
callback?: string;
|
|
1307
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1308
|
+
fields?: string;
|
|
1309
|
+
/** 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. */
|
|
1310
|
+
key?: string;
|
|
1311
|
+
/**
|
|
1312
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is
|
|
1313
|
+
* the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
|
|
1314
|
+
*/
|
|
1315
|
+
name: string;
|
|
1316
|
+
/** OAuth 2.0 token for the current user. */
|
|
1317
|
+
oauth_token?: string;
|
|
1318
|
+
/** Returns response with indentations and line breaks. */
|
|
1319
|
+
prettyPrint?: boolean;
|
|
1320
|
+
/** 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. */
|
|
1321
|
+
quotaUser?: string;
|
|
1322
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1323
|
+
upload_protocol?: string;
|
|
1324
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1325
|
+
uploadType?: string;
|
|
1326
|
+
},
|
|
1327
|
+
body: BlockDeviceUserRequest): Request<Operation>;
|
|
1328
|
+
/** Cancels an unfinished user account wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. */
|
|
1329
|
+
cancelWipe(request: {
|
|
1330
|
+
/** V1 error format. */
|
|
1331
|
+
"$.xgafv"?: string;
|
|
1332
|
+
/** OAuth access token. */
|
|
1333
|
+
access_token?: string;
|
|
1334
|
+
/** Data format for response. */
|
|
1335
|
+
alt?: string;
|
|
1336
|
+
/** JSONP */
|
|
1337
|
+
callback?: string;
|
|
1338
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1339
|
+
fields?: string;
|
|
1340
|
+
/** 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. */
|
|
1341
|
+
key?: string;
|
|
1342
|
+
/**
|
|
1343
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is
|
|
1344
|
+
* the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
|
|
1345
|
+
*/
|
|
1346
|
+
name: string;
|
|
1347
|
+
/** OAuth 2.0 token for the current user. */
|
|
1348
|
+
oauth_token?: string;
|
|
1349
|
+
/** Returns response with indentations and line breaks. */
|
|
1350
|
+
prettyPrint?: boolean;
|
|
1351
|
+
/** 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. */
|
|
1352
|
+
quotaUser?: string;
|
|
1353
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1354
|
+
upload_protocol?: string;
|
|
1355
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1356
|
+
uploadType?: string;
|
|
1357
|
+
/** Request body */
|
|
1358
|
+
resource: CancelWipeDeviceUserRequest;
|
|
1359
|
+
}): Request<Operation>;
|
|
1360
|
+
cancelWipe(request: {
|
|
1361
|
+
/** V1 error format. */
|
|
1362
|
+
"$.xgafv"?: string;
|
|
1363
|
+
/** OAuth access token. */
|
|
1364
|
+
access_token?: string;
|
|
1365
|
+
/** Data format for response. */
|
|
1366
|
+
alt?: string;
|
|
1367
|
+
/** JSONP */
|
|
1368
|
+
callback?: string;
|
|
1369
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1370
|
+
fields?: string;
|
|
1371
|
+
/** 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. */
|
|
1372
|
+
key?: string;
|
|
1373
|
+
/**
|
|
1374
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is
|
|
1375
|
+
* the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
|
|
1376
|
+
*/
|
|
1377
|
+
name: string;
|
|
1378
|
+
/** OAuth 2.0 token for the current user. */
|
|
1379
|
+
oauth_token?: string;
|
|
1380
|
+
/** Returns response with indentations and line breaks. */
|
|
1381
|
+
prettyPrint?: boolean;
|
|
1382
|
+
/** 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. */
|
|
1383
|
+
quotaUser?: string;
|
|
1384
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1385
|
+
upload_protocol?: string;
|
|
1386
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1387
|
+
uploadType?: string;
|
|
1388
|
+
},
|
|
1389
|
+
body: CancelWipeDeviceUserRequest): Request<Operation>;
|
|
1390
|
+
/** Deletes the specified DeviceUser. This also revokes the user's access to device data. */
|
|
1391
|
+
delete(request?: {
|
|
1392
|
+
/** V1 error format. */
|
|
1393
|
+
"$.xgafv"?: string;
|
|
1394
|
+
/** OAuth access token. */
|
|
1395
|
+
access_token?: string;
|
|
1396
|
+
/** Data format for response. */
|
|
1397
|
+
alt?: string;
|
|
1398
|
+
/** JSONP */
|
|
1399
|
+
callback?: string;
|
|
1400
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1401
|
+
fields?: string;
|
|
1402
|
+
/** 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. */
|
|
1403
|
+
key?: string;
|
|
1404
|
+
/**
|
|
1405
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is
|
|
1406
|
+
* the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
|
|
1407
|
+
*/
|
|
1408
|
+
name: string;
|
|
1409
|
+
/** OAuth 2.0 token for the current user. */
|
|
1410
|
+
oauth_token?: string;
|
|
1411
|
+
/** Returns response with indentations and line breaks. */
|
|
1412
|
+
prettyPrint?: boolean;
|
|
1413
|
+
/** 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. */
|
|
1414
|
+
quotaUser?: string;
|
|
1415
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1416
|
+
upload_protocol?: string;
|
|
1417
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1418
|
+
uploadType?: string;
|
|
1419
|
+
}): Request<Operation>;
|
|
1420
|
+
/** Retrieves the specified DeviceUser */
|
|
1421
|
+
get(request?: {
|
|
1422
|
+
/** V1 error format. */
|
|
1423
|
+
"$.xgafv"?: string;
|
|
1424
|
+
/** OAuth access token. */
|
|
1425
|
+
access_token?: string;
|
|
1426
|
+
/** Data format for response. */
|
|
1427
|
+
alt?: string;
|
|
1428
|
+
/** JSONP */
|
|
1429
|
+
callback?: string;
|
|
1430
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1431
|
+
fields?: string;
|
|
1432
|
+
/** 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. */
|
|
1433
|
+
key?: string;
|
|
1434
|
+
/**
|
|
1435
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is
|
|
1436
|
+
* the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
|
|
1437
|
+
*/
|
|
1438
|
+
name: string;
|
|
1439
|
+
/** OAuth 2.0 token for the current user. */
|
|
1440
|
+
oauth_token?: string;
|
|
1441
|
+
/** Returns response with indentations and line breaks. */
|
|
1442
|
+
prettyPrint?: boolean;
|
|
1443
|
+
/** 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. */
|
|
1444
|
+
quotaUser?: string;
|
|
1445
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1446
|
+
upload_protocol?: string;
|
|
1447
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1448
|
+
uploadType?: string;
|
|
1449
|
+
}): Request<DeviceUser>;
|
|
1450
|
+
/** Lists/Searches DeviceUsers. */
|
|
1451
|
+
list(request?: {
|
|
1452
|
+
/** V1 error format. */
|
|
1453
|
+
"$.xgafv"?: string;
|
|
1454
|
+
/** OAuth access token. */
|
|
1455
|
+
access_token?: string;
|
|
1456
|
+
/** Data format for response. */
|
|
1457
|
+
alt?: string;
|
|
1458
|
+
/** JSONP */
|
|
1459
|
+
callback?: string;
|
|
1460
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1461
|
+
fields?: string;
|
|
1462
|
+
/**
|
|
1463
|
+
* Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to [Mobile device search
|
|
1464
|
+
* fields](https://developers.google.com/admin-sdk/directory/v1/search-operators). Multiple search fields are separated by the space character.
|
|
1465
|
+
*/
|
|
1466
|
+
filter?: string;
|
|
1467
|
+
/** 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. */
|
|
1468
|
+
key?: string;
|
|
1469
|
+
/** OAuth 2.0 token for the current user. */
|
|
1470
|
+
oauth_token?: string;
|
|
1471
|
+
/** Optional. Order specification for devices in the response. */
|
|
1472
|
+
orderBy?: string;
|
|
1473
|
+
/** Optional. The maximum number of DeviceUsers to return. If unspecified, at most 5 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20. */
|
|
1474
|
+
pageSize?: number;
|
|
1475
|
+
/**
|
|
1476
|
+
* Optional. A page token, received from a previous `ListDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
|
|
1477
|
+
* `ListBooks` must match the call that provided the page token.
|
|
1478
|
+
*/
|
|
1479
|
+
pageToken?: string;
|
|
1480
|
+
/** Required. To list all DeviceUsers, set this to "devices/-". To list all DeviceUsers owned by a device, set this to the resource name of the device. Format: devices/{device} */
|
|
1481
|
+
parent: string;
|
|
1482
|
+
/** Returns response with indentations and line breaks. */
|
|
1483
|
+
prettyPrint?: boolean;
|
|
1484
|
+
/** 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. */
|
|
1485
|
+
quotaUser?: string;
|
|
1486
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1487
|
+
upload_protocol?: string;
|
|
1488
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1489
|
+
uploadType?: string;
|
|
1490
|
+
}): Request<ListDeviceUsersResponse>;
|
|
1491
|
+
/**
|
|
1492
|
+
* Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user
|
|
1493
|
+
* credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are
|
|
1494
|
+
* considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely
|
|
1495
|
+
* identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is
|
|
1496
|
+
* required. - Desktop: Specifying the 'raw_resource_id' field is required.
|
|
1497
|
+
*/
|
|
1498
|
+
lookup(request?: {
|
|
1499
|
+
/** V1 error format. */
|
|
1500
|
+
"$.xgafv"?: string;
|
|
1501
|
+
/** OAuth access token. */
|
|
1502
|
+
access_token?: string;
|
|
1503
|
+
/** Data format for response. */
|
|
1504
|
+
alt?: string;
|
|
1505
|
+
/** Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID). */
|
|
1506
|
+
androidId?: string;
|
|
1507
|
+
/** JSONP */
|
|
1508
|
+
callback?: string;
|
|
1509
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1510
|
+
fields?: string;
|
|
1511
|
+
/** 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. */
|
|
1512
|
+
key?: string;
|
|
1513
|
+
/** OAuth 2.0 token for the current user. */
|
|
1514
|
+
oauth_token?: string;
|
|
1515
|
+
/** The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20. */
|
|
1516
|
+
pageSize?: number;
|
|
1517
|
+
/**
|
|
1518
|
+
* A page token, received from a previous `LookupDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
|
|
1519
|
+
* `LookupDeviceUsers` must match the call that provided the page token.
|
|
1520
|
+
*/
|
|
1521
|
+
pageToken?: string;
|
|
1522
|
+
/** Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user. */
|
|
1523
|
+
parent: string;
|
|
1524
|
+
/** Returns response with indentations and line breaks. */
|
|
1525
|
+
prettyPrint?: boolean;
|
|
1526
|
+
/** 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. */
|
|
1527
|
+
quotaUser?: string;
|
|
1528
|
+
/**
|
|
1529
|
+
* Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the
|
|
1530
|
+
* following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\.secureConnect\context_aware_config.json Linux:
|
|
1531
|
+
* ~/.secureConnect/context_aware_config.json
|
|
1532
|
+
*/
|
|
1533
|
+
rawResourceId?: string;
|
|
1534
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1535
|
+
upload_protocol?: string;
|
|
1536
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1537
|
+
uploadType?: string;
|
|
1538
|
+
/** The user whose DeviceUser's resource name will be fetched. Must be set to 'me' to fetch the DeviceUser's resource name for the calling user. */
|
|
1539
|
+
userId?: string;
|
|
1540
|
+
}): Request<LookupSelfDeviceUsersResponse>;
|
|
1541
|
+
/** Wipes the user's account on a device. */
|
|
1542
|
+
wipe(request: {
|
|
1543
|
+
/** V1 error format. */
|
|
1544
|
+
"$.xgafv"?: string;
|
|
1545
|
+
/** OAuth access token. */
|
|
1546
|
+
access_token?: string;
|
|
1547
|
+
/** Data format for response. */
|
|
1548
|
+
alt?: string;
|
|
1549
|
+
/** JSONP */
|
|
1550
|
+
callback?: string;
|
|
1551
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1552
|
+
fields?: string;
|
|
1553
|
+
/** 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. */
|
|
1554
|
+
key?: string;
|
|
1555
|
+
/**
|
|
1556
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is
|
|
1557
|
+
* the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
|
|
1558
|
+
*/
|
|
1559
|
+
name: string;
|
|
1560
|
+
/** OAuth 2.0 token for the current user. */
|
|
1561
|
+
oauth_token?: string;
|
|
1562
|
+
/** Returns response with indentations and line breaks. */
|
|
1563
|
+
prettyPrint?: boolean;
|
|
1564
|
+
/** 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. */
|
|
1565
|
+
quotaUser?: string;
|
|
1566
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1567
|
+
upload_protocol?: string;
|
|
1568
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1569
|
+
uploadType?: string;
|
|
1570
|
+
/** Request body */
|
|
1571
|
+
resource: WipeDeviceUserRequest;
|
|
1572
|
+
}): Request<Operation>;
|
|
1573
|
+
wipe(request: {
|
|
1574
|
+
/** V1 error format. */
|
|
1575
|
+
"$.xgafv"?: string;
|
|
1576
|
+
/** OAuth access token. */
|
|
1577
|
+
access_token?: string;
|
|
1578
|
+
/** Data format for response. */
|
|
1579
|
+
alt?: string;
|
|
1580
|
+
/** JSONP */
|
|
1581
|
+
callback?: string;
|
|
1582
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1583
|
+
fields?: string;
|
|
1584
|
+
/** 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. */
|
|
1585
|
+
key?: string;
|
|
1586
|
+
/**
|
|
1587
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is
|
|
1588
|
+
* the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
|
|
1589
|
+
*/
|
|
1590
|
+
name: string;
|
|
1591
|
+
/** OAuth 2.0 token for the current user. */
|
|
1592
|
+
oauth_token?: string;
|
|
1593
|
+
/** Returns response with indentations and line breaks. */
|
|
1594
|
+
prettyPrint?: boolean;
|
|
1595
|
+
/** 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. */
|
|
1596
|
+
quotaUser?: string;
|
|
1597
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1598
|
+
upload_protocol?: string;
|
|
1599
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1600
|
+
uploadType?: string;
|
|
1601
|
+
},
|
|
1602
|
+
body: WipeDeviceUserRequest): Request<Operation>;
|
|
1603
|
+
clientStates: ClientStatesResource;
|
|
1604
|
+
}
|
|
1605
|
+
interface DevicesResource {
|
|
1606
|
+
/** Cancels an unfinished device wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped. */
|
|
1607
|
+
cancelWipe(request: {
|
|
1608
|
+
/** V1 error format. */
|
|
1609
|
+
"$.xgafv"?: string;
|
|
1610
|
+
/** OAuth access token. */
|
|
1611
|
+
access_token?: string;
|
|
1612
|
+
/** Data format for response. */
|
|
1613
|
+
alt?: string;
|
|
1614
|
+
/** JSONP */
|
|
1615
|
+
callback?: string;
|
|
1616
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1617
|
+
fields?: string;
|
|
1618
|
+
/** 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. */
|
|
1619
|
+
key?: string;
|
|
1620
|
+
/**
|
|
1621
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the
|
|
1622
|
+
* Device.
|
|
1623
|
+
*/
|
|
1624
|
+
name: string;
|
|
1625
|
+
/** OAuth 2.0 token for the current user. */
|
|
1626
|
+
oauth_token?: string;
|
|
1627
|
+
/** Returns response with indentations and line breaks. */
|
|
1628
|
+
prettyPrint?: boolean;
|
|
1629
|
+
/** 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. */
|
|
1630
|
+
quotaUser?: string;
|
|
1631
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1632
|
+
upload_protocol?: string;
|
|
1633
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1634
|
+
uploadType?: string;
|
|
1635
|
+
/** Request body */
|
|
1636
|
+
resource: CancelWipeDeviceRequest;
|
|
1637
|
+
}): Request<Operation>;
|
|
1638
|
+
cancelWipe(request: {
|
|
1639
|
+
/** V1 error format. */
|
|
1640
|
+
"$.xgafv"?: string;
|
|
1641
|
+
/** OAuth access token. */
|
|
1642
|
+
access_token?: string;
|
|
1643
|
+
/** Data format for response. */
|
|
1644
|
+
alt?: string;
|
|
1645
|
+
/** JSONP */
|
|
1646
|
+
callback?: string;
|
|
1647
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1648
|
+
fields?: string;
|
|
1649
|
+
/** 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. */
|
|
1650
|
+
key?: string;
|
|
1651
|
+
/**
|
|
1652
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the
|
|
1653
|
+
* Device.
|
|
1654
|
+
*/
|
|
1655
|
+
name: string;
|
|
1656
|
+
/** OAuth 2.0 token for the current user. */
|
|
1657
|
+
oauth_token?: string;
|
|
1658
|
+
/** Returns response with indentations and line breaks. */
|
|
1659
|
+
prettyPrint?: boolean;
|
|
1660
|
+
/** 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. */
|
|
1661
|
+
quotaUser?: string;
|
|
1662
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1663
|
+
upload_protocol?: string;
|
|
1664
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1665
|
+
uploadType?: string;
|
|
1666
|
+
},
|
|
1667
|
+
body: CancelWipeDeviceRequest): Request<Operation>;
|
|
1668
|
+
/**
|
|
1669
|
+
* Creates a device. Only company-owned device may be created. **Note**: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise
|
|
1670
|
+
* Plus, Enterprise for Education, and Cloud Identity Premium
|
|
1671
|
+
*/
|
|
1672
|
+
create(request: {
|
|
1673
|
+
/** V1 error format. */
|
|
1674
|
+
"$.xgafv"?: string;
|
|
1675
|
+
/** OAuth access token. */
|
|
1676
|
+
access_token?: string;
|
|
1677
|
+
/** Data format for response. */
|
|
1678
|
+
alt?: string;
|
|
1679
|
+
/** JSONP */
|
|
1680
|
+
callback?: string;
|
|
1681
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1682
|
+
fields?: string;
|
|
1683
|
+
/** 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. */
|
|
1684
|
+
key?: string;
|
|
1685
|
+
/** OAuth 2.0 token for the current user. */
|
|
1686
|
+
oauth_token?: string;
|
|
1687
|
+
/** Returns response with indentations and line breaks. */
|
|
1688
|
+
prettyPrint?: boolean;
|
|
1689
|
+
/** 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. */
|
|
1690
|
+
quotaUser?: string;
|
|
1691
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1692
|
+
upload_protocol?: string;
|
|
1693
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1694
|
+
uploadType?: string;
|
|
1695
|
+
/** Request body */
|
|
1696
|
+
resource: CreateDeviceRequest;
|
|
1697
|
+
}): Request<Operation>;
|
|
1698
|
+
create(request: {
|
|
1699
|
+
/** V1 error format. */
|
|
1700
|
+
"$.xgafv"?: string;
|
|
1701
|
+
/** OAuth access token. */
|
|
1702
|
+
access_token?: string;
|
|
1703
|
+
/** Data format for response. */
|
|
1704
|
+
alt?: string;
|
|
1705
|
+
/** JSONP */
|
|
1706
|
+
callback?: string;
|
|
1707
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1708
|
+
fields?: string;
|
|
1709
|
+
/** 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. */
|
|
1710
|
+
key?: string;
|
|
1711
|
+
/** OAuth 2.0 token for the current user. */
|
|
1712
|
+
oauth_token?: string;
|
|
1713
|
+
/** Returns response with indentations and line breaks. */
|
|
1714
|
+
prettyPrint?: boolean;
|
|
1715
|
+
/** 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. */
|
|
1716
|
+
quotaUser?: string;
|
|
1717
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1718
|
+
upload_protocol?: string;
|
|
1719
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1720
|
+
uploadType?: string;
|
|
1721
|
+
},
|
|
1722
|
+
body: CreateDeviceRequest): Request<Operation>;
|
|
1723
|
+
/** Deletes the specified device. */
|
|
1724
|
+
delete(request?: {
|
|
1725
|
+
/** V1 error format. */
|
|
1726
|
+
"$.xgafv"?: string;
|
|
1727
|
+
/** OAuth access token. */
|
|
1728
|
+
access_token?: string;
|
|
1729
|
+
/** Data format for response. */
|
|
1730
|
+
alt?: string;
|
|
1731
|
+
/** JSONP */
|
|
1732
|
+
callback?: string;
|
|
1733
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1734
|
+
fields?: string;
|
|
1735
|
+
/** 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. */
|
|
1736
|
+
key?: string;
|
|
1737
|
+
/**
|
|
1738
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the
|
|
1739
|
+
* Device.
|
|
1740
|
+
*/
|
|
1741
|
+
name: string;
|
|
1742
|
+
/** OAuth 2.0 token for the current user. */
|
|
1743
|
+
oauth_token?: string;
|
|
1744
|
+
/** Returns response with indentations and line breaks. */
|
|
1745
|
+
prettyPrint?: boolean;
|
|
1746
|
+
/** 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. */
|
|
1747
|
+
quotaUser?: string;
|
|
1748
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1749
|
+
upload_protocol?: string;
|
|
1750
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1751
|
+
uploadType?: string;
|
|
1752
|
+
}): Request<Operation>;
|
|
1753
|
+
/** Retrieves the specified device. */
|
|
1754
|
+
get(request?: {
|
|
1755
|
+
/** V1 error format. */
|
|
1756
|
+
"$.xgafv"?: string;
|
|
1757
|
+
/** OAuth access token. */
|
|
1758
|
+
access_token?: string;
|
|
1759
|
+
/** Data format for response. */
|
|
1760
|
+
alt?: string;
|
|
1761
|
+
/** JSONP */
|
|
1762
|
+
callback?: string;
|
|
1763
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1764
|
+
fields?: string;
|
|
1765
|
+
/** 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. */
|
|
1766
|
+
key?: string;
|
|
1767
|
+
/**
|
|
1768
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique ID assigned to the
|
|
1769
|
+
* Device.
|
|
1770
|
+
*/
|
|
1771
|
+
name: string;
|
|
1772
|
+
/** OAuth 2.0 token for the current user. */
|
|
1773
|
+
oauth_token?: string;
|
|
1774
|
+
/** Returns response with indentations and line breaks. */
|
|
1775
|
+
prettyPrint?: boolean;
|
|
1776
|
+
/** 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. */
|
|
1777
|
+
quotaUser?: string;
|
|
1778
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1779
|
+
upload_protocol?: string;
|
|
1780
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1781
|
+
uploadType?: string;
|
|
1782
|
+
}): Request<Device>;
|
|
1783
|
+
/** Lists/Searches devices. */
|
|
1784
|
+
list(request?: {
|
|
1785
|
+
/** V1 error format. */
|
|
1786
|
+
"$.xgafv"?: string;
|
|
1787
|
+
/** OAuth access token. */
|
|
1788
|
+
access_token?: string;
|
|
1789
|
+
/** Data format for response. */
|
|
1790
|
+
alt?: string;
|
|
1791
|
+
/** JSONP */
|
|
1792
|
+
callback?: string;
|
|
1793
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1794
|
+
fields?: string;
|
|
1795
|
+
/**
|
|
1796
|
+
* Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to [Mobile device search
|
|
1797
|
+
* fields](https://developers.google.com/admin-sdk/directory/v1/search-operators). Multiple search fields are separated by the space character.
|
|
1798
|
+
*/
|
|
1799
|
+
filter?: string;
|
|
1800
|
+
/** 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. */
|
|
1801
|
+
key?: string;
|
|
1802
|
+
/** OAuth 2.0 token for the current user. */
|
|
1803
|
+
oauth_token?: string;
|
|
1804
|
+
/**
|
|
1805
|
+
* Optional. Order specification for devices in the response. Only one of the following field names may be used to specify the order: `create_time`, `last_sync_time`, `model`,
|
|
1806
|
+
* `os_version`, `device_type` and `serial_number`. `desc` may be specified optionally to specify results to be sorted in descending order. Default order is ascending.
|
|
1807
|
+
*/
|
|
1808
|
+
orderBy?: string;
|
|
1809
|
+
/** Optional. The maximum number of Devices to return. If unspecified, at most 20 Devices will be returned. The maximum value is 100; values above 100 will be coerced to 100. */
|
|
1810
|
+
pageSize?: number;
|
|
1811
|
+
/**
|
|
1812
|
+
* Optional. A page token, received from a previous `ListDevices` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
|
|
1813
|
+
* `ListDevices` must match the call that provided the page token.
|
|
1814
|
+
*/
|
|
1815
|
+
pageToken?: string;
|
|
1816
|
+
/** Returns response with indentations and line breaks. */
|
|
1817
|
+
prettyPrint?: boolean;
|
|
1818
|
+
/** 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. */
|
|
1819
|
+
quotaUser?: string;
|
|
1820
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1821
|
+
upload_protocol?: string;
|
|
1822
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1823
|
+
uploadType?: string;
|
|
1824
|
+
/** Optional. The view to use for the List request. */
|
|
1825
|
+
view?: string;
|
|
1826
|
+
}): Request<ListDevicesResponse>;
|
|
1827
|
+
/** Wipes all data on the specified device. */
|
|
1828
|
+
wipe(request: {
|
|
1829
|
+
/** V1 error format. */
|
|
1830
|
+
"$.xgafv"?: string;
|
|
1831
|
+
/** OAuth access token. */
|
|
1832
|
+
access_token?: string;
|
|
1833
|
+
/** Data format for response. */
|
|
1834
|
+
alt?: string;
|
|
1835
|
+
/** JSONP */
|
|
1836
|
+
callback?: string;
|
|
1837
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1838
|
+
fields?: string;
|
|
1839
|
+
/** 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. */
|
|
1840
|
+
key?: string;
|
|
1841
|
+
/**
|
|
1842
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is
|
|
1843
|
+
* the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
|
|
1844
|
+
*/
|
|
1845
|
+
name: string;
|
|
1846
|
+
/** OAuth 2.0 token for the current user. */
|
|
1847
|
+
oauth_token?: string;
|
|
1848
|
+
/** Returns response with indentations and line breaks. */
|
|
1849
|
+
prettyPrint?: boolean;
|
|
1850
|
+
/** 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. */
|
|
1851
|
+
quotaUser?: string;
|
|
1852
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1853
|
+
upload_protocol?: string;
|
|
1854
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1855
|
+
uploadType?: string;
|
|
1856
|
+
/** Request body */
|
|
1857
|
+
resource: WipeDeviceRequest;
|
|
1858
|
+
}): Request<Operation>;
|
|
1859
|
+
wipe(request: {
|
|
1860
|
+
/** V1 error format. */
|
|
1861
|
+
"$.xgafv"?: string;
|
|
1862
|
+
/** OAuth access token. */
|
|
1863
|
+
access_token?: string;
|
|
1864
|
+
/** Data format for response. */
|
|
1865
|
+
alt?: string;
|
|
1866
|
+
/** JSONP */
|
|
1867
|
+
callback?: string;
|
|
1868
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1869
|
+
fields?: string;
|
|
1870
|
+
/** 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. */
|
|
1871
|
+
key?: string;
|
|
1872
|
+
/**
|
|
1873
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is
|
|
1874
|
+
* the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User.
|
|
1875
|
+
*/
|
|
1876
|
+
name: string;
|
|
1877
|
+
/** OAuth 2.0 token for the current user. */
|
|
1878
|
+
oauth_token?: string;
|
|
1879
|
+
/** Returns response with indentations and line breaks. */
|
|
1880
|
+
prettyPrint?: boolean;
|
|
1881
|
+
/** 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. */
|
|
1882
|
+
quotaUser?: string;
|
|
1883
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1884
|
+
upload_protocol?: string;
|
|
1885
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1886
|
+
uploadType?: string;
|
|
1887
|
+
},
|
|
1888
|
+
body: WipeDeviceRequest): Request<Operation>;
|
|
1889
|
+
deviceUsers: DeviceUsersResource;
|
|
1890
|
+
}
|
|
1891
|
+
interface MembershipsResource {
|
|
1892
|
+
/**
|
|
1893
|
+
* Check a potential member for membership in a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education;
|
|
1894
|
+
* and Cloud Identity Premium accounts. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must
|
|
1895
|
+
* have view permissions to at least one transitive membership between the member and group.
|
|
1896
|
+
*/
|
|
1897
|
+
checkTransitiveMembership(request?: {
|
|
1898
|
+
/** V1 error format. */
|
|
1899
|
+
"$.xgafv"?: string;
|
|
1900
|
+
/** OAuth access token. */
|
|
1901
|
+
access_token?: string;
|
|
1902
|
+
/** Data format for response. */
|
|
1903
|
+
alt?: string;
|
|
1904
|
+
/** JSONP */
|
|
1905
|
+
callback?: string;
|
|
1906
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1907
|
+
fields?: string;
|
|
1908
|
+
/** 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. */
|
|
1909
|
+
key?: string;
|
|
1910
|
+
/** OAuth 2.0 token for the current user. */
|
|
1911
|
+
oauth_token?: string;
|
|
1912
|
+
/**
|
|
1913
|
+
* [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to check the transitive membership in. Format: `groups/{group_id}`, where `group_id` is the
|
|
1914
|
+
* unique id assigned to the Group to which the Membership belongs to.
|
|
1915
|
+
*/
|
|
1916
|
+
parent: string;
|
|
1917
|
+
/** Returns response with indentations and line breaks. */
|
|
1918
|
+
prettyPrint?: boolean;
|
|
1919
|
+
/**
|
|
1920
|
+
* Required. A CEL expression that MUST include member specification. This is a `required` field. Certain groups are uniquely identified by both a 'member_key_id' and a
|
|
1921
|
+
* 'member_key_namespace', which requires an additional query input: 'member_key_namespace'. Example query: `member_key_id == 'member_key_id_value'`
|
|
1922
|
+
*/
|
|
1923
|
+
query?: string;
|
|
1924
|
+
/** 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. */
|
|
1925
|
+
quotaUser?: string;
|
|
1926
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1927
|
+
upload_protocol?: string;
|
|
1928
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1929
|
+
uploadType?: string;
|
|
1930
|
+
}): Request<CheckTransitiveMembershipResponse>;
|
|
1931
|
+
/** Creates a `Membership`. */
|
|
1932
|
+
create(request: {
|
|
1933
|
+
/** V1 error format. */
|
|
1934
|
+
"$.xgafv"?: string;
|
|
1935
|
+
/** OAuth access token. */
|
|
1936
|
+
access_token?: string;
|
|
1937
|
+
/** Data format for response. */
|
|
1938
|
+
alt?: string;
|
|
1939
|
+
/** JSONP */
|
|
1940
|
+
callback?: string;
|
|
1941
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1942
|
+
fields?: string;
|
|
1943
|
+
/** 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. */
|
|
1944
|
+
key?: string;
|
|
1945
|
+
/** OAuth 2.0 token for the current user. */
|
|
1946
|
+
oauth_token?: string;
|
|
1947
|
+
/** Required. The parent `Group` resource under which to create the `Membership`. Must be of the form `groups/{group_id}`. */
|
|
1948
|
+
parent: string;
|
|
1949
|
+
/** Returns response with indentations and line breaks. */
|
|
1950
|
+
prettyPrint?: boolean;
|
|
1951
|
+
/** 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. */
|
|
1952
|
+
quotaUser?: string;
|
|
1953
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1954
|
+
upload_protocol?: string;
|
|
1955
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1956
|
+
uploadType?: string;
|
|
1957
|
+
/** Request body */
|
|
1958
|
+
resource: Membership;
|
|
1959
|
+
}): Request<Operation>;
|
|
1960
|
+
create(request: {
|
|
1961
|
+
/** V1 error format. */
|
|
1962
|
+
"$.xgafv"?: string;
|
|
1963
|
+
/** OAuth access token. */
|
|
1964
|
+
access_token?: string;
|
|
1965
|
+
/** Data format for response. */
|
|
1966
|
+
alt?: string;
|
|
1967
|
+
/** JSONP */
|
|
1968
|
+
callback?: string;
|
|
1969
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1970
|
+
fields?: string;
|
|
1971
|
+
/** 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. */
|
|
1972
|
+
key?: string;
|
|
1973
|
+
/** OAuth 2.0 token for the current user. */
|
|
1974
|
+
oauth_token?: string;
|
|
1975
|
+
/** Required. The parent `Group` resource under which to create the `Membership`. Must be of the form `groups/{group_id}`. */
|
|
1976
|
+
parent: string;
|
|
1977
|
+
/** Returns response with indentations and line breaks. */
|
|
1978
|
+
prettyPrint?: boolean;
|
|
1979
|
+
/** 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. */
|
|
1980
|
+
quotaUser?: string;
|
|
1981
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1982
|
+
upload_protocol?: string;
|
|
1983
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1984
|
+
uploadType?: string;
|
|
1985
|
+
},
|
|
1986
|
+
body: Membership): Request<Operation>;
|
|
1987
|
+
/** Deletes a `Membership`. */
|
|
1988
|
+
delete(request?: {
|
|
1989
|
+
/** V1 error format. */
|
|
1990
|
+
"$.xgafv"?: string;
|
|
1991
|
+
/** OAuth access token. */
|
|
1992
|
+
access_token?: string;
|
|
1993
|
+
/** Data format for response. */
|
|
1994
|
+
alt?: string;
|
|
1995
|
+
/** JSONP */
|
|
1996
|
+
callback?: string;
|
|
1997
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1998
|
+
fields?: string;
|
|
1999
|
+
/** 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. */
|
|
2000
|
+
key?: string;
|
|
2001
|
+
/**
|
|
2002
|
+
* Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to delete. Must be of the form
|
|
2003
|
+
* `groups/{group_id}/memberships/{membership_id}`.
|
|
2004
|
+
*/
|
|
2005
|
+
name: string;
|
|
2006
|
+
/** OAuth 2.0 token for the current user. */
|
|
2007
|
+
oauth_token?: string;
|
|
2008
|
+
/** Returns response with indentations and line breaks. */
|
|
2009
|
+
prettyPrint?: boolean;
|
|
2010
|
+
/** 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. */
|
|
2011
|
+
quotaUser?: string;
|
|
2012
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2013
|
+
upload_protocol?: string;
|
|
2014
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2015
|
+
uploadType?: string;
|
|
2016
|
+
}): Request<Operation>;
|
|
2017
|
+
/** Retrieves a `Membership`. */
|
|
2018
|
+
get(request?: {
|
|
2019
|
+
/** V1 error format. */
|
|
2020
|
+
"$.xgafv"?: string;
|
|
2021
|
+
/** OAuth access token. */
|
|
2022
|
+
access_token?: string;
|
|
2023
|
+
/** Data format for response. */
|
|
2024
|
+
alt?: string;
|
|
2025
|
+
/** JSONP */
|
|
2026
|
+
callback?: string;
|
|
2027
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2028
|
+
fields?: string;
|
|
2029
|
+
/** 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. */
|
|
2030
|
+
key?: string;
|
|
2031
|
+
/**
|
|
2032
|
+
* Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to retrieve. Must be of the form
|
|
2033
|
+
* `groups/{group_id}/memberships/{membership_id}`.
|
|
2034
|
+
*/
|
|
2035
|
+
name: string;
|
|
2036
|
+
/** OAuth 2.0 token for the current user. */
|
|
2037
|
+
oauth_token?: string;
|
|
2038
|
+
/** Returns response with indentations and line breaks. */
|
|
2039
|
+
prettyPrint?: boolean;
|
|
2040
|
+
/** 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. */
|
|
2041
|
+
quotaUser?: string;
|
|
2042
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2043
|
+
upload_protocol?: string;
|
|
2044
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2045
|
+
uploadType?: string;
|
|
2046
|
+
}): Request<Membership>;
|
|
2047
|
+
/**
|
|
2048
|
+
* Get a membership graph of just a member or both a member and a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and
|
|
2049
|
+
* Enterprise for Education; and Cloud Identity Premium accounts. Given a member, the response will contain all membership paths from the member. Given both a group and a member, the
|
|
2050
|
+
* response will contain all membership paths between the group and the member.
|
|
2051
|
+
*/
|
|
2052
|
+
getMembershipGraph(request?: {
|
|
2053
|
+
/** V1 error format. */
|
|
2054
|
+
"$.xgafv"?: string;
|
|
2055
|
+
/** OAuth access token. */
|
|
2056
|
+
access_token?: string;
|
|
2057
|
+
/** Data format for response. */
|
|
2058
|
+
alt?: string;
|
|
2059
|
+
/** JSONP */
|
|
2060
|
+
callback?: string;
|
|
2061
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2062
|
+
fields?: string;
|
|
2063
|
+
/** 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. */
|
|
2064
|
+
key?: string;
|
|
2065
|
+
/** OAuth 2.0 token for the current user. */
|
|
2066
|
+
oauth_token?: string;
|
|
2067
|
+
/**
|
|
2068
|
+
* Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is
|
|
2069
|
+
* the unique ID assigned to the Group to which the Membership belongs to. group_id can be a wildcard collection id "-". When a group_id is specified, the membership graph will be
|
|
2070
|
+
* constrained to paths between the member (defined in the query) and the parent. If a wildcard collection is provided, all membership paths connected to the member will be
|
|
2071
|
+
* returned.
|
|
2072
|
+
*/
|
|
2073
|
+
parent: string;
|
|
2074
|
+
/** Returns response with indentations and line breaks. */
|
|
2075
|
+
prettyPrint?: boolean;
|
|
2076
|
+
/**
|
|
2077
|
+
* Required. A CEL expression that MUST include member specification AND label(s). Certain groups are uniquely identified by both a 'member_key_id' and a 'member_key_namespace',
|
|
2078
|
+
* which requires an additional query input: 'member_key_namespace'. Example query: `member_key_id == 'member_key_id_value' && in labels`
|
|
2079
|
+
*/
|
|
2080
|
+
query?: string;
|
|
2081
|
+
/** 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. */
|
|
2082
|
+
quotaUser?: string;
|
|
2083
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2084
|
+
upload_protocol?: string;
|
|
2085
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2086
|
+
uploadType?: string;
|
|
2087
|
+
}): Request<Operation>;
|
|
2088
|
+
/** Lists the `Membership`s within a `Group`. */
|
|
2089
|
+
list(request?: {
|
|
2090
|
+
/** V1 error format. */
|
|
2091
|
+
"$.xgafv"?: string;
|
|
2092
|
+
/** OAuth access token. */
|
|
2093
|
+
access_token?: string;
|
|
2094
|
+
/** Data format for response. */
|
|
2095
|
+
alt?: string;
|
|
2096
|
+
/** JSONP */
|
|
2097
|
+
callback?: string;
|
|
2098
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2099
|
+
fields?: string;
|
|
2100
|
+
/** 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. */
|
|
2101
|
+
key?: string;
|
|
2102
|
+
/** OAuth 2.0 token for the current user. */
|
|
2103
|
+
oauth_token?: string;
|
|
2104
|
+
/**
|
|
2105
|
+
* The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results,
|
|
2106
|
+
* clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and to 50
|
|
2107
|
+
* for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.
|
|
2108
|
+
*/
|
|
2109
|
+
pageSize?: number;
|
|
2110
|
+
/** The `next_page_token` value returned from a previous search request, if any. */
|
|
2111
|
+
pageToken?: string;
|
|
2112
|
+
/** Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. */
|
|
2113
|
+
parent: string;
|
|
2114
|
+
/** Returns response with indentations and line breaks. */
|
|
2115
|
+
prettyPrint?: boolean;
|
|
2116
|
+
/** 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. */
|
|
2117
|
+
quotaUser?: string;
|
|
2118
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2119
|
+
upload_protocol?: string;
|
|
2120
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2121
|
+
uploadType?: string;
|
|
2122
|
+
/** The level of detail to be returned. If unspecified, defaults to `MembershipView.BASIC`. */
|
|
2123
|
+
view?: string;
|
|
2124
|
+
}): Request<ListMembershipsResponse>;
|
|
2125
|
+
/** Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Membership` by its `EntityKey`. */
|
|
2126
|
+
lookup(request?: {
|
|
2127
|
+
/** V1 error format. */
|
|
2128
|
+
"$.xgafv"?: string;
|
|
2129
|
+
/** OAuth access token. */
|
|
2130
|
+
access_token?: string;
|
|
2131
|
+
/** Data format for response. */
|
|
2132
|
+
alt?: string;
|
|
2133
|
+
/** JSONP */
|
|
2134
|
+
callback?: string;
|
|
2135
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2136
|
+
fields?: string;
|
|
2137
|
+
/** 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. */
|
|
2138
|
+
key?: string;
|
|
2139
|
+
/**
|
|
2140
|
+
* The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a
|
|
2141
|
+
* string conforming to the Identity Source's requirements. Must be unique within a `namespace`.
|
|
2142
|
+
*/
|
|
2143
|
+
"memberKey.id"?: string;
|
|
2144
|
+
/**
|
|
2145
|
+
* The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the
|
|
2146
|
+
* `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of
|
|
2147
|
+
* `identitysources/{identity_source_id}`.
|
|
2148
|
+
*/
|
|
2149
|
+
"memberKey.namespace"?: string;
|
|
2150
|
+
/** OAuth 2.0 token for the current user. */
|
|
2151
|
+
oauth_token?: string;
|
|
2152
|
+
/** Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. */
|
|
2153
|
+
parent: string;
|
|
2154
|
+
/** Returns response with indentations and line breaks. */
|
|
2155
|
+
prettyPrint?: boolean;
|
|
2156
|
+
/** 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. */
|
|
2157
|
+
quotaUser?: string;
|
|
2158
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2159
|
+
upload_protocol?: string;
|
|
2160
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2161
|
+
uploadType?: string;
|
|
2162
|
+
}): Request<LookupMembershipNameResponse>;
|
|
2163
|
+
/** Modifies the `MembershipRole`s of a `Membership`. */
|
|
2164
|
+
modifyMembershipRoles(request: {
|
|
2165
|
+
/** V1 error format. */
|
|
2166
|
+
"$.xgafv"?: string;
|
|
2167
|
+
/** OAuth access token. */
|
|
2168
|
+
access_token?: string;
|
|
2169
|
+
/** Data format for response. */
|
|
2170
|
+
alt?: string;
|
|
2171
|
+
/** JSONP */
|
|
2172
|
+
callback?: string;
|
|
2173
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2174
|
+
fields?: string;
|
|
2175
|
+
/** 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. */
|
|
2176
|
+
key?: string;
|
|
2177
|
+
/**
|
|
2178
|
+
* Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` whose roles are to be modified. Must be of the form
|
|
2179
|
+
* `groups/{group_id}/memberships/{membership_id}`.
|
|
2180
|
+
*/
|
|
2181
|
+
name: string;
|
|
2182
|
+
/** OAuth 2.0 token for the current user. */
|
|
2183
|
+
oauth_token?: string;
|
|
2184
|
+
/** Returns response with indentations and line breaks. */
|
|
2185
|
+
prettyPrint?: boolean;
|
|
2186
|
+
/** 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. */
|
|
2187
|
+
quotaUser?: string;
|
|
2188
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2189
|
+
upload_protocol?: string;
|
|
2190
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2191
|
+
uploadType?: string;
|
|
2192
|
+
/** Request body */
|
|
2193
|
+
resource: ModifyMembershipRolesRequest;
|
|
2194
|
+
}): Request<ModifyMembershipRolesResponse>;
|
|
2195
|
+
modifyMembershipRoles(request: {
|
|
2196
|
+
/** V1 error format. */
|
|
2197
|
+
"$.xgafv"?: string;
|
|
2198
|
+
/** OAuth access token. */
|
|
2199
|
+
access_token?: string;
|
|
2200
|
+
/** Data format for response. */
|
|
2201
|
+
alt?: string;
|
|
2202
|
+
/** JSONP */
|
|
2203
|
+
callback?: string;
|
|
2204
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2205
|
+
fields?: string;
|
|
2206
|
+
/** 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. */
|
|
2207
|
+
key?: string;
|
|
2208
|
+
/**
|
|
2209
|
+
* Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` whose roles are to be modified. Must be of the form
|
|
2210
|
+
* `groups/{group_id}/memberships/{membership_id}`.
|
|
2211
|
+
*/
|
|
2212
|
+
name: string;
|
|
2213
|
+
/** OAuth 2.0 token for the current user. */
|
|
2214
|
+
oauth_token?: string;
|
|
2215
|
+
/** Returns response with indentations and line breaks. */
|
|
2216
|
+
prettyPrint?: boolean;
|
|
2217
|
+
/** 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. */
|
|
2218
|
+
quotaUser?: string;
|
|
2219
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2220
|
+
upload_protocol?: string;
|
|
2221
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2222
|
+
uploadType?: string;
|
|
2223
|
+
},
|
|
2224
|
+
body: ModifyMembershipRolesRequest): Request<ModifyMembershipRolesResponse>;
|
|
2225
|
+
/**
|
|
2226
|
+
* Search transitive groups of a member. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud
|
|
2227
|
+
* Identity Premium accounts. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups.
|
|
2228
|
+
*/
|
|
2229
|
+
searchTransitiveGroups(request?: {
|
|
2230
|
+
/** V1 error format. */
|
|
2231
|
+
"$.xgafv"?: string;
|
|
2232
|
+
/** OAuth access token. */
|
|
2233
|
+
access_token?: string;
|
|
2234
|
+
/** Data format for response. */
|
|
2235
|
+
alt?: string;
|
|
2236
|
+
/** JSONP */
|
|
2237
|
+
callback?: string;
|
|
2238
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2239
|
+
fields?: string;
|
|
2240
|
+
/** 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. */
|
|
2241
|
+
key?: string;
|
|
2242
|
+
/** OAuth 2.0 token for the current user. */
|
|
2243
|
+
oauth_token?: string;
|
|
2244
|
+
/** The default page size is 200 (max 1000). */
|
|
2245
|
+
pageSize?: number;
|
|
2246
|
+
/** The next_page_token value returned from a previous list request, if any. */
|
|
2247
|
+
pageToken?: string;
|
|
2248
|
+
/**
|
|
2249
|
+
* [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is always
|
|
2250
|
+
* '-' as this API will search across all groups for a given member.
|
|
2251
|
+
*/
|
|
2252
|
+
parent: string;
|
|
2253
|
+
/** Returns response with indentations and line breaks. */
|
|
2254
|
+
prettyPrint?: boolean;
|
|
2255
|
+
/**
|
|
2256
|
+
* Required. A CEL expression that MUST include member specification AND label(s). This is a `required` field. Users can search on label attributes of groups. CONTAINS match ('in')
|
|
2257
|
+
* is supported on labels. Identity-mapped groups are uniquely identified by both a `member_key_id` and a `member_key_namespace`, which requires an additional query input:
|
|
2258
|
+
* `member_key_namespace`. Example query: `member_key_id == 'member_key_id_value' && in labels`
|
|
2259
|
+
*/
|
|
2260
|
+
query?: string;
|
|
2261
|
+
/** 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. */
|
|
2262
|
+
quotaUser?: string;
|
|
2263
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2264
|
+
upload_protocol?: string;
|
|
2265
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2266
|
+
uploadType?: string;
|
|
2267
|
+
}): Request<SearchTransitiveGroupsResponse>;
|
|
2268
|
+
/**
|
|
2269
|
+
* Search transitive memberships of a group. **Note:** This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud
|
|
2270
|
+
* Identity Premium accounts. A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships.
|
|
2271
|
+
*/
|
|
2272
|
+
searchTransitiveMemberships(request?: {
|
|
2273
|
+
/** V1 error format. */
|
|
2274
|
+
"$.xgafv"?: string;
|
|
2275
|
+
/** OAuth access token. */
|
|
2276
|
+
access_token?: string;
|
|
2277
|
+
/** Data format for response. */
|
|
2278
|
+
alt?: string;
|
|
2279
|
+
/** JSONP */
|
|
2280
|
+
callback?: string;
|
|
2281
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2282
|
+
fields?: string;
|
|
2283
|
+
/** 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. */
|
|
2284
|
+
key?: string;
|
|
2285
|
+
/** OAuth 2.0 token for the current user. */
|
|
2286
|
+
oauth_token?: string;
|
|
2287
|
+
/** The default page size is 200 (max 1000). */
|
|
2288
|
+
pageSize?: number;
|
|
2289
|
+
/** The next_page_token value returned from a previous list request, if any. */
|
|
2290
|
+
pageToken?: string;
|
|
2291
|
+
/**
|
|
2292
|
+
* [Resource name](https://cloud.google.com/apis/design/resource_names) of the group to search transitive memberships in. Format: `groups/{group_id}`, where `group_id` is the
|
|
2293
|
+
* unique ID assigned to the Group.
|
|
2294
|
+
*/
|
|
2295
|
+
parent: string;
|
|
2296
|
+
/** Returns response with indentations and line breaks. */
|
|
2297
|
+
prettyPrint?: boolean;
|
|
2298
|
+
/** 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. */
|
|
2299
|
+
quotaUser?: string;
|
|
2300
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2301
|
+
upload_protocol?: string;
|
|
2302
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2303
|
+
uploadType?: string;
|
|
2304
|
+
}): Request<SearchTransitiveMembershipsResponse>;
|
|
2305
|
+
}
|
|
2306
|
+
interface GroupsResource {
|
|
2307
|
+
/** Creates a `Group`. */
|
|
2308
|
+
create(request: {
|
|
2309
|
+
/** V1 error format. */
|
|
2310
|
+
"$.xgafv"?: string;
|
|
2311
|
+
/** OAuth access token. */
|
|
2312
|
+
access_token?: string;
|
|
2313
|
+
/** Data format for response. */
|
|
2314
|
+
alt?: string;
|
|
2315
|
+
/** JSONP */
|
|
2316
|
+
callback?: string;
|
|
2317
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2318
|
+
fields?: string;
|
|
2319
|
+
/** Required. The initial configuration option for the `Group`. */
|
|
2320
|
+
initialGroupConfig?: string;
|
|
2321
|
+
/** 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. */
|
|
2322
|
+
key?: string;
|
|
2323
|
+
/** OAuth 2.0 token for the current user. */
|
|
2324
|
+
oauth_token?: string;
|
|
2325
|
+
/** Returns response with indentations and line breaks. */
|
|
2326
|
+
prettyPrint?: boolean;
|
|
2327
|
+
/** 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. */
|
|
2328
|
+
quotaUser?: string;
|
|
2329
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2330
|
+
upload_protocol?: string;
|
|
2331
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2332
|
+
uploadType?: string;
|
|
2333
|
+
/** Request body */
|
|
2334
|
+
resource: Group;
|
|
2335
|
+
}): Request<Operation>;
|
|
2336
|
+
create(request: {
|
|
2337
|
+
/** V1 error format. */
|
|
2338
|
+
"$.xgafv"?: string;
|
|
2339
|
+
/** OAuth access token. */
|
|
2340
|
+
access_token?: string;
|
|
2341
|
+
/** Data format for response. */
|
|
2342
|
+
alt?: string;
|
|
2343
|
+
/** JSONP */
|
|
2344
|
+
callback?: string;
|
|
2345
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2346
|
+
fields?: string;
|
|
2347
|
+
/** Required. The initial configuration option for the `Group`. */
|
|
2348
|
+
initialGroupConfig?: string;
|
|
2349
|
+
/** 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. */
|
|
2350
|
+
key?: string;
|
|
2351
|
+
/** OAuth 2.0 token for the current user. */
|
|
2352
|
+
oauth_token?: string;
|
|
2353
|
+
/** Returns response with indentations and line breaks. */
|
|
2354
|
+
prettyPrint?: boolean;
|
|
2355
|
+
/** 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. */
|
|
2356
|
+
quotaUser?: string;
|
|
2357
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2358
|
+
upload_protocol?: string;
|
|
2359
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2360
|
+
uploadType?: string;
|
|
2361
|
+
},
|
|
2362
|
+
body: Group): Request<Operation>;
|
|
2363
|
+
/** Deletes a `Group`. */
|
|
2364
|
+
delete(request?: {
|
|
2365
|
+
/** V1 error format. */
|
|
2366
|
+
"$.xgafv"?: string;
|
|
2367
|
+
/** OAuth access token. */
|
|
2368
|
+
access_token?: string;
|
|
2369
|
+
/** Data format for response. */
|
|
2370
|
+
alt?: string;
|
|
2371
|
+
/** JSONP */
|
|
2372
|
+
callback?: string;
|
|
2373
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2374
|
+
fields?: string;
|
|
2375
|
+
/** 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. */
|
|
2376
|
+
key?: string;
|
|
2377
|
+
/** Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. */
|
|
2378
|
+
name: string;
|
|
2379
|
+
/** OAuth 2.0 token for the current user. */
|
|
2380
|
+
oauth_token?: string;
|
|
2381
|
+
/** Returns response with indentations and line breaks. */
|
|
2382
|
+
prettyPrint?: boolean;
|
|
2383
|
+
/** 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. */
|
|
2384
|
+
quotaUser?: string;
|
|
2385
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2386
|
+
upload_protocol?: string;
|
|
2387
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2388
|
+
uploadType?: string;
|
|
2389
|
+
}): Request<Operation>;
|
|
2390
|
+
/** Retrieves a `Group`. */
|
|
2391
|
+
get(request?: {
|
|
2392
|
+
/** V1 error format. */
|
|
2393
|
+
"$.xgafv"?: string;
|
|
2394
|
+
/** OAuth access token. */
|
|
2395
|
+
access_token?: string;
|
|
2396
|
+
/** Data format for response. */
|
|
2397
|
+
alt?: string;
|
|
2398
|
+
/** JSONP */
|
|
2399
|
+
callback?: string;
|
|
2400
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2401
|
+
fields?: string;
|
|
2402
|
+
/** 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. */
|
|
2403
|
+
key?: string;
|
|
2404
|
+
/** Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. */
|
|
2405
|
+
name: string;
|
|
2406
|
+
/** OAuth 2.0 token for the current user. */
|
|
2407
|
+
oauth_token?: string;
|
|
2408
|
+
/** Returns response with indentations and line breaks. */
|
|
2409
|
+
prettyPrint?: boolean;
|
|
2410
|
+
/** 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. */
|
|
2411
|
+
quotaUser?: string;
|
|
2412
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2413
|
+
upload_protocol?: string;
|
|
2414
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2415
|
+
uploadType?: string;
|
|
2416
|
+
}): Request<Group>;
|
|
2417
|
+
/** Get Security Settings */
|
|
2418
|
+
getSecuritySettings(request?: {
|
|
2419
|
+
/** V1 error format. */
|
|
2420
|
+
"$.xgafv"?: string;
|
|
2421
|
+
/** OAuth access token. */
|
|
2422
|
+
access_token?: string;
|
|
2423
|
+
/** Data format for response. */
|
|
2424
|
+
alt?: string;
|
|
2425
|
+
/** JSONP */
|
|
2426
|
+
callback?: string;
|
|
2427
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2428
|
+
fields?: string;
|
|
2429
|
+
/** 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. */
|
|
2430
|
+
key?: string;
|
|
2431
|
+
/** Required. The security settings to retrieve. Format: `groups/{group_id}/securitySettings` */
|
|
2432
|
+
name: string;
|
|
2433
|
+
/** OAuth 2.0 token for the current user. */
|
|
2434
|
+
oauth_token?: string;
|
|
2435
|
+
/** Returns response with indentations and line breaks. */
|
|
2436
|
+
prettyPrint?: boolean;
|
|
2437
|
+
/** 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. */
|
|
2438
|
+
quotaUser?: string;
|
|
2439
|
+
/**
|
|
2440
|
+
* Field-level read mask of which fields to return. "*" returns all fields. If not specified, all fields will be returned. May only contain the following field:
|
|
2441
|
+
* `member_restriction`.
|
|
2442
|
+
*/
|
|
2443
|
+
readMask?: string;
|
|
2444
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2445
|
+
upload_protocol?: string;
|
|
2446
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2447
|
+
uploadType?: string;
|
|
2448
|
+
}): Request<SecuritySettings>;
|
|
2449
|
+
/** Lists the `Group` resources under a customer or namespace. */
|
|
2450
|
+
list(request?: {
|
|
2451
|
+
/** V1 error format. */
|
|
2452
|
+
"$.xgafv"?: string;
|
|
2453
|
+
/** OAuth access token. */
|
|
2454
|
+
access_token?: string;
|
|
2455
|
+
/** Data format for response. */
|
|
2456
|
+
alt?: string;
|
|
2457
|
+
/** JSONP */
|
|
2458
|
+
callback?: string;
|
|
2459
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2460
|
+
fields?: string;
|
|
2461
|
+
/** 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. */
|
|
2462
|
+
key?: string;
|
|
2463
|
+
/** OAuth 2.0 token for the current user. */
|
|
2464
|
+
oauth_token?: string;
|
|
2465
|
+
/**
|
|
2466
|
+
* The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results,
|
|
2467
|
+
* clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `View.BASIC` and to 50 for
|
|
2468
|
+
* `View.FULL`. Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`.
|
|
2469
|
+
*/
|
|
2470
|
+
pageSize?: number;
|
|
2471
|
+
/** The `next_page_token` value returned from a previous list request, if any. */
|
|
2472
|
+
pageToken?: string;
|
|
2473
|
+
/**
|
|
2474
|
+
* Required. The parent resource under which to list all `Group` resources. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or
|
|
2475
|
+
* `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn').
|
|
2476
|
+
*/
|
|
2477
|
+
parent?: string;
|
|
2478
|
+
/** Returns response with indentations and line breaks. */
|
|
2479
|
+
prettyPrint?: boolean;
|
|
2480
|
+
/** 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. */
|
|
2481
|
+
quotaUser?: string;
|
|
2482
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2483
|
+
upload_protocol?: string;
|
|
2484
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2485
|
+
uploadType?: string;
|
|
2486
|
+
/** The level of detail to be returned. If unspecified, defaults to `View.BASIC`. */
|
|
2487
|
+
view?: string;
|
|
2488
|
+
}): Request<ListGroupsResponse>;
|
|
2489
|
+
/** Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`. */
|
|
2490
|
+
lookup(request?: {
|
|
2491
|
+
/** V1 error format. */
|
|
2492
|
+
"$.xgafv"?: string;
|
|
2493
|
+
/** OAuth access token. */
|
|
2494
|
+
access_token?: string;
|
|
2495
|
+
/** Data format for response. */
|
|
2496
|
+
alt?: string;
|
|
2497
|
+
/** JSONP */
|
|
2498
|
+
callback?: string;
|
|
2499
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2500
|
+
fields?: string;
|
|
2501
|
+
/**
|
|
2502
|
+
* The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a
|
|
2503
|
+
* string conforming to the Identity Source's requirements. Must be unique within a `namespace`.
|
|
2504
|
+
*/
|
|
2505
|
+
"groupKey.id"?: string;
|
|
2506
|
+
/**
|
|
2507
|
+
* The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the
|
|
2508
|
+
* `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of
|
|
2509
|
+
* `identitysources/{identity_source_id}`.
|
|
2510
|
+
*/
|
|
2511
|
+
"groupKey.namespace"?: string;
|
|
2512
|
+
/** 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. */
|
|
2513
|
+
key?: string;
|
|
2514
|
+
/** OAuth 2.0 token for the current user. */
|
|
2515
|
+
oauth_token?: string;
|
|
2516
|
+
/** Returns response with indentations and line breaks. */
|
|
2517
|
+
prettyPrint?: boolean;
|
|
2518
|
+
/** 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. */
|
|
2519
|
+
quotaUser?: string;
|
|
2520
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2521
|
+
upload_protocol?: string;
|
|
2522
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2523
|
+
uploadType?: string;
|
|
2524
|
+
}): Request<LookupGroupNameResponse>;
|
|
2525
|
+
/** Updates a `Group`. */
|
|
2526
|
+
patch(request: {
|
|
2527
|
+
/** V1 error format. */
|
|
2528
|
+
"$.xgafv"?: string;
|
|
2529
|
+
/** OAuth access token. */
|
|
2530
|
+
access_token?: string;
|
|
2531
|
+
/** Data format for response. */
|
|
2532
|
+
alt?: string;
|
|
2533
|
+
/** JSONP */
|
|
2534
|
+
callback?: string;
|
|
2535
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2536
|
+
fields?: string;
|
|
2537
|
+
/** 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. */
|
|
2538
|
+
key?: string;
|
|
2539
|
+
/** Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. */
|
|
2540
|
+
name: string;
|
|
2541
|
+
/** OAuth 2.0 token for the current user. */
|
|
2542
|
+
oauth_token?: string;
|
|
2543
|
+
/** Returns response with indentations and line breaks. */
|
|
2544
|
+
prettyPrint?: boolean;
|
|
2545
|
+
/** 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. */
|
|
2546
|
+
quotaUser?: string;
|
|
2547
|
+
/** Required. The names of fields to update. May only contain the following field names: `display_name`, `description`, `labels`, `dynamic_group_metadata`, `posix_groups`. */
|
|
2548
|
+
updateMask?: string;
|
|
2549
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2550
|
+
upload_protocol?: string;
|
|
2551
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2552
|
+
uploadType?: string;
|
|
2553
|
+
/** Request body */
|
|
2554
|
+
resource: Group;
|
|
2555
|
+
}): Request<Operation>;
|
|
2556
|
+
patch(request: {
|
|
2557
|
+
/** V1 error format. */
|
|
2558
|
+
"$.xgafv"?: string;
|
|
2559
|
+
/** OAuth access token. */
|
|
2560
|
+
access_token?: string;
|
|
2561
|
+
/** Data format for response. */
|
|
2562
|
+
alt?: string;
|
|
2563
|
+
/** JSONP */
|
|
2564
|
+
callback?: string;
|
|
2565
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2566
|
+
fields?: string;
|
|
2567
|
+
/** 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. */
|
|
2568
|
+
key?: string;
|
|
2569
|
+
/** Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. */
|
|
2570
|
+
name: string;
|
|
2571
|
+
/** OAuth 2.0 token for the current user. */
|
|
2572
|
+
oauth_token?: string;
|
|
2573
|
+
/** Returns response with indentations and line breaks. */
|
|
2574
|
+
prettyPrint?: boolean;
|
|
2575
|
+
/** 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. */
|
|
2576
|
+
quotaUser?: string;
|
|
2577
|
+
/** Required. The names of fields to update. May only contain the following field names: `display_name`, `description`, `labels`, `dynamic_group_metadata`, `posix_groups`. */
|
|
2578
|
+
updateMask?: string;
|
|
2579
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2580
|
+
upload_protocol?: string;
|
|
2581
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2582
|
+
uploadType?: string;
|
|
2583
|
+
},
|
|
2584
|
+
body: Group): Request<Operation>;
|
|
2585
|
+
/** Searches for `Group` resources matching a specified query. */
|
|
2586
|
+
search(request?: {
|
|
2587
|
+
/** V1 error format. */
|
|
2588
|
+
"$.xgafv"?: string;
|
|
2589
|
+
/** OAuth access token. */
|
|
2590
|
+
access_token?: string;
|
|
2591
|
+
/** Data format for response. */
|
|
2592
|
+
alt?: string;
|
|
2593
|
+
/** JSONP */
|
|
2594
|
+
callback?: string;
|
|
2595
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2596
|
+
fields?: string;
|
|
2597
|
+
/** 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. */
|
|
2598
|
+
key?: string;
|
|
2599
|
+
/** OAuth 2.0 token for the current user. */
|
|
2600
|
+
oauth_token?: string;
|
|
2601
|
+
/**
|
|
2602
|
+
* The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results,
|
|
2603
|
+
* clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and to 50
|
|
2604
|
+
* for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.
|
|
2605
|
+
*/
|
|
2606
|
+
pageSize?: number;
|
|
2607
|
+
/** The `next_page_token` value returned from a previous search request, if any. */
|
|
2608
|
+
pageToken?: string;
|
|
2609
|
+
/** Returns response with indentations and line breaks. */
|
|
2610
|
+
prettyPrint?: boolean;
|
|
2611
|
+
/**
|
|
2612
|
+
* Required. The search query. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent and
|
|
2613
|
+
* inclusion operators on labels (e.g., `parent == 'customers/{customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). The `customer_id` must begin
|
|
2614
|
+
* with "C" (for example, 'C046psxkn').
|
|
2615
|
+
*/
|
|
2616
|
+
query?: string;
|
|
2617
|
+
/** 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. */
|
|
2618
|
+
quotaUser?: string;
|
|
2619
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2620
|
+
upload_protocol?: string;
|
|
2621
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2622
|
+
uploadType?: string;
|
|
2623
|
+
/** The level of detail to be returned. If unspecified, defaults to `View.BASIC`. */
|
|
2624
|
+
view?: string;
|
|
2625
|
+
}): Request<SearchGroupsResponse>;
|
|
2626
|
+
/** Update Security Settings */
|
|
2627
|
+
updateSecuritySettings(request: {
|
|
2628
|
+
/** V1 error format. */
|
|
2629
|
+
"$.xgafv"?: string;
|
|
2630
|
+
/** OAuth access token. */
|
|
2631
|
+
access_token?: string;
|
|
2632
|
+
/** Data format for response. */
|
|
2633
|
+
alt?: string;
|
|
2634
|
+
/** JSONP */
|
|
2635
|
+
callback?: string;
|
|
2636
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2637
|
+
fields?: string;
|
|
2638
|
+
/** 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. */
|
|
2639
|
+
key?: string;
|
|
2640
|
+
/** Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`. */
|
|
2641
|
+
name: string;
|
|
2642
|
+
/** OAuth 2.0 token for the current user. */
|
|
2643
|
+
oauth_token?: string;
|
|
2644
|
+
/** Returns response with indentations and line breaks. */
|
|
2645
|
+
prettyPrint?: boolean;
|
|
2646
|
+
/** 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. */
|
|
2647
|
+
quotaUser?: string;
|
|
2648
|
+
/** Required. The fully-qualified names of fields to update. May only contain the following field: `member_restriction.query`. */
|
|
2649
|
+
updateMask?: string;
|
|
2650
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2651
|
+
upload_protocol?: string;
|
|
2652
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2653
|
+
uploadType?: string;
|
|
2654
|
+
/** Request body */
|
|
2655
|
+
resource: SecuritySettings;
|
|
2656
|
+
}): Request<Operation>;
|
|
2657
|
+
updateSecuritySettings(request: {
|
|
2658
|
+
/** V1 error format. */
|
|
2659
|
+
"$.xgafv"?: string;
|
|
2660
|
+
/** OAuth access token. */
|
|
2661
|
+
access_token?: string;
|
|
2662
|
+
/** Data format for response. */
|
|
2663
|
+
alt?: string;
|
|
2664
|
+
/** JSONP */
|
|
2665
|
+
callback?: string;
|
|
2666
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2667
|
+
fields?: string;
|
|
2668
|
+
/** 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. */
|
|
2669
|
+
key?: string;
|
|
2670
|
+
/** Output only. The resource name of the security settings. Shall be of the form `groups/{group_id}/securitySettings`. */
|
|
2671
|
+
name: string;
|
|
2672
|
+
/** OAuth 2.0 token for the current user. */
|
|
2673
|
+
oauth_token?: string;
|
|
2674
|
+
/** Returns response with indentations and line breaks. */
|
|
2675
|
+
prettyPrint?: boolean;
|
|
2676
|
+
/** 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. */
|
|
2677
|
+
quotaUser?: string;
|
|
2678
|
+
/** Required. The fully-qualified names of fields to update. May only contain the following field: `member_restriction.query`. */
|
|
2679
|
+
updateMask?: string;
|
|
2680
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2681
|
+
upload_protocol?: string;
|
|
2682
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2683
|
+
uploadType?: string;
|
|
2684
|
+
},
|
|
2685
|
+
body: SecuritySettings): Request<Operation>;
|
|
2686
|
+
memberships: MembershipsResource;
|
|
2687
|
+
}
|
|
2688
|
+
interface MembershipsResource {
|
|
2689
|
+
/**
|
|
2690
|
+
* List OrgMembership resources in an OrgUnit treated as 'parent'. Parent format: orgUnits/{$orgUnitId} where `$orgUnitId` is the `orgUnitId` from the [Admin SDK `OrgUnit`
|
|
2691
|
+
* resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/orgunits)
|
|
2692
|
+
*/
|
|
2693
|
+
list(request?: {
|
|
2694
|
+
/** V1 error format. */
|
|
2695
|
+
"$.xgafv"?: string;
|
|
2696
|
+
/** OAuth access token. */
|
|
2697
|
+
access_token?: string;
|
|
2698
|
+
/** Data format for response. */
|
|
2699
|
+
alt?: string;
|
|
2700
|
+
/** JSONP */
|
|
2701
|
+
callback?: string;
|
|
2702
|
+
/**
|
|
2703
|
+
* Required. Immutable. Customer that this OrgMembership belongs to. All authorization will happen on the role assignments of this customer. Format: customers/{$customerId} where
|
|
2704
|
+
* `$customerId` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may also use
|
|
2705
|
+
* `customers/my_customer` to specify your own organization.
|
|
2706
|
+
*/
|
|
2707
|
+
customer?: string;
|
|
2708
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2709
|
+
fields?: string;
|
|
2710
|
+
/**
|
|
2711
|
+
* The search query. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the `type` (e.g., `type ==
|
|
2712
|
+
* 'shared_drive'`).
|
|
2713
|
+
*/
|
|
2714
|
+
filter?: string;
|
|
2715
|
+
/** 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. */
|
|
2716
|
+
key?: string;
|
|
2717
|
+
/** OAuth 2.0 token for the current user. */
|
|
2718
|
+
oauth_token?: string;
|
|
2719
|
+
/**
|
|
2720
|
+
* The maximum number of results to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will default to 50. The maximum allowed value
|
|
2721
|
+
* is 100, though requests with page_size greater than that will be silently interpreted as 100.
|
|
2722
|
+
*/
|
|
2723
|
+
pageSize?: number;
|
|
2724
|
+
/**
|
|
2725
|
+
* A page token, received from a previous `OrgMembershipsService.ListOrgMemberships` call. Provide this to retrieve the subsequent page. When paginating, all other parameters
|
|
2726
|
+
* provided to `ListOrgMembershipsRequest` must match the call that provided the page token.
|
|
2727
|
+
*/
|
|
2728
|
+
pageToken?: string;
|
|
2729
|
+
/**
|
|
2730
|
+
* Required. Immutable. OrgUnit which is queried for a list of memberships. Format: orgUnits/{$orgUnitId} where `$orgUnitId` is the `orgUnitId` from the [Admin SDK `OrgUnit`
|
|
2731
|
+
* resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/orgunits).
|
|
2732
|
+
*/
|
|
2733
|
+
parent: string;
|
|
2734
|
+
/** Returns response with indentations and line breaks. */
|
|
2735
|
+
prettyPrint?: boolean;
|
|
2736
|
+
/** 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. */
|
|
2737
|
+
quotaUser?: string;
|
|
2738
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2739
|
+
upload_protocol?: string;
|
|
2740
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2741
|
+
uploadType?: string;
|
|
2742
|
+
}): Request<ListOrgMembershipsResponse>;
|
|
2743
|
+
/**
|
|
2744
|
+
* Move an OrgMembership to a new OrgUnit. NOTE: This is an atomic copy-and-delete. The resource will have a new copy under the destination OrgUnit and be deleted from the source
|
|
2745
|
+
* OrgUnit. The resource can only be searched under the destination OrgUnit afterwards.
|
|
2746
|
+
*/
|
|
2747
|
+
move(request: {
|
|
2748
|
+
/** V1 error format. */
|
|
2749
|
+
"$.xgafv"?: string;
|
|
2750
|
+
/** OAuth access token. */
|
|
2751
|
+
access_token?: string;
|
|
2752
|
+
/** Data format for response. */
|
|
2753
|
+
alt?: string;
|
|
2754
|
+
/** JSONP */
|
|
2755
|
+
callback?: string;
|
|
2756
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2757
|
+
fields?: string;
|
|
2758
|
+
/** 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. */
|
|
2759
|
+
key?: string;
|
|
2760
|
+
/**
|
|
2761
|
+
* Required. Immutable. The [resource name](https://cloud.google.com/apis/design/resource_names) of the OrgMembership. Format: orgUnits/{$orgUnitId}/memberships/{$membership} The
|
|
2762
|
+
* `$orgUnitId` is the `orgUnitId` from the [Admin SDK `OrgUnit` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/orgunits). To manage a Membership
|
|
2763
|
+
* without specifying source `orgUnitId`, this API also supports the wildcard character '-' for `$orgUnitId` per https://google.aip.dev/159. The `$membership` shall be of the form
|
|
2764
|
+
* `{$entityType};{$memberId}`, where `$entityType` is the enum value of OrgMembership.EntityType, and `memberId` is the `id` from [Drive API (V3) `Drive`
|
|
2765
|
+
* resource](https://developers.google.com/drive/api/v3/reference/drives#resource) for OrgMembership.EntityType.SHARED_DRIVE.
|
|
2766
|
+
*/
|
|
2767
|
+
name: string;
|
|
2768
|
+
/** OAuth 2.0 token for the current user. */
|
|
2769
|
+
oauth_token?: string;
|
|
2770
|
+
/** Returns response with indentations and line breaks. */
|
|
2771
|
+
prettyPrint?: boolean;
|
|
2772
|
+
/** 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. */
|
|
2773
|
+
quotaUser?: string;
|
|
2774
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2775
|
+
upload_protocol?: string;
|
|
2776
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2777
|
+
uploadType?: string;
|
|
2778
|
+
/** Request body */
|
|
2779
|
+
resource: MoveOrgMembershipRequest;
|
|
2780
|
+
}): Request<Operation>;
|
|
2781
|
+
move(request: {
|
|
2782
|
+
/** V1 error format. */
|
|
2783
|
+
"$.xgafv"?: string;
|
|
2784
|
+
/** OAuth access token. */
|
|
2785
|
+
access_token?: string;
|
|
2786
|
+
/** Data format for response. */
|
|
2787
|
+
alt?: string;
|
|
2788
|
+
/** JSONP */
|
|
2789
|
+
callback?: string;
|
|
2790
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2791
|
+
fields?: string;
|
|
2792
|
+
/** 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. */
|
|
2793
|
+
key?: string;
|
|
2794
|
+
/**
|
|
2795
|
+
* Required. Immutable. The [resource name](https://cloud.google.com/apis/design/resource_names) of the OrgMembership. Format: orgUnits/{$orgUnitId}/memberships/{$membership} The
|
|
2796
|
+
* `$orgUnitId` is the `orgUnitId` from the [Admin SDK `OrgUnit` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/orgunits). To manage a Membership
|
|
2797
|
+
* without specifying source `orgUnitId`, this API also supports the wildcard character '-' for `$orgUnitId` per https://google.aip.dev/159. The `$membership` shall be of the form
|
|
2798
|
+
* `{$entityType};{$memberId}`, where `$entityType` is the enum value of OrgMembership.EntityType, and `memberId` is the `id` from [Drive API (V3) `Drive`
|
|
2799
|
+
* resource](https://developers.google.com/drive/api/v3/reference/drives#resource) for OrgMembership.EntityType.SHARED_DRIVE.
|
|
2800
|
+
*/
|
|
2801
|
+
name: string;
|
|
2802
|
+
/** OAuth 2.0 token for the current user. */
|
|
2803
|
+
oauth_token?: string;
|
|
2804
|
+
/** Returns response with indentations and line breaks. */
|
|
2805
|
+
prettyPrint?: boolean;
|
|
2806
|
+
/** 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. */
|
|
2807
|
+
quotaUser?: string;
|
|
2808
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2809
|
+
upload_protocol?: string;
|
|
2810
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2811
|
+
uploadType?: string;
|
|
2812
|
+
},
|
|
2813
|
+
body: MoveOrgMembershipRequest): Request<Operation>;
|
|
2814
|
+
}
|
|
2815
|
+
interface OrgUnitsResource {
|
|
2816
|
+
memberships: MembershipsResource;
|
|
2817
|
+
}
|
|
2818
|
+
|
|
2819
|
+
const customers: CustomersResource;
|
|
2820
|
+
|
|
2821
|
+
const devices: DevicesResource;
|
|
2822
|
+
|
|
2823
|
+
const groups: GroupsResource;
|
|
2824
|
+
|
|
2825
|
+
const orgUnits: OrgUnitsResource;
|
|
2826
|
+
}
|
|
2827
|
+
}
|