Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 04bafe14efe7a6d1a7da03de89312062a4afa127 / . / docs / dyn / firebaseappcheck_v1beta.projects.apps.html
blob: bbbdbcbe3128311be2dbfc19c21c2efe0013f6ea [file] [log] [blame]
yoshi-code-bot4c9ccb02021-05-27 00:38:02 -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="firebaseappcheck_v1beta.html">Firebase App Check API</a> . <a href="firebaseappcheck_v1beta.projects.html">projects</a> . <a href="firebaseappcheck_v1beta.projects.apps.html">apps</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="firebaseappcheck_v1beta.projects.apps.debugTokens.html">debugTokens()</a></code>
79</p>
80<p class="firstline">Returns the debugTokens Resource.</p>
81
82<p class="toc_element">
83 <code><a href="firebaseappcheck_v1beta.projects.apps.deviceCheckConfig.html">deviceCheckConfig()</a></code>
84</p>
85<p class="firstline">Returns the deviceCheckConfig Resource.</p>
86
87<p class="toc_element">
88 <code><a href="firebaseappcheck_v1beta.projects.apps.recaptchaConfig.html">recaptchaConfig()</a></code>
89</p>
90<p class="firstline">Returns the recaptchaConfig Resource.</p>
91
92<p class="toc_element">
93 <code><a href="#close">close()</a></code></p>
94<p class="firstline">Close httplib2 connections.</p>
95<p class="toc_element">
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]96 <code><a href="#exchangeAppAttestAssertion">exchangeAppAttestAssertion(app, body=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Accepts a AppAttest Artifact and Assertion, and uses the developer's preconfigured auth token to verify the token with Apple. Returns an AttestationToken with the App ID as specified by the `app` field included as attested claims.</p>
98<p class="toc_element">
99 <code><a href="#exchangeAppAttestAttestation">exchangeAppAttestAttestation(app, body=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Accepts a AppAttest CBOR Attestation, and uses the developer's preconfigured team and bundle IDs to verify the token with Apple. Returns an Attestation Artifact that can later be exchanged for an AttestationToken in ExchangeAppAttestAssertion.</p>
101<p class="toc_element">
yoshi-code-bot4c9ccb02021-05-27 00:38:02 -0700[diff] [blame]102 <code><a href="#exchangeCustomToken">exchangeCustomToken(app, body=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Validates a custom token signed using your project's Admin SDK service account credentials. If valid, returns an App Check token encapsulated in an AttestationTokenResponse.</p>
104<p class="toc_element">
105 <code><a href="#exchangeDebugToken">exchangeDebugToken(app, body=None, x__xgafv=None)</a></code></p>
106<p class="firstline">Validates a debug token secret that you have previously created using CreateDebugToken. If valid, returns an App Check token encapsulated in an AttestationTokenResponse. Note that a restrictive quota is enforced on this method to prevent accidental exposure of the app to abuse.</p>
107<p class="toc_element">
108 <code><a href="#exchangeDeviceCheckToken">exchangeDeviceCheckToken(app, body=None, x__xgafv=None)</a></code></p>
109<p class="firstline">Accepts a [`device_token`](https://developer.apple.com/documentation/devicecheck/dcdevice) issued by DeviceCheck, and attempts to validate it with Apple. If valid, returns an App Check token encapsulated in an AttestationTokenResponse.</p>
110<p class="toc_element">
111 <code><a href="#exchangeRecaptchaToken">exchangeRecaptchaToken(app, body=None, x__xgafv=None)</a></code></p>
112<p class="firstline">Validates a [reCAPTCHA v3 response token](https://developers.google.com/recaptcha/docs/v3). If valid, returns an App Check token encapsulated in an AttestationTokenResponse.</p>
113<p class="toc_element">
114 <code><a href="#exchangeSafetyNetToken">exchangeSafetyNetToken(app, body=None, x__xgafv=None)</a></code></p>
115<p class="firstline">Validates a [SafetyNet token](https://developer.android.com/training/safetynet/attestation#request-attestation-step). If valid, returns an App Check token encapsulated in an AttestationTokenResponse.</p>
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]116<p class="toc_element">
117 <code><a href="#generateAppAttestChallenge">generateAppAttestChallenge(app, body=None, x__xgafv=None)</a></code></p>
118<p class="firstline">Initiates the App Attest flow by generating a challenge which will be used as a type of nonce for this attestation.</p>
yoshi-code-bot4c9ccb02021-05-27 00:38:02 -0700[diff] [blame]119<h3>Method Details</h3>
120<div class="method">
121 <code class="details" id="close">close()</code>
122 <pre>Close httplib2 connections.</pre>
123</div>
124
125<div class="method">
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]126 <code class="details" id="exchangeAppAttestAssertion">exchangeAppAttestAssertion(app, body=None, x__xgafv=None)</code>
127 <pre>Accepts a AppAttest Artifact and Assertion, and uses the developer&#x27;s preconfigured auth token to verify the token with Apple. Returns an AttestationToken with the App ID as specified by the `app` field included as attested claims.
128
129Args:
130 app: string, Required. The full resource name to the iOS App. Format: &quot;projects/{project_id}/apps/{app_id}&quot; (required)
131 body: object, The request body.
132 The object takes the form of:
133
134{ # Request message for ExchangeAppAttestAssertion
135 &quot;artifact&quot;: &quot;A String&quot;, # The artifact previously returned by ExchangeAppAttestAttestation.
136 &quot;assertion&quot;: &quot;A String&quot;, # The CBOR encoded assertion provided by the Apple App Attest SDK.
137 &quot;challenge&quot;: &quot;A String&quot;, # A one time challenge returned by GenerateAppAttestChallenge.
138}
139
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
144
145Returns:
146 An object of the form:
147
148 { # Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check.
149 &quot;attestationToken&quot;: &quot;A String&quot;, # An App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check.
150 &quot;ttl&quot;: &quot;A String&quot;, # The duration from the time this token is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.
151}</pre>
152</div>
153
154<div class="method">
155 <code class="details" id="exchangeAppAttestAttestation">exchangeAppAttestAttestation(app, body=None, x__xgafv=None)</code>
156 <pre>Accepts a AppAttest CBOR Attestation, and uses the developer&#x27;s preconfigured team and bundle IDs to verify the token with Apple. Returns an Attestation Artifact that can later be exchanged for an AttestationToken in ExchangeAppAttestAssertion.
157
158Args:
159 app: string, Required. The full resource name to the iOS App. Format: &quot;projects/{project_id}/apps/{app_id}&quot; (required)
160 body: object, The request body.
161 The object takes the form of:
162
163{ # Request message for ExchangeAppAttestAttestation
164 &quot;attestationStatement&quot;: &quot;A String&quot;, # The App Attest statement as returned by Apple&#x27;s client-side App Attest API. This is the CBOR object returned by Apple, which will be Base64 encoded in the JSON API.
165 &quot;challenge&quot;: &quot;A String&quot;, # The challenge previously generated by the FAC backend.
166 &quot;keyId&quot;: &quot;A String&quot;, # The key ID generated by App Attest for the client app.
167}
168
169 x__xgafv: string, V1 error format.
170 Allowed values
171 1 - v1 error format
172 2 - v2 error format
173
174Returns:
175 An object of the form:
176
177 { # Response message for ExchangeAppAttestAttestation
178 &quot;artifact&quot;: &quot;A String&quot;, # An artifact that should be passed back during the Assertion flow.
179 &quot;attestationToken&quot;: { # Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check. # An attestation token which can be used to access Firebase APIs.
180 &quot;attestationToken&quot;: &quot;A String&quot;, # An App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check.
181 &quot;ttl&quot;: &quot;A String&quot;, # The duration from the time this token is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.
182 },
183}</pre>
184</div>
185
186<div class="method">
yoshi-code-bot4c9ccb02021-05-27 00:38:02 -0700[diff] [blame]187 <code class="details" id="exchangeCustomToken">exchangeCustomToken(app, body=None, x__xgafv=None)</code>
188 <pre>Validates a custom token signed using your project&#x27;s Admin SDK service account credentials. If valid, returns an App Check token encapsulated in an AttestationTokenResponse.
189
190Args:
191 app: string, Required. The relative resource name of the app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google&#x27;s [AIP 2510](https://google.aip.dev/cloud/2510) standard. (required)
192 body: object, The request body.
193 The object takes the form of:
194
195{ # Request message for the ExchangeCustomToken method.
196 &quot;customToken&quot;: &quot;A String&quot;, # A custom token signed using your project&#x27;s Admin SDK service account credentials.
197}
198
199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
203
204Returns:
205 An object of the form:
206
207 { # Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check.
208 &quot;attestationToken&quot;: &quot;A String&quot;, # An App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check.
209 &quot;ttl&quot;: &quot;A String&quot;, # The duration from the time this token is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.
210}</pre>
211</div>
212
213<div class="method">
214 <code class="details" id="exchangeDebugToken">exchangeDebugToken(app, body=None, x__xgafv=None)</code>
215 <pre>Validates a debug token secret that you have previously created using CreateDebugToken. If valid, returns an App Check token encapsulated in an AttestationTokenResponse. Note that a restrictive quota is enforced on this method to prevent accidental exposure of the app to abuse.
216
217Args:
218 app: string, Required. The relative resource name of the app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google&#x27;s [AIP 2510](https://google.aip.dev/cloud/2510) standard. (required)
219 body: object, The request body.
220 The object takes the form of:
221
222{ # Request message for the ExchangeDebugToken method.
223 &quot;debugToken&quot;: &quot;A String&quot;, # A debug token secret. This string must match a debug token secret previously created using CreateDebugToken.
224}
225
226 x__xgafv: string, V1 error format.
227 Allowed values
228 1 - v1 error format
229 2 - v2 error format
230
231Returns:
232 An object of the form:
233
234 { # Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check.
235 &quot;attestationToken&quot;: &quot;A String&quot;, # An App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check.
236 &quot;ttl&quot;: &quot;A String&quot;, # The duration from the time this token is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.
237}</pre>
238</div>
239
240<div class="method">
241 <code class="details" id="exchangeDeviceCheckToken">exchangeDeviceCheckToken(app, body=None, x__xgafv=None)</code>
242 <pre>Accepts a [`device_token`](https://developer.apple.com/documentation/devicecheck/dcdevice) issued by DeviceCheck, and attempts to validate it with Apple. If valid, returns an App Check token encapsulated in an AttestationTokenResponse.
243
244Args:
245 app: string, Required. The relative resource name of the iOS app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google&#x27;s [AIP 2510](https://google.aip.dev/cloud/2510) standard. (required)
246 body: object, The request body.
247 The object takes the form of:
248
249{ # Request message for the ExchangeDeviceCheckToken method.
250 &quot;deviceToken&quot;: &quot;A String&quot;, # The `device_token` as returned by Apple&#x27;s client-side [DeviceCheck API](https://developer.apple.com/documentation/devicecheck/dcdevice). This is the Base64 encoded `Data` (Swift) or `NSData` (ObjC) object.
251}
252
253 x__xgafv: string, V1 error format.
254 Allowed values
255 1 - v1 error format
256 2 - v2 error format
257
258Returns:
259 An object of the form:
260
261 { # Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check.
262 &quot;attestationToken&quot;: &quot;A String&quot;, # An App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check.
263 &quot;ttl&quot;: &quot;A String&quot;, # The duration from the time this token is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.
264}</pre>
265</div>
266
267<div class="method">
268 <code class="details" id="exchangeRecaptchaToken">exchangeRecaptchaToken(app, body=None, x__xgafv=None)</code>
269 <pre>Validates a [reCAPTCHA v3 response token](https://developers.google.com/recaptcha/docs/v3). If valid, returns an App Check token encapsulated in an AttestationTokenResponse.
270
271Args:
272 app: string, Required. The relative resource name of the web app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google&#x27;s [AIP 2510](https://google.aip.dev/cloud/2510) standard. (required)
273 body: object, The request body.
274 The object takes the form of:
275
276{ # Request message for the ExchangeRecaptchaToken method.
277 &quot;recaptchaToken&quot;: &quot;A String&quot;, # The reCAPTCHA token as returned by the [reCAPTCHA v3 JavaScript API](https://developers.google.com/recaptcha/docs/v3).
278}
279
280 x__xgafv: string, V1 error format.
281 Allowed values
282 1 - v1 error format
283 2 - v2 error format
284
285Returns:
286 An object of the form:
287
288 { # Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check.
289 &quot;attestationToken&quot;: &quot;A String&quot;, # An App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check.
290 &quot;ttl&quot;: &quot;A String&quot;, # The duration from the time this token is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.
291}</pre>
292</div>
293
294<div class="method">
295 <code class="details" id="exchangeSafetyNetToken">exchangeSafetyNetToken(app, body=None, x__xgafv=None)</code>
296 <pre>Validates a [SafetyNet token](https://developer.android.com/training/safetynet/attestation#request-attestation-step). If valid, returns an App Check token encapsulated in an AttestationTokenResponse.
297
298Args:
299 app: string, Required. The relative resource name of the Android app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google&#x27;s [AIP 2510](https://google.aip.dev/cloud/2510) standard. (required)
300 body: object, The request body.
301 The object takes the form of:
302
303{ # Request message for the ExchangeSafetyNetToken method.
304 &quot;safetyNetToken&quot;: &quot;A String&quot;, # The [SafetyNet attestation response](https://developer.android.com/training/safetynet/attestation#request-attestation-step) issued to your app.
305}
306
307 x__xgafv: string, V1 error format.
308 Allowed values
309 1 - v1 error format
310 2 - v2 error format
311
312Returns:
313 An object of the form:
314
315 { # Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check.
316 &quot;attestationToken&quot;: &quot;A String&quot;, # An App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check.
317 &quot;ttl&quot;: &quot;A String&quot;, # The duration from the time this token is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.
318}</pre>
319</div>
320
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700[diff] [blame^]321<div class="method">
322 <code class="details" id="generateAppAttestChallenge">generateAppAttestChallenge(app, body=None, x__xgafv=None)</code>
323 <pre>Initiates the App Attest flow by generating a challenge which will be used as a type of nonce for this attestation.
324
325Args:
326 app: string, Required. The full resource name to the iOS App. Format: &quot;projects/{project_id}/apps/{app_id}&quot; (required)
327 body: object, The request body.
328 The object takes the form of:
329
330{ # Request message for GenerateAppAttestChallenge
331}
332
333 x__xgafv: string, V1 error format.
334 Allowed values
335 1 - v1 error format
336 2 - v2 error format
337
338Returns:
339 An object of the form:
340
341 { # Response object for GenerateAppAttestChallenge
342 &quot;challenge&quot;: &quot;A String&quot;, # A one time use challenge for the client to pass to Apple&#x27;s App Attest API.
343 &quot;ttl&quot;: &quot;A String&quot;, # The duration from the time this challenge is minted until it is expired. This field is intended to ease client-side token management, since the device may have clock skew, but is still able to accurately measure a duration. This expiration is intended to minimize the replay window within which a single challenge may be reused. See AIP 142 for naming of this field.
344}</pre>
345</div>
346
yoshi-code-bot4c9ccb02021-05-27 00:38:02 -0700[diff] [blame]347</body></html>