@maxim_mazurok/gapi.client.cloudidentity-v1beta1 0.0.20221101 → 0.0.20230102
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 +80 -13
- package/package.json +1 -1
- package/tests.ts +15 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://cloudidentity.googleapis.com/$discovery/rest?version=v1beta1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20230102
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -39,15 +39,23 @@ declare namespace gapi.client {
|
|
|
39
39
|
/** 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. */
|
|
40
40
|
supportsWorkProfile?: boolean;
|
|
41
41
|
}
|
|
42
|
-
// tslint:disable-next-line:no-empty-interface
|
|
43
42
|
interface ApproveDeviceUserRequest {
|
|
43
|
+
/**
|
|
44
|
+
* 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` If
|
|
45
|
+
* you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
|
|
46
|
+
*/
|
|
47
|
+
customer?: string;
|
|
44
48
|
}
|
|
45
49
|
interface ApproveDeviceUserResponse {
|
|
46
50
|
/** Resultant DeviceUser object for the action. */
|
|
47
51
|
deviceUser?: DeviceUser;
|
|
48
52
|
}
|
|
49
|
-
// tslint:disable-next-line:no-empty-interface
|
|
50
53
|
interface BlockDeviceUserRequest {
|
|
54
|
+
/**
|
|
55
|
+
* 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` If
|
|
56
|
+
* you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
|
|
57
|
+
*/
|
|
58
|
+
customer?: string;
|
|
51
59
|
}
|
|
52
60
|
interface BlockDeviceUserResponse {
|
|
53
61
|
/** Resultant DeviceUser object for the action. */
|
|
@@ -56,15 +64,23 @@ declare namespace gapi.client {
|
|
|
56
64
|
// tslint:disable-next-line:no-empty-interface
|
|
57
65
|
interface CancelUserInvitationRequest {
|
|
58
66
|
}
|
|
59
|
-
// tslint:disable-next-line:no-empty-interface
|
|
60
67
|
interface CancelWipeDeviceRequest {
|
|
68
|
+
/**
|
|
69
|
+
* 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` If
|
|
70
|
+
* you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
|
|
71
|
+
*/
|
|
72
|
+
customer?: string;
|
|
61
73
|
}
|
|
62
74
|
interface CancelWipeDeviceResponse {
|
|
63
75
|
/** Resultant Device object for the action. Note that asset tags will not be returned in the device object. */
|
|
64
76
|
device?: Device;
|
|
65
77
|
}
|
|
66
|
-
// tslint:disable-next-line:no-empty-interface
|
|
67
78
|
interface CancelWipeDeviceUserRequest {
|
|
79
|
+
/**
|
|
80
|
+
* 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` If
|
|
81
|
+
* you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
|
|
82
|
+
*/
|
|
83
|
+
customer?: string;
|
|
68
84
|
}
|
|
69
85
|
interface CancelWipeDeviceUserResponse {
|
|
70
86
|
/** Resultant DeviceUser object for the action. */
|
|
@@ -138,6 +154,11 @@ declare namespace gapi.client {
|
|
|
138
154
|
scoreReason?: string;
|
|
139
155
|
}
|
|
140
156
|
interface CreateDeviceRequest {
|
|
157
|
+
/**
|
|
158
|
+
* 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` If
|
|
159
|
+
* you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
|
|
160
|
+
*/
|
|
161
|
+
customer?: string;
|
|
141
162
|
/**
|
|
142
163
|
* 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
|
|
143
164
|
* 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
|
|
@@ -555,8 +576,8 @@ declare namespace gapi.client {
|
|
|
555
576
|
name?: string;
|
|
556
577
|
/**
|
|
557
578
|
* Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form
|
|
558
|
-
* `identitysources/{
|
|
559
|
-
* 'C046psxkn').
|
|
579
|
+
* `identitysources/{identity_source}` for external [identity-mapped groups](https://support.google.com/a/answer/9039510) or `customers/{customer_id}` for Google Groups. The
|
|
580
|
+
* `customer_id` must begin with "C" (for example, 'C046psxkn'). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793)
|
|
560
581
|
*/
|
|
561
582
|
parent?: string;
|
|
562
583
|
/** Optional. The POSIX groups associated with the `Group`. */
|
|
@@ -703,7 +724,7 @@ declare namespace gapi.client {
|
|
|
703
724
|
name?: string;
|
|
704
725
|
}
|
|
705
726
|
interface LookupSelfDeviceUsersResponse {
|
|
706
|
-
/** The
|
|
727
|
+
/** The customer Id that may be passed back to other Devices API methods such as List, Get, etc. */
|
|
707
728
|
customer?: string;
|
|
708
729
|
/**
|
|
709
730
|
* [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
|
|
@@ -972,6 +993,11 @@ declare namespace gapi.client {
|
|
|
972
993
|
updateTime?: string;
|
|
973
994
|
}
|
|
974
995
|
interface WipeDeviceRequest {
|
|
996
|
+
/**
|
|
997
|
+
* 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` If
|
|
998
|
+
* you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
|
|
999
|
+
*/
|
|
1000
|
+
customer?: string;
|
|
975
1001
|
/**
|
|
976
1002
|
* 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
|
|
977
1003
|
* 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.
|
|
@@ -982,8 +1008,12 @@ declare namespace gapi.client {
|
|
|
982
1008
|
/** Resultant Device object for the action. Note that asset tags will not be returned in the device object. */
|
|
983
1009
|
device?: Device;
|
|
984
1010
|
}
|
|
985
|
-
// tslint:disable-next-line:no-empty-interface
|
|
986
1011
|
interface WipeDeviceUserRequest {
|
|
1012
|
+
/**
|
|
1013
|
+
* 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` If
|
|
1014
|
+
* you're using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
|
|
1015
|
+
*/
|
|
1016
|
+
customer?: string;
|
|
987
1017
|
}
|
|
988
1018
|
interface WipeDeviceUserResponse {
|
|
989
1019
|
/** Resultant DeviceUser object for the action. */
|
|
@@ -1536,6 +1566,11 @@ declare namespace gapi.client {
|
|
|
1536
1566
|
alt?: string;
|
|
1537
1567
|
/** JSONP */
|
|
1538
1568
|
callback?: string;
|
|
1569
|
+
/**
|
|
1570
|
+
* 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`
|
|
1571
|
+
* 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.
|
|
1572
|
+
*/
|
|
1573
|
+
customer?: string;
|
|
1539
1574
|
/** Selector specifying which fields to include in a partial response. */
|
|
1540
1575
|
fields?: string;
|
|
1541
1576
|
/** 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. */
|
|
@@ -1566,6 +1601,11 @@ declare namespace gapi.client {
|
|
|
1566
1601
|
alt?: string;
|
|
1567
1602
|
/** JSONP */
|
|
1568
1603
|
callback?: string;
|
|
1604
|
+
/**
|
|
1605
|
+
* 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`
|
|
1606
|
+
* 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.
|
|
1607
|
+
*/
|
|
1608
|
+
customer?: string;
|
|
1569
1609
|
/** Selector specifying which fields to include in a partial response. */
|
|
1570
1610
|
fields?: string;
|
|
1571
1611
|
/** 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. */
|
|
@@ -1596,6 +1636,11 @@ declare namespace gapi.client {
|
|
|
1596
1636
|
alt?: string;
|
|
1597
1637
|
/** JSONP */
|
|
1598
1638
|
callback?: string;
|
|
1639
|
+
/**
|
|
1640
|
+
* 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`
|
|
1641
|
+
* 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.
|
|
1642
|
+
*/
|
|
1643
|
+
customer?: string;
|
|
1599
1644
|
/** Selector specifying which fields to include in a partial response. */
|
|
1600
1645
|
fields?: string;
|
|
1601
1646
|
/**
|
|
@@ -1869,6 +1914,11 @@ declare namespace gapi.client {
|
|
|
1869
1914
|
alt?: string;
|
|
1870
1915
|
/** JSONP */
|
|
1871
1916
|
callback?: string;
|
|
1917
|
+
/**
|
|
1918
|
+
* 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`
|
|
1919
|
+
* 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.
|
|
1920
|
+
*/
|
|
1921
|
+
customer?: string;
|
|
1872
1922
|
/** Selector specifying which fields to include in a partial response. */
|
|
1873
1923
|
fields?: string;
|
|
1874
1924
|
/** 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. */
|
|
@@ -1899,6 +1949,11 @@ declare namespace gapi.client {
|
|
|
1899
1949
|
alt?: string;
|
|
1900
1950
|
/** JSONP */
|
|
1901
1951
|
callback?: string;
|
|
1952
|
+
/**
|
|
1953
|
+
* Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Customer in format: `customers/{customer_id}`, where customer_id is the customer to whom
|
|
1954
|
+
* the device belongs.
|
|
1955
|
+
*/
|
|
1956
|
+
customer?: string;
|
|
1902
1957
|
/** Selector specifying which fields to include in a partial response. */
|
|
1903
1958
|
fields?: string;
|
|
1904
1959
|
/** 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. */
|
|
@@ -1929,6 +1984,8 @@ declare namespace gapi.client {
|
|
|
1929
1984
|
alt?: string;
|
|
1930
1985
|
/** JSONP */
|
|
1931
1986
|
callback?: string;
|
|
1987
|
+
/** Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. */
|
|
1988
|
+
customer?: string;
|
|
1932
1989
|
/** Selector specifying which fields to include in a partial response. */
|
|
1933
1990
|
fields?: string;
|
|
1934
1991
|
/**
|
|
@@ -2611,7 +2668,8 @@ declare namespace gapi.client {
|
|
|
2611
2668
|
pageToken?: string;
|
|
2612
2669
|
/**
|
|
2613
2670
|
* 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
|
|
2614
|
-
* `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn').
|
|
2671
|
+
* `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). [Find your customer ID.]
|
|
2672
|
+
* (https://support.google.com/cloudidentity/answer/10070793)
|
|
2615
2673
|
*/
|
|
2616
2674
|
parent?: string;
|
|
2617
2675
|
/** Returns response with indentations and line breaks. */
|
|
@@ -2737,6 +2795,12 @@ declare namespace gapi.client {
|
|
|
2737
2795
|
key?: string;
|
|
2738
2796
|
/** OAuth 2.0 token for the current user. */
|
|
2739
2797
|
oauth_token?: string;
|
|
2798
|
+
/**
|
|
2799
|
+
* The ordering of groups for the display name or email in the search groups response. The syntax for this field can be found at
|
|
2800
|
+
* https://cloud.google.com/apis/design/design_patterns#sorting_order. Example: Sort by the ascending name: order_by="display_name" Sort by the descending group key email:
|
|
2801
|
+
* order_by="group_key desc"
|
|
2802
|
+
*/
|
|
2803
|
+
orderBy?: string;
|
|
2740
2804
|
/**
|
|
2741
2805
|
* 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,
|
|
2742
2806
|
* 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
|
|
@@ -2748,9 +2812,12 @@ declare namespace gapi.client {
|
|
|
2748
2812
|
/** Returns response with indentations and line breaks. */
|
|
2749
2813
|
prettyPrint?: boolean;
|
|
2750
2814
|
/**
|
|
2751
|
-
* Required. The search query. Must be specified in [Common Expression Language](https://opensource.google/projects/cel).
|
|
2752
|
-
*
|
|
2753
|
-
*
|
|
2815
|
+
* Required. The search query. * Must be specified in [Common Expression Language](https://opensource.google/projects/cel). * Must contain equality operators on the parent, e.g.
|
|
2816
|
+
* `parent == 'customers/{customer_id}'`. The `customer_id` must begin with "C" (for example, 'C046psxkn'). [Find your customer ID.]
|
|
2817
|
+
* (https://support.google.com/cloudidentity/answer/10070793) * Can contain optional inclusion operators on `labels` such as `cloudidentity.googleapis.com/groups.discussion_forum'
|
|
2818
|
+
* in labels`). * Can contain an optional equality operator on `domain_name` or `startsWith/contains/equality` operator on `group_key`, e.g. `domain_name == 'abc.com'`,
|
|
2819
|
+
* `group_key.startsWith('dev')`, `group_key.contains('dev'), group_key == 'dev@abc.com'` * Can contain an optional `startsWith/contains/equality` operator on `display_name`, such
|
|
2820
|
+
* as `display_name.startsWith('dev')` , `display_name.contains('dev')`, `display_name == 'dev'`
|
|
2754
2821
|
*/
|
|
2755
2822
|
query?: string;
|
|
2756
2823
|
/** 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. */
|
package/package.json
CHANGED
package/tests.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
4
4
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
5
5
|
|
|
6
|
-
// Revision:
|
|
6
|
+
// Revision: 20230102
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -83,6 +83,7 @@ gapi.load('client', async () => {
|
|
|
83
83
|
await gapi.client.cloudidentity.devices.cancelWipe({
|
|
84
84
|
name: "Test string",
|
|
85
85
|
}, {
|
|
86
|
+
customer: "Test string",
|
|
86
87
|
});
|
|
87
88
|
/**
|
|
88
89
|
* 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
|
|
@@ -90,6 +91,7 @@ gapi.load('client', async () => {
|
|
|
90
91
|
*/
|
|
91
92
|
await gapi.client.cloudidentity.devices.create({
|
|
92
93
|
}, {
|
|
94
|
+
customer: "Test string",
|
|
93
95
|
device: {
|
|
94
96
|
androidSpecificAttributes: {
|
|
95
97
|
enabledUnknownSources: true,
|
|
@@ -156,14 +158,17 @@ gapi.load('client', async () => {
|
|
|
156
158
|
});
|
|
157
159
|
/** Deletes the specified device. */
|
|
158
160
|
await gapi.client.cloudidentity.devices.delete({
|
|
161
|
+
customer: "Test string",
|
|
159
162
|
name: "Test string",
|
|
160
163
|
});
|
|
161
164
|
/** Retrieves the specified device. */
|
|
162
165
|
await gapi.client.cloudidentity.devices.get({
|
|
166
|
+
customer: "Test string",
|
|
163
167
|
name: "Test string",
|
|
164
168
|
});
|
|
165
169
|
/** Lists/Searches devices. */
|
|
166
170
|
await gapi.client.cloudidentity.devices.list({
|
|
171
|
+
customer: "Test string",
|
|
167
172
|
filter: "Test string",
|
|
168
173
|
orderBy: "Test string",
|
|
169
174
|
pageSize: 42,
|
|
@@ -174,33 +179,40 @@ gapi.load('client', async () => {
|
|
|
174
179
|
await gapi.client.cloudidentity.devices.wipe({
|
|
175
180
|
name: "Test string",
|
|
176
181
|
}, {
|
|
182
|
+
customer: "Test string",
|
|
177
183
|
removeResetLock: true,
|
|
178
184
|
});
|
|
179
185
|
/** Approves device to access user data. */
|
|
180
186
|
await gapi.client.cloudidentity.devices.deviceUsers.approve({
|
|
181
187
|
name: "Test string",
|
|
182
188
|
}, {
|
|
189
|
+
customer: "Test string",
|
|
183
190
|
});
|
|
184
191
|
/** Blocks device from accessing user data */
|
|
185
192
|
await gapi.client.cloudidentity.devices.deviceUsers.block({
|
|
186
193
|
name: "Test string",
|
|
187
194
|
}, {
|
|
195
|
+
customer: "Test string",
|
|
188
196
|
});
|
|
189
197
|
/** 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. */
|
|
190
198
|
await gapi.client.cloudidentity.devices.deviceUsers.cancelWipe({
|
|
191
199
|
name: "Test string",
|
|
192
200
|
}, {
|
|
201
|
+
customer: "Test string",
|
|
193
202
|
});
|
|
194
203
|
/** Deletes the specified DeviceUser. This also revokes the user's access to device data. */
|
|
195
204
|
await gapi.client.cloudidentity.devices.deviceUsers.delete({
|
|
205
|
+
customer: "Test string",
|
|
196
206
|
name: "Test string",
|
|
197
207
|
});
|
|
198
208
|
/** Retrieves the specified DeviceUser */
|
|
199
209
|
await gapi.client.cloudidentity.devices.deviceUsers.get({
|
|
210
|
+
customer: "Test string",
|
|
200
211
|
name: "Test string",
|
|
201
212
|
});
|
|
202
213
|
/** Lists/Searches DeviceUsers. */
|
|
203
214
|
await gapi.client.cloudidentity.devices.deviceUsers.list({
|
|
215
|
+
customer: "Test string",
|
|
204
216
|
filter: "Test string",
|
|
205
217
|
orderBy: "Test string",
|
|
206
218
|
pageSize: 42,
|
|
@@ -226,6 +238,7 @@ gapi.load('client', async () => {
|
|
|
226
238
|
await gapi.client.cloudidentity.devices.deviceUsers.wipe({
|
|
227
239
|
name: "Test string",
|
|
228
240
|
}, {
|
|
241
|
+
customer: "Test string",
|
|
229
242
|
});
|
|
230
243
|
/** Gets the client state for the device user */
|
|
231
244
|
await gapi.client.cloudidentity.devices.deviceUsers.clientStates.get({
|
|
@@ -364,6 +377,7 @@ gapi.load('client', async () => {
|
|
|
364
377
|
});
|
|
365
378
|
/** Searches for `Group` resources matching a specified query. */
|
|
366
379
|
await gapi.client.cloudidentity.groups.search({
|
|
380
|
+
orderBy: "Test string",
|
|
367
381
|
pageSize: 42,
|
|
368
382
|
pageToken: "Test string",
|
|
369
383
|
query: "Test string",
|