1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="chromemanagement_v1.html">Chrome Management API</a> . <a href="chromemanagement_v1.customers.html">customers</a> . <a href="chromemanagement_v1.customers.profiles.html">profiles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="chromemanagement_v1.customers.profiles.commands.html">commands()</a></code>
</p>
<p class="firstline">Returns the commands Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the data collected from a Chrome browser profile.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a Chrome browser profile with customer ID and profile permanent ID.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Chrome browser profiles of a customer based on the given search and sorting criteria.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes the data collected from a Chrome browser profile.
Args:
name: string, Required. Format: customers/{customer_id}/profiles/{profile_permanent_id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a Chrome browser profile with customer ID and profile permanent ID.
Args:
name: string, Required. Format: customers/{customer_id}/profiles/{profile_permanent_id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A representation of a Chrome browser profile.
"affiliationState": "A String", # Output only. The specific affiliation state of the profile.
"annotatedLocation": "A String", # Optional. Location of the profile annotated by the admin.
"annotatedUser": "A String", # Optional. User of the profile annotated by the admin.
"attestationCredential": { # Information of public key associated with a Chrome browser profile. # Output only. Attestation credential information of the profile.
"keyRotationTime": "A String", # Output only. Latest rotation timestamp of the public key rotation.
"keyTrustLevel": "A String", # Output only. Trust level of the public key.
"keyType": "A String", # Output only. Type of the public key.
"publicKey": "A String", # Output only. Value of the public key.
},
"browserChannel": "A String", # Output only. Channel of the browser on which the profile exists.
"browserVersion": "A String", # Output only. Version of the browser on which the profile exists.
"deviceInfo": { # Information of a device that runs a Chrome browser profile. # Output only. Basic information of the device on which the profile exists. This information is only available for the affiliated profiles.
"affiliatedDeviceId": "A String", # Output only. Device ID that identifies the affiliated device on which the profile exists. If the device type is CHROME_BROWSER, then this represents a unique Directory API ID of the device that can be used in Admin SDK Browsers API.
"deviceType": "A String", # Output only. Type of the device on which the profile exists.
"hostname": "A String", # Output only. Hostname of the device on which the profile exists.
"machine": "A String", # Output only. Machine name of the device on which the profile exists. On platforms which do not report the machine name (currently iOS and Android) this is instead set to the browser's device_id - but note that this is a different device_id than the |affiliated_device_id|.
},
"displayName": "A String", # Output only. Profile display name set by client.
"etag": "A String", # Output only. Etag of this ChromeBrowserProfile resource. This etag can be used with UPDATE operation to ensure consistency.
"extensionCount": "A String", # Output only. Number of extensions installed on the profile.
"firstEnrollmentTime": "A String", # Output only. Timestamp of the first enrollment of the profile.
"identityProvider": "A String", # Output only. Identify provider of the profile.
"lastActivityTime": "A String", # Output only. Timestamp of the latest activity by the profile.
"lastPolicyFetchTime": "A String", # Output only. Timestamp of the latest policy fetch by the profile.
"lastPolicySyncTime": "A String", # Output only. Timestamp of the latest policy sync by the profile.
"lastStatusReportTime": "A String", # Output only. Timestamp of the latest status report by the profile.
"name": "A String", # Identifier. Format: customers/{customer_id}/profiles/{profile_permanent_id}
"osPlatformType": "A String", # Output only. OS platform of the device on which the profile exists.
"osPlatformVersion": "A String", # Output only. Major OS platform version of the device on which the profile exists, from profile reporting.
"osVersion": "A String", # Output only. OS version of the device on which the profile exists.
"policyCount": "A String", # Output only. Number of policies applied on the profile.
"profileId": "A String", # Output only. Chrome client side profile ID.
"profilePermanentId": "A String", # Output only. Profile permanent ID is the unique identifier of a profile within one customer.
"reportingData": { # Reporting data of a Chrome browser profile. # Output only. Detailed reporting data of the profile. This information is only available when the profile reporting policy is enabled.
"browserExecutablePath": "A String", # Output only. Executable path of the installed Chrome browser. A valid path is included only in affiliated profiles.
"extensionData": [ # Output only. Information of the extensions installed on the profile.
{ # Information of an extension installed on a Chrome browser profile.
"description": "A String", # Output only. Description of the extension.
"extensionId": "A String", # Output only. ID of the extension.
"extensionType": "A String", # Output only. Type of the extension.
"homepageUri": "A String", # Output only. The URL of the homepage of the extension.
"installationType": "A String", # Output only. Installation type of the extension.
"isDisabled": True or False, # Output only. Represents whether the user disabled the extension.
"isWebstoreExtension": True or False, # Output only. Represents whether the extension is from the webstore.
"manifestVersion": 42, # Output only. Manifest version of the extension.
"name": "A String", # Output only. Name of the extension.
"permissions": [ # Output only. Permissions requested by the extension.
"A String",
],
"version": "A String", # Output only. Version of the extension.
},
],
"extensionPolicyData": [ # Output only. Information of the policies applied on the extensions.
{ # Information of the policies applied on an extension.
"extensionId": "A String", # Output only. ID of the extension.
"extensionName": "A String", # Output only. Name of the extension.
"policyData": [ # Output only. Information of the policies applied on the extension.
{ # Information of a policy applied on a Chrome browser profile.
"conflicts": [ # Output only. Conflicting policy information.
{ # Information of conflicting policy applied on a Chrome browser profile.
"source": "A String", # Output only. Source of the policy.
},
],
"error": "A String", # Output only. Error message of the policy, if any.
"name": "A String", # Output only. Name of the policy.
"source": "A String", # Output only. Source of the policy.
"value": "A String", # Output only. Value of the policy.
},
],
},
],
"installedBrowserVersion": "A String", # Output only. Updated version of a browser, if it is different from the active browser version.
"policyData": [ # Output only. Information of the policies applied on the profile.
{ # Information of a policy applied on a Chrome browser profile.
"conflicts": [ # Output only. Conflicting policy information.
{ # Information of conflicting policy applied on a Chrome browser profile.
"source": "A String", # Output only. Source of the policy.
},
],
"error": "A String", # Output only. Error message of the policy, if any.
"name": "A String", # Output only. Name of the policy.
"source": "A String", # Output only. Source of the policy.
"value": "A String", # Output only. Value of the policy.
},
],
"profilePath": "A String", # Output only. Path of the profile. A valid path is included only in affiliated profiles.
},
"supportsFcmNotifications": True or False, # Output only. Whether the profile supports FCM notifications.
"userEmail": "A String", # Output only. Email address of the user to which the profile belongs.
"userId": "A String", # Output only. Unique Directory API ID of the user that can be used in Admin SDK Users API.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Chrome browser profiles of a customer based on the given search and sorting criteria.
Args:
parent: string, Required. Format: customers/{customer_id} (required)
filter: string, Optional. The filter used to filter profiles. The following fields can be used in the filter: - profile_id - display_name - user_email - last_activity_time - last_policy_sync_time - last_status_report_time - first_enrollment_time - os_platform_type - os_version - browser_version - browser_channel - policy_count - extension_count - identity_provider - affiliation_state - os_platform_version - ouId Any of the above fields can be used to specify a filter, and filtering by multiple fields is supported with AND operator. String type fields and enum type fields support '=' and '!=' operators. The integer type and the timestamp type fields support '=', '!=', '<', '>', '<=' and '>=' operators. Timestamps expect an RFC-3339 formatted string (e.g. 2012-04-21T11:30:00-04:00). Wildcard '*' can be used with a string type field filter. In addition, string literal filtering is also supported, for example, 'ABC' as a filter maps to a filter that checks if any of the filterable string type fields contains 'ABC'. Organization unit number can be used as a filtering criteria here by specifying 'ouId = ${your_org_unit_id}', please note that only single OU ID matching is supported.
orderBy: string, Optional. The fields used to specify the ordering of the results. The supported fields are: - profile_id - display_name - user_email - last_activity_time - last_policy_sync_time - last_status_report_time - first_enrollment_time - os_platform_type - os_version - browser_version - browser_channel - policy_count - extension_count - identity_provider - affiliation_state - os_platform_version By default, sorting is in ascending order, to specify descending order for a field, a suffix " desc" should be added to the field name. The default ordering is the descending order of last_status_report_time.
pageSize: integer, Optional. The maximum number of profiles to return. The default page size is 100 if page_size is unspecified, and the maximum page size allowed is 200.
pageToken: string, Optional. The page token used to retrieve a specific page of the listing request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to ListChromeBrowserProfiles method.
"chromeBrowserProfiles": [ # The list of profiles returned.
{ # A representation of a Chrome browser profile.
"affiliationState": "A String", # Output only. The specific affiliation state of the profile.
"annotatedLocation": "A String", # Optional. Location of the profile annotated by the admin.
"annotatedUser": "A String", # Optional. User of the profile annotated by the admin.
"attestationCredential": { # Information of public key associated with a Chrome browser profile. # Output only. Attestation credential information of the profile.
"keyRotationTime": "A String", # Output only. Latest rotation timestamp of the public key rotation.
"keyTrustLevel": "A String", # Output only. Trust level of the public key.
"keyType": "A String", # Output only. Type of the public key.
"publicKey": "A String", # Output only. Value of the public key.
},
"browserChannel": "A String", # Output only. Channel of the browser on which the profile exists.
"browserVersion": "A String", # Output only. Version of the browser on which the profile exists.
"deviceInfo": { # Information of a device that runs a Chrome browser profile. # Output only. Basic information of the device on which the profile exists. This information is only available for the affiliated profiles.
"affiliatedDeviceId": "A String", # Output only. Device ID that identifies the affiliated device on which the profile exists. If the device type is CHROME_BROWSER, then this represents a unique Directory API ID of the device that can be used in Admin SDK Browsers API.
"deviceType": "A String", # Output only. Type of the device on which the profile exists.
"hostname": "A String", # Output only. Hostname of the device on which the profile exists.
"machine": "A String", # Output only. Machine name of the device on which the profile exists. On platforms which do not report the machine name (currently iOS and Android) this is instead set to the browser's device_id - but note that this is a different device_id than the |affiliated_device_id|.
},
"displayName": "A String", # Output only. Profile display name set by client.
"etag": "A String", # Output only. Etag of this ChromeBrowserProfile resource. This etag can be used with UPDATE operation to ensure consistency.
"extensionCount": "A String", # Output only. Number of extensions installed on the profile.
"firstEnrollmentTime": "A String", # Output only. Timestamp of the first enrollment of the profile.
"identityProvider": "A String", # Output only. Identify provider of the profile.
"lastActivityTime": "A String", # Output only. Timestamp of the latest activity by the profile.
"lastPolicyFetchTime": "A String", # Output only. Timestamp of the latest policy fetch by the profile.
"lastPolicySyncTime": "A String", # Output only. Timestamp of the latest policy sync by the profile.
"lastStatusReportTime": "A String", # Output only. Timestamp of the latest status report by the profile.
"name": "A String", # Identifier. Format: customers/{customer_id}/profiles/{profile_permanent_id}
"osPlatformType": "A String", # Output only. OS platform of the device on which the profile exists.
"osPlatformVersion": "A String", # Output only. Major OS platform version of the device on which the profile exists, from profile reporting.
"osVersion": "A String", # Output only. OS version of the device on which the profile exists.
"policyCount": "A String", # Output only. Number of policies applied on the profile.
"profileId": "A String", # Output only. Chrome client side profile ID.
"profilePermanentId": "A String", # Output only. Profile permanent ID is the unique identifier of a profile within one customer.
"reportingData": { # Reporting data of a Chrome browser profile. # Output only. Detailed reporting data of the profile. This information is only available when the profile reporting policy is enabled.
"browserExecutablePath": "A String", # Output only. Executable path of the installed Chrome browser. A valid path is included only in affiliated profiles.
"extensionData": [ # Output only. Information of the extensions installed on the profile.
{ # Information of an extension installed on a Chrome browser profile.
"description": "A String", # Output only. Description of the extension.
"extensionId": "A String", # Output only. ID of the extension.
"extensionType": "A String", # Output only. Type of the extension.
"homepageUri": "A String", # Output only. The URL of the homepage of the extension.
"installationType": "A String", # Output only. Installation type of the extension.
"isDisabled": True or False, # Output only. Represents whether the user disabled the extension.
"isWebstoreExtension": True or False, # Output only. Represents whether the extension is from the webstore.
"manifestVersion": 42, # Output only. Manifest version of the extension.
"name": "A String", # Output only. Name of the extension.
"permissions": [ # Output only. Permissions requested by the extension.
"A String",
],
"version": "A String", # Output only. Version of the extension.
},
],
"extensionPolicyData": [ # Output only. Information of the policies applied on the extensions.
{ # Information of the policies applied on an extension.
"extensionId": "A String", # Output only. ID of the extension.
"extensionName": "A String", # Output only. Name of the extension.
"policyData": [ # Output only. Information of the policies applied on the extension.
{ # Information of a policy applied on a Chrome browser profile.
"conflicts": [ # Output only. Conflicting policy information.
{ # Information of conflicting policy applied on a Chrome browser profile.
"source": "A String", # Output only. Source of the policy.
},
],
"error": "A String", # Output only. Error message of the policy, if any.
"name": "A String", # Output only. Name of the policy.
"source": "A String", # Output only. Source of the policy.
"value": "A String", # Output only. Value of the policy.
},
],
},
],
"installedBrowserVersion": "A String", # Output only. Updated version of a browser, if it is different from the active browser version.
"policyData": [ # Output only. Information of the policies applied on the profile.
{ # Information of a policy applied on a Chrome browser profile.
"conflicts": [ # Output only. Conflicting policy information.
{ # Information of conflicting policy applied on a Chrome browser profile.
"source": "A String", # Output only. Source of the policy.
},
],
"error": "A String", # Output only. Error message of the policy, if any.
"name": "A String", # Output only. Name of the policy.
"source": "A String", # Output only. Source of the policy.
"value": "A String", # Output only. Value of the policy.
},
],
"profilePath": "A String", # Output only. Path of the profile. A valid path is included only in affiliated profiles.
},
"supportsFcmNotifications": True or False, # Output only. Whether the profile supports FCM notifications.
"userEmail": "A String", # Output only. Email address of the user to which the profile belongs.
"userId": "A String", # Output only. Unique Directory API ID of the user that can be used in Admin SDK Users API.
},
],
"nextPageToken": "A String", # The pagination token that can be used to list the next page.
"totalSize": "A String", # Total size represents an estimated number of resources returned. Not guaranteed to be accurate above 10k profiles.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
