Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / verifiedaccess_v1.challenge.html
blob: 0075c6eee2462f72e2cf16473accee3950c77ca4 [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">
78 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">CreateChallenge API</p>
80<p class="toc_element">
81 <code><a href="#verify">verify(body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">VerifyChallengeResponse API</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
86 <pre>CreateChallenge API
87
88Args:
89 body: object, The request body.
90 The object takes the form of:
91
92{ # A generic empty message that you can re-use to avoid defining duplicated
93 # empty messages in your APIs. A typical example is to use it as the request
94 # or the response type of an API method. For instance:
95 #
96 # service Foo {
97 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
98 # }
99 #
100 # The JSON representation for `Empty` is empty JSON object `{}`.
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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]112 &quot;alternativeChallenge&quot;: { # The wrapper message of any data and its signature. # Challenge generated with the old signing key
113 # (this will only be present during key rotation)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]114 &quot;signature&quot;: &quot;A String&quot;, # The signature of the data field.
115 &quot;data&quot;: &quot;A String&quot;, # The data to be signed.
116 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]117 &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]118 &quot;signature&quot;: &quot;A String&quot;, # The signature of the data field.
119 &quot;data&quot;: &quot;A String&quot;, # The data to be signed.
120 },
121 }</pre>
122</div>
123
124<div class="method">
125 <code class="details" id="verify">verify(body=None, x__xgafv=None)</code>
126 <pre>VerifyChallengeResponse API
127
128Args:
129 body: object, The request body.
130 The object takes the form of:
131
132{ # signed ChallengeResponse
133 &quot;challengeResponse&quot;: { # The wrapper message of any data and its signature. # The generated response to the challenge
134 &quot;signature&quot;: &quot;A String&quot;, # The signature of the data field.
135 &quot;data&quot;: &quot;A String&quot;, # The data to be signed.
136 },
137 &quot;expectedIdentity&quot;: &quot;A String&quot;, # Service can optionally provide identity information about the device
138 # or user associated with the key.
139 # For an EMK, this value is the enrolled domain.
140 # For an EUK, this value is the user&#x27;s email address.
141 # If present, this value will be checked against contents
142 # of the response, and verification will fail if there is no match.
143 }
144
145 x__xgafv: string, V1 error format.
146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
149
150Returns:
151 An object of the form:
152
153 { # Result message for VerifiedAccess.VerifyChallengeResponse.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]154 &quot;verificationOutput&quot;: &quot;A String&quot;, # For EMCert check, device permanent id is returned here.
155 # For EUCert check, signed_public_key_and_challenge [base64 encoded]
156 # is returned if present, otherwise empty string is returned.
157 # This field is deprecated, please use device_permanent_id or
158 # signed_public_key_and_challenge fields.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]159 &quot;signedPublicKeyAndChallenge&quot;: &quot;A String&quot;, # Certificate Signing Request (in the SPKAC format, base64 encoded) is
160 # returned in this field. This field will be set only if device has included
161 # CSR in its challenge response.
162 # (the option to include CSR is now available for both user and machine
163 # responses)
164 &quot;deviceEnrollmentId&quot;: &quot;A String&quot;, # Device enrollment id is returned in this field (for the machine response
165 # only).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]166 &quot;devicePermanentId&quot;: &quot;A String&quot;, # Device permanent id is returned in this field (for the machine response
167 # only).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]168 }</pre>
169</div>
170
171</body></html>