Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c2228be4630e279e02a25b51566a0f93b67aa499 / . / docs / dyn / verifiedaccess_v1.challenge.html
blob: ca61571bebad086536edcb96eb3fdaa0dfd1c25a [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="verifiedaccess_v1.html">Chrome Verified Access API</a> . <a href="verifiedaccess_v1.challenge.html">challenge</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">CreateChallenge API</p>
83<p class="toc_element">
84 <code><a href="#verify">verify(body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">VerifyChallengeResponse API</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]93 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
94 <pre>CreateChallenge API
95
96Args:
97 body: object, The request body.
98 The object takes the form of:
99
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100{ # 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 `{}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]101 }
102
103 x__xgafv: string, V1 error format.
104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
107
108Returns:
109 An object of the form:
110
111 { # Result message for VerifiedAccess.CreateChallenge.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]112 &quot;challenge&quot;: { # The wrapper message of any data and its signature. # Generated challenge
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &quot;data&quot;: &quot;A String&quot;, # The data to be signed.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]114 &quot;signature&quot;: &quot;A String&quot;, # The signature of the data field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]116 &quot;alternativeChallenge&quot;: { # The wrapper message of any data and its signature. # Challenge generated with the old signing key (this will only be present during key rotation)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 &quot;data&quot;: &quot;A String&quot;, # The data to be signed.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]118 &quot;signature&quot;: &quot;A String&quot;, # The signature of the data field.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 },
120 }</pre>
121</div>
122
123<div class="method">
124 <code class="details" id="verify">verify(body=None, x__xgafv=None)</code>
125 <pre>VerifyChallengeResponse API
126
127Args:
128 body: object, The request body.
129 The object takes the form of:
130
131{ # signed ChallengeResponse
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]132 &quot;challengeResponse&quot;: { # The wrapper message of any data and its signature. # The generated response to the challenge
133 &quot;data&quot;: &quot;A String&quot;, # The data to be signed.
134 &quot;signature&quot;: &quot;A String&quot;, # The signature of the data field.
135 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]136 &quot;expectedIdentity&quot;: &quot;A String&quot;, # 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&#x27;s email address. If present, this value will be checked against contents of the response, and verification will fail if there is no match.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 }
138
139 x__xgafv: string, V1 error format.
140 Allowed values
141 1 - v1 error format
142 2 - v2 error format
143
144Returns:
145 An object of the form:
146
147 { # Result message for VerifiedAccess.VerifyChallengeResponse.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]148 &quot;devicePermanentId&quot;: &quot;A String&quot;, # Device permanent id is returned in this field (for the machine response only).
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]149 &quot;verificationOutput&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]150 &quot;signedPublicKeyAndChallenge&quot;: &quot;A String&quot;, # 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)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]151 &quot;deviceEnrollmentId&quot;: &quot;A String&quot;, # Device enrollment id is returned in this field (for the machine response only).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]152 }</pre>
153</div>
154
155</body></html>