blob: 1d10f6598a710e58c8164a397cef9d2903e1ef25 [file] [log] [blame] [edit]
{
"basePath": "",
"version": "v1",
"description": "API for Verified Access chrome extension to provide credential verification for chrome devices connecting to an enterprise network",
"documentationLink": "https://developers.google.com/chrome/verified-access",
"ownerName": "Google",
"parameters": {
"alt": {
"type": "string",
"location": "query",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"default": "json"
},
"upload_protocol": {
"type": "string",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"$.xgafv": {
"location": "query",
"type": "string",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"description": "V1 error format."
},
"key": {
"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.",
"location": "query",
"type": "string"
},
"quotaUser": {
"location": "query",
"type": "string",
"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."
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"access_token": {
"type": "string",
"description": "OAuth access token.",
"location": "query"
},
"uploadType": {
"location": "query",
"type": "string",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
}
},
"fullyEncodeReservedExpansion": true,
"servicePath": "",
"schemas": {
"VerifyChallengeResponseRequest": {
"id": "VerifyChallengeResponseRequest",
"properties": {
"expectedIdentity": {
"type": "string",
"description": "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."
},
"challengeResponse": {
"$ref": "SignedData",
"description": "The generated response to the challenge"
}
},
"type": "object",
"description": "signed ChallengeResponse"
},
"VerifyChallengeResponseResult": {
"type": "object",
"id": "VerifyChallengeResponseResult",
"properties": {
"verificationOutput": {
"type": "string",
"description": "For EMCert check, device permanent id is returned here. For EUCert check, signed_public_key_and_challenge [base64 encoded] is returned if present, otherwise empty string is returned. This field is deprecated, please use device_permanent_id or signed_public_key_and_challenge fields."
},
"devicePermanentId": {
"type": "string",
"description": "Device permanent id is returned in this field (for the machine response only)."
},
"deviceEnrollmentId": {
"description": "Device enrollment id is returned in this field (for the machine response only).",
"type": "string"
},
"signedPublicKeyAndChallenge": {
"type": "string",
"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)"
}
},
"description": "Result message for VerifiedAccess.VerifyChallengeResponse."
},
"Empty": {
"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); } The JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
"id": "Empty",
"properties": {}
},
"Challenge": {
"id": "Challenge",
"description": "Result message for VerifiedAccess.CreateChallenge.",
"properties": {
"challenge": {
"description": "Generated challenge",
"$ref": "SignedData"
},
"alternativeChallenge": {
"$ref": "SignedData",
"description": "Challenge generated with the old signing key (this will only be present during key rotation)"
}
},
"type": "object"
},
"SignedData": {
"type": "object",
"properties": {
"data": {
"description": "The data to be signed.",
"format": "byte",
"type": "string"
},
"signature": {
"description": "The signature of the data field.",
"format": "byte",
"type": "string"
}
},
"id": "SignedData",
"description": "The wrapper message of any data and its signature."
}
},
"version_module": true,
"title": "Chrome Verified Access API",
"kind": "discovery#restDescription",
"rootUrl": "https://verifiedaccess.googleapis.com/",
"id": "verifiedaccess:v1",
"name": "verifiedaccess",
"batchPath": "batch",
"revision": "20200828",
"canonicalName": "verifiedaccess",
"mtlsRootUrl": "https://verifiedaccess.mtls.googleapis.com/",
"resources": {
"challenge": {
"methods": {
"create": {
"path": "v1/challenge",
"flatPath": "v1/challenge",
"parameters": {},
"response": {
"$ref": "Challenge"
},
"parameterOrder": [],
"description": "CreateChallenge API",
"scopes": [
"https://www.googleapis.com/auth/verifiedaccess"
],
"httpMethod": "POST",
"request": {
"$ref": "Empty"
},
"id": "verifiedaccess.challenge.create"
},
"verify": {
"response": {
"$ref": "VerifyChallengeResponseResult"
},
"flatPath": "v1/challenge:verify",
"scopes": [
"https://www.googleapis.com/auth/verifiedaccess"
],
"request": {
"$ref": "VerifyChallengeResponseRequest"
},
"description": "VerifyChallengeResponse API",
"path": "v1/challenge:verify",
"httpMethod": "POST",
"parameters": {},
"parameterOrder": [],
"id": "verifiedaccess.challenge.verify"
}
}
}
},
"discoveryVersion": "v1",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"ownerDomain": "google.com",
"baseUrl": "https://verifiedaccess.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/verifiedaccess": {
"description": "Verify your enterprise credentials"
}
}
}
},
"protocol": "rest"
}