1{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/verifiedaccess": {
6 "description": "Verify your enterprise credentials"
7 }
8 }
9 }
10 },
11 "basePath": "",
12 "baseUrl": "https://verifiedaccess.googleapis.com/",
13 "batchPath": "batch",
14 "canonicalName": "verifiedaccess",
15 "description": "API for Verified Access chrome extension to provide credential verification for chrome devices connecting to an enterprise network",
16 "discoveryVersion": "v1",
17 "documentationLink": "https://developers.google.com/chrome/verified-access",
18 "fullyEncodeReservedExpansion": true,
19 "icons": {
20 "x16": "http://www.google.com/images/icons/product/search-16.gif",
21 "x32": "http://www.google.com/images/icons/product/search-32.gif"
22 },
23 "id": "verifiedaccess:v2",
24 "kind": "discovery#restDescription",
25 "mtlsRootUrl": "https://verifiedaccess.mtls.googleapis.com/",
26 "name": "verifiedaccess",
27 "ownerDomain": "google.com",
28 "ownerName": "Google",
29 "parameters": {
30 "$.xgafv": {
31 "description": "V1 error format.",
32 "enum": [
33 "1",
34 "2"
35 ],
36 "enumDescriptions": [
37 "v1 error format",
38 "v2 error format"
39 ],
40 "location": "query",
41 "type": "string"
42 },
43 "access_token": {
44 "description": "OAuth access token.",
45 "location": "query",
46 "type": "string"
47 },
48 "alt": {
49 "default": "json",
50 "description": "Data format for response.",
51 "enum": [
52 "json",
53 "media",
54 "proto"
55 ],
56 "enumDescriptions": [
57 "Responses with Content-Type of application/json",
58 "Media download with context-dependent Content-Type",
59 "Responses with Content-Type of application/x-protobuf"
60 ],
61 "location": "query",
62 "type": "string"
63 },
64 "callback": {
65 "description": "JSONP",
66 "location": "query",
67 "type": "string"
68 },
69 "fields": {
70 "description": "Selector specifying which fields to include in a partial response.",
71 "location": "query",
72 "type": "string"
73 },
74 "key": {
75 "description": "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.",
76 "location": "query",
77 "type": "string"
78 },
79 "oauth_token": {
80 "description": "OAuth 2.0 token for the current user.",
81 "location": "query",
82 "type": "string"
83 },
84 "prettyPrint": {
85 "default": "true",
86 "description": "Returns response with indentations and line breaks.",
87 "location": "query",
88 "type": "boolean"
89 },
90 "quotaUser": {
91 "description": "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.",
92 "location": "query",
93 "type": "string"
94 },
95 "uploadType": {
96 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
97 "location": "query",
98 "type": "string"
99 },
100 "upload_protocol": {
101 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
102 "location": "query",
103 "type": "string"
104 }
105 },
106 "protocol": "rest",
107 "resources": {
108 "challenge": {
109 "methods": {
110 "generate": {
111 "description": "Generates a new challenge.",
112 "flatPath": "v2/challenge:generate",
113 "httpMethod": "POST",
114 "id": "verifiedaccess.challenge.generate",
115 "parameterOrder": [],
116 "parameters": {},
117 "path": "v2/challenge:generate",
118 "request": {
119 "$ref": "Empty"
120 },
121 "response": {
122 "$ref": "Challenge"
123 },
124 "scopes": [
125 "https://www.googleapis.com/auth/verifiedaccess"
126 ]
127 },
128 "verify": {
129 "description": "Verifies the challenge response.",
130 "flatPath": "v2/challenge:verify",
131 "httpMethod": "POST",
132 "id": "verifiedaccess.challenge.verify",
133 "parameterOrder": [],
134 "parameters": {},
135 "path": "v2/challenge:verify",
136 "request": {
137 "$ref": "VerifyChallengeResponseRequest"
138 },
139 "response": {
140 "$ref": "VerifyChallengeResponseResult"
141 },
142 "scopes": [
143 "https://www.googleapis.com/auth/verifiedaccess"
144 ]
145 }
146 }
147 }
148 },
149 "revision": "20240402",
150 "rootUrl": "https://verifiedaccess.googleapis.com/",
151 "schemas": {
152 "Challenge": {
153 "description": "Result message for VerifiedAccess.GenerateChallenge.",
154 "id": "Challenge",
155 "properties": {
156 "challenge": {
157 "description": "Generated challenge, the bytes representation of SignedData.",
158 "format": "byte",
159 "type": "string"
160 }
161 },
162 "type": "object"
163 },
164 "CrowdStrikeAgent": {
165 "description": "Properties of the CrowdStrike agent installed on a device.",
166 "id": "CrowdStrikeAgent",
167 "properties": {
168 "agentId": {
169 "description": "The Agent ID of the Crowdstrike agent.",
170 "type": "string"
171 },
172 "customerId": {
173 "description": "The Customer ID to which the agent belongs to.",
174 "type": "string"
175 }
176 },
177 "type": "object"
178 },
179 "DeviceSignals": {
180 "description": "The device signals as reported by Chrome. Unless otherwise specified, signals are available on all platforms.",
181 "id": "DeviceSignals",
182 "properties": {
183 "allowScreenLock": {
184 "description": "Value of the AllowScreenLock policy on the device. See https://chromeenterprise.google/policies/?policy=AllowScreenLock for more details. Available on ChromeOS only.",
185 "type": "boolean"
186 },
187 "browserVersion": {
188 "description": "Current version of the Chrome browser which generated this set of signals. Example value: \"107.0.5286.0\".",
189 "type": "string"
190 },
191 "builtInDnsClientEnabled": {
192 "description": "Whether Chrome's built-in DNS client is used. The OS DNS client is otherwise used. This value may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#BuiltInDnsClientEnabled.",
193 "type": "boolean"
194 },
195 "chromeRemoteDesktopAppBlocked": {
196 "description": "Whether access to the Chrome Remote Desktop application is blocked via a policy.",
197 "type": "boolean"
198 },
199 "crowdStrikeAgent": {
200 "$ref": "CrowdStrikeAgent",
201 "description": "Crowdstrike agent properties installed on the device, if any. Available on Windows and MacOS only."
202 },
203 "deviceAffiliationIds": {
204 "description": "Affiliation IDs of the organizations that are affiliated with the organization that is currently managing the device. When the sets of device and profile affiliation IDs overlap, it means that the organizations managing the device and user are affiliated. To learn more about user affiliation, visit https://support.google.com/chrome/a/answer/12801245?ref_topic=9027936.",
205 "items": {
206 "type": "string"
207 },
208 "type": "array"
209 },
210 "deviceEnrollmentDomain": {
211 "description": "Enrollment domain of the customer which is currently managing the device.",
212 "type": "string"
213 },
214 "deviceManufacturer": {
215 "description": "The name of the device's manufacturer.",
216 "type": "string"
217 },
218 "deviceModel": {
219 "description": "The name of the device's model.",
220 "type": "string"
221 },
222 "diskEncryption": {
223 "description": "The encryption state of the disk. On ChromeOS, the main disk is always ENCRYPTED.",
224 "enum": [
225 "DISK_ENCRYPTION_UNSPECIFIED",
226 "DISK_ENCRYPTION_UNKNOWN",
227 "DISK_ENCRYPTION_DISABLED",
228 "DISK_ENCRYPTION_ENCRYPTED"
229 ],
230 "enumDescriptions": [
231 "Unspecified.",
232 "Chrome could not evaluate the encryption state.",
233 "The main disk is not encrypted.",
234 "The main disk is encrypted."
235 ],
236 "type": "string"
237 },
238 "displayName": {
239 "description": "The display name of the device, as defined by the user.",
240 "type": "string"
241 },
242 "hostname": {
243 "description": "Hostname of the device.",
244 "type": "string"
245 },
246 "imei": {
247 "description": "International Mobile Equipment Identity (IMEI) of the device. Available on ChromeOS only.",
248 "items": {
249 "type": "string"
250 },
251 "type": "array"
252 },
253 "macAddresses": {
254 "description": "MAC addresses of the device.",
255 "items": {
256 "type": "string"
257 },
258 "type": "array"
259 },
260 "meid": {
261 "description": "Mobile Equipment Identifier (MEID) of the device. Available on ChromeOS only.",
262 "items": {
263 "type": "string"
264 },
265 "type": "array"
266 },
267 "operatingSystem": {
268 "description": "The type of the Operating System currently running on the device.",
269 "enum": [
270 "OPERATING_SYSTEM_UNSPECIFIED",
271 "CHROME_OS",
272 "CHROMIUM_OS",
273 "WINDOWS",
274 "MAC_OS_X",
275 "LINUX"
276 ],
277 "enumDescriptions": [
278 "UNSPECIFIED.",
279 "ChromeOS.",
280 "ChromiumOS.",
281 "Windows.",
282 "Mac Os X.",
283 "Linux"
284 ],
285 "type": "string"
286 },
287 "osFirewall": {
288 "description": "The state of the OS level firewall. On ChromeOS, the value will always be ENABLED on regular devices and UNKNOWN on devices in developer mode.",
289 "enum": [
290 "OS_FIREWALL_UNSPECIFIED",
291 "OS_FIREWALL_UNKNOWN",
292 "OS_FIREWALL_DISABLED",
293 "OS_FIREWALL_ENABLED"
294 ],
295 "enumDescriptions": [
296 "Unspecified.",
297 "Chrome could not evaluate the OS firewall state.",
298 "The OS firewall is disabled.",
299 "The OS firewall is enabled."
300 ],
301 "type": "string"
302 },
303 "osVersion": {
304 "description": "The current version of the Operating System. On Windows and linux, the value will also include the security patch information.",
305 "type": "string"
306 },
307 "passwordProtectionWarningTrigger": {
308 "description": "Whether the Password Protection Warning feature is enabled or not. Password protection alerts users when they reuse their protected password on potentially suspicious sites. This setting is controlled by an enterprise policy: https://chromeenterprise.google/policies/#PasswordProtectionWarningTrigger. Note that the policy unset does not have the same effects as having the policy explicitly set to `PASSWORD_PROTECTION_OFF`.",
309 "enum": [
310 "PASSWORD_PROTECTION_WARNING_TRIGGER_UNSPECIFIED",
311 "POLICY_UNSET",
312 "PASSWORD_PROTECTION_OFF",
313 "PASSWORD_REUSE",
314 "PHISHING_REUSE"
315 ],
316 "enumDescriptions": [
317 "Unspecified.",
318 "The policy is not set.",
319 "No password protection warning will be shown.",
320 "Password protection warning is shown if a protected password is re-used.",
321 "Password protection warning is shown if a protected password is re-used on a known phishing website."
322 ],
323 "type": "string"
324 },
325 "profileAffiliationIds": {
326 "description": "Affiliation IDs of the organizations that are affiliated with the organization that is currently managing the Chrome Profile’s user or ChromeOS user.",
327 "items": {
328 "type": "string"
329 },
330 "type": "array"
331 },
332 "profileEnrollmentDomain": {
333 "description": "Enrollment domain of the customer which is currently managing the profile.",
334 "type": "string"
335 },
336 "realtimeUrlCheckMode": {
337 "description": "Whether Enterprise-grade (i.e. custom) unsafe URL scanning is enabled or not. This setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode",
338 "enum": [
339 "REALTIME_URL_CHECK_MODE_UNSPECIFIED",
340 "REALTIME_URL_CHECK_MODE_DISABLED",
341 "REALTIME_URL_CHECK_MODE_ENABLED_MAIN_FRAME"
342 ],
343 "enumDescriptions": [
344 "Unspecified.",
345 "Disabled. Consumer Safe Browsing checks are applied.",
346 "Realtime check for main frame URLs is enabled."
347 ],
348 "type": "string"
349 },
350 "safeBrowsingProtectionLevel": {
351 "description": "Safe Browsing Protection Level. That setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel.",
352 "enum": [
353 "SAFE_BROWSING_PROTECTION_LEVEL_UNSPECIFIED",
354 "INACTIVE",
355 "STANDARD",
356 "ENHANCED"
357 ],
358 "enumDescriptions": [
359 "Unspecified.",
360 "Safe Browsing is disabled.",
361 "Safe Browsing is active in the standard mode.",
362 "Safe Browsing is active in the enhanced mode."
363 ],
364 "type": "string"
365 },
366 "screenLockSecured": {
367 "description": "The state of the Screen Lock password protection. On ChromeOS, this value will always be ENABLED as there is not way to disable requiring a password or pin when unlocking the device.",
368 "enum": [
369 "SCREEN_LOCK_SECURED_UNSPECIFIED",
370 "SCREEN_LOCK_SECURED_UNKNOWN",
371 "SCREEN_LOCK_SECURED_DISABLED",
372 "SCREEN_LOCK_SECURED_ENABLED"
373 ],
374 "enumDescriptions": [
375 "Unspecified.",
376 "Chrome could not evaluate the state of the Screen Lock mechanism.",
377 "The Screen Lock is not password-protected.",
378 "The Screen Lock is password-protected."
379 ],
380 "type": "string"
381 },
382 "secureBootMode": {
383 "description": "Whether the device's startup software has its Secure Boot feature enabled. Available on Windows only.",
384 "enum": [
385 "SECURE_BOOT_MODE_UNSPECIFIED",
386 "SECURE_BOOT_MODE_UNKNOWN",
387 "SECURE_BOOT_MODE_DISABLED",
388 "SECURE_BOOT_MODE_ENABLED"
389 ],
390 "enumDescriptions": [
391 "Unspecified.",
392 "Chrome was unable to determine the Secure Boot mode.",
393 "Secure Boot was disabled on the startup software.",
394 "Secure Boot was enabled on the startup software."
395 ],
396 "type": "string"
397 },
398 "serialNumber": {
399 "description": "The serial number of the device. On Windows, this represents the BIOS's serial number. Not available on most Linux distributions.",
400 "type": "string"
401 },
402 "siteIsolationEnabled": {
403 "description": "Whether the Site Isolation (a.k.a Site Per Process) setting is enabled. That setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#SitePerProcess",
404 "type": "boolean"
405 },
406 "systemDnsServers": {
407 "description": "List of the addesses of all OS level DNS servers configured in the device's network settings.",
408 "items": {
409 "type": "string"
410 },
411 "type": "array"
412 },
413 "thirdPartyBlockingEnabled": {
414 "description": "Whether Chrome is blocking third-party software injection or not. This setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/?policy=ThirdPartyBlockingEnabled. Available on Windows only.",
415 "type": "boolean"
416 },
417 "trigger": {
418 "description": "The trigger which generated this set of signals.",
419 "enum": [
420 "TRIGGER_UNSPECIFIED",
421 "TRIGGER_BROWSER_NAVIGATION",
422 "TRIGGER_LOGIN_SCREEN"
423 ],
424 "enumDescriptions": [
425 "Unspecified.",
426 "When navigating to an URL inside a browser.",
427 "When signing into an account on the ChromeOS login screen."
428 ],
429 "type": "string"
430 },
431 "windowsMachineDomain": {
432 "description": "Windows domain that the current machine has joined. Available on Windows only.",
433 "type": "string"
434 },
435 "windowsUserDomain": {
436 "description": "Windows domain for the current OS user. Available on Windows only.",
437 "type": "string"
438 }
439 },
440 "type": "object"
441 },
442 "Empty": {
443 "description": "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); }",
444 "id": "Empty",
445 "properties": {},
446 "type": "object"
447 },
448 "VerifyChallengeResponseRequest": {
449 "description": "Signed ChallengeResponse.",
450 "id": "VerifyChallengeResponseRequest",
451 "properties": {
452 "challengeResponse": {
453 "description": "Required. The generated response to the challenge, the bytes representation of SignedData.",
454 "format": "byte",
455 "type": "string"
456 },
457 "expectedIdentity": {
458 "description": "Optional. Service can optionally provide identity information about the device or user associated with the key. For an EMK, this value is the enrolled domain. For an EUK, this value is the user's email address. If present, this value will be checked against contents of the response, and verification will fail if there is no match.",
459 "type": "string"
460 }
461 },
462 "type": "object"
463 },
464 "VerifyChallengeResponseResult": {
465 "description": "Result message for VerifiedAccess.VerifyChallengeResponse.",
466 "id": "VerifyChallengeResponseResult",
467 "properties": {
468 "attestedDeviceId": {
469 "description": "Attested device ID (ADID).",
470 "type": "string"
471 },
472 "customerId": {
473 "description": "Unique customer id that this device belongs to, as defined by the Google Admin SDK at https://developers.google.com/admin-sdk/directory/v1/guides/manage-customers",
474 "type": "string"
475 },
476 "deviceEnrollmentId": {
477 "description": "Device enrollment id for ChromeOS devices.",
478 "type": "string"
479 },
480 "devicePermanentId": {
481 "description": "Device permanent id is returned in this field (for the machine response only).",
482 "type": "string"
483 },
484 "deviceSignal": {
485 "description": "Deprecated. Device signal in json string representation. Prefer using `device_signals` instead.",
486 "type": "string"
487 },
488 "deviceSignals": {
489 "$ref": "DeviceSignals",
490 "description": "Device signals."
491 },
492 "keyTrustLevel": {
493 "description": "Device attested key trust level.",
494 "enum": [
495 "KEY_TRUST_LEVEL_UNSPECIFIED",
496 "CHROME_OS_VERIFIED_MODE",
497 "CHROME_OS_DEVELOPER_MODE",
498 "CHROME_BROWSER_HW_KEY",
499 "CHROME_BROWSER_OS_KEY",
500 "CHROME_BROWSER_NO_KEY"
501 ],
502 "enumDescriptions": [
503 "UNSPECIFIED.",
504 "ChromeOS device in verified mode.",
505 "ChromeOS device in developer mode.",
506 "Chrome Browser with the key stored in the device hardware.",
507 "Chrome Browser with the key stored at OS level.",
508 "Chrome Browser without an attestation key."
509 ],
510 "type": "string"
511 },
512 "profileCustomerId": {
513 "description": "Unique customer id that this profile belongs to, as defined by the Google Admin SDK at https://developers.google.com/admin-sdk/directory/v1/guides/manage-customers",
514 "type": "string"
515 },
516 "profileKeyTrustLevel": {
517 "description": "Profile attested key trust level.",
518 "enum": [
519 "KEY_TRUST_LEVEL_UNSPECIFIED",
520 "CHROME_OS_VERIFIED_MODE",
521 "CHROME_OS_DEVELOPER_MODE",
522 "CHROME_BROWSER_HW_KEY",
523 "CHROME_BROWSER_OS_KEY",
524 "CHROME_BROWSER_NO_KEY"
525 ],
526 "enumDescriptions": [
527 "UNSPECIFIED.",
528 "ChromeOS device in verified mode.",
529 "ChromeOS device in developer mode.",
530 "Chrome Browser with the key stored in the device hardware.",
531 "Chrome Browser with the key stored at OS level.",
532 "Chrome Browser without an attestation key."
533 ],
534 "type": "string"
535 },
536 "signedPublicKeyAndChallenge": {
537 "description": "Certificate Signing Request (in the SPKAC format, base64 encoded) is returned in this field. This field will be set only if device has included CSR in its challenge response. (the option to include CSR is now available for both user and machine responses)",
538 "type": "string"
539 },
540 "virtualDeviceId": {
541 "description": "Virtual device id of the device. The definition of virtual device id is platform-specific.",
542 "type": "string"
543 },
544 "virtualProfileId": {
545 "description": "The ID of a profile on the device.",
546 "type": "string"
547 }
548 },
549 "type": "object"
550 }
551 },
552 "servicePath": "",
553 "title": "Chrome Verified Access API",
554 "version": "v2",
555 "version_module": true
556}View as plain text