Blame - docs/dyn/firebaseappcheck_v1beta.projects.apps.html - platform/external/python/google-api-python-client

blob: a3f27b3bf1e92632df10659762576934520e0dfe [file] [log] [blame]

yoshi-code-bot	4c9ccb0	2021-05-27 00:38:02 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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">
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	78	<code><a href="firebaseappcheck_v1beta.projects.apps.appAttestConfig.html">appAttestConfig()</a></code>
				79	</p>
				80	<p class="firstline">Returns the appAttestConfig Resource.</p>
				81
				82	<p class="toc_element">
yoshi-code-bot	4c9ccb0	2021-05-27 00:38:02 -0700	[diff] [blame]	83	<code><a href="firebaseappcheck_v1beta.projects.apps.debugTokens.html">debugTokens()</a></code>
				84	</p>
				85	<p class="firstline">Returns the debugTokens Resource.</p>
				86
				87	<p class="toc_element">
				88	<code><a href="firebaseappcheck_v1beta.projects.apps.deviceCheckConfig.html">deviceCheckConfig()</a></code>
				89	</p>
				90	<p class="firstline">Returns the deviceCheckConfig Resource.</p>
				91
				92	<p class="toc_element">
				93	<code><a href="firebaseappcheck_v1beta.projects.apps.recaptchaConfig.html">recaptchaConfig()</a></code>
				94	</p>
				95	<p class="firstline">Returns the recaptchaConfig Resource.</p>
				96
				97	<p class="toc_element">
yoshi-code-bot	0770807	2021-07-20 00:20:24 -0700	[diff] [blame]	98	<code><a href="firebaseappcheck_v1beta.projects.apps.safetyNetConfig.html">safetyNetConfig()</a></code>
				99	</p>
				100	<p class="firstline">Returns the safetyNetConfig Resource.</p>
				101
				102	<p class="toc_element">
yoshi-code-bot	4c9ccb0	2021-05-27 00:38:02 -0700	[diff] [blame]	103	<code><a href="#close">close()</a></code></p>
				104	<p class="firstline">Close httplib2 connections.</p>
				105	<p class="toc_element">
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	106	<code><a href="#exchangeAppAttestAssertion">exchangeAppAttestAssertion(app, body=None, x__xgafv=None)</a></code></p>
				107	<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>
				108	<p class="toc_element">
				109	<code><a href="#exchangeAppAttestAttestation">exchangeAppAttestAttestation(app, body=None, x__xgafv=None)</a></code></p>
				110	<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>
				111	<p class="toc_element">
yoshi-code-bot	4c9ccb0	2021-05-27 00:38:02 -0700	[diff] [blame]	112	<code><a href="#exchangeCustomToken">exchangeCustomToken(app, body=None, x__xgafv=None)</a></code></p>
				113	<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>
				114	<p class="toc_element">
				115	<code><a href="#exchangeDebugToken">exchangeDebugToken(app, body=None, x__xgafv=None)</a></code></p>
				116	<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>
				117	<p class="toc_element">
				118	<code><a href="#exchangeDeviceCheckToken">exchangeDeviceCheckToken(app, body=None, x__xgafv=None)</a></code></p>
				119	<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>
				120	<p class="toc_element">
				121	<code><a href="#exchangeRecaptchaToken">exchangeRecaptchaToken(app, body=None, x__xgafv=None)</a></code></p>
				122	<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>
				123	<p class="toc_element">
				124	<code><a href="#exchangeSafetyNetToken">exchangeSafetyNetToken(app, body=None, x__xgafv=None)</a></code></p>
				125	<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-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	126	<p class="toc_element">
				127	<code><a href="#generateAppAttestChallenge">generateAppAttestChallenge(app, body=None, x__xgafv=None)</a></code></p>
				128	<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-bot	4c9ccb0	2021-05-27 00:38:02 -0700	[diff] [blame]	129	<h3>Method Details</h3>
				130	<div class="method">
				131	<code class="details" id="close">close()</code>
				132	<pre>Close httplib2 connections.</pre>
				133	</div>
				134
				135	<div class="method">
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	136	<code class="details" id="exchangeAppAttestAssertion">exchangeAppAttestAssertion(app, body=None, x__xgafv=None)</code>
				137	<pre>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.
				138
				139	Args:
				140	app: string, Required. The full resource name to the iOS App. Format: "projects/{project_id}/apps/{app_id}" (required)
				141	body: object, The request body.
				142	The object takes the form of:
				143
				144	{ # Request message for ExchangeAppAttestAssertion
				145	"artifact": "A String", # The artifact previously returned by ExchangeAppAttestAttestation.
				146	"assertion": "A String", # The CBOR encoded assertion provided by the Apple App Attest SDK.
				147	"challenge": "A String", # A one time challenge returned by GenerateAppAttestChallenge.
				148	}
				149
				150	x__xgafv: string, V1 error format.
				151	Allowed values
				152	1 - v1 error format
				153	2 - v2 error format
				154
				155	Returns:
				156	An object of the form:
				157
				158	{ # Encapsulates an App Check token, which are used to access Firebase services protected by App Check.
				159	"attestationToken": "A String", # 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.
				160	"ttl": "A String", # 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.
				161	}</pre>
				162	</div>
				163
				164	<div class="method">
				165	<code class="details" id="exchangeAppAttestAttestation">exchangeAppAttestAttestation(app, body=None, x__xgafv=None)</code>
				166	<pre>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.
				167
				168	Args:
				169	app: string, Required. The full resource name to the iOS App. Format: "projects/{project_id}/apps/{app_id}" (required)
				170	body: object, The request body.
				171	The object takes the form of:
				172
				173	{ # Request message for ExchangeAppAttestAttestation
				174	"attestationStatement": "A String", # The App Attest statement as returned by Apple's client-side App Attest API. This is the CBOR object returned by Apple, which will be Base64 encoded in the JSON API.
				175	"challenge": "A String", # The challenge previously generated by the FAC backend.
				176	"keyId": "A String", # The key ID generated by App Attest for the client app.
				177	}
				178
				179	x__xgafv: string, V1 error format.
				180	Allowed values
				181	1 - v1 error format
				182	2 - v2 error format
				183
				184	Returns:
				185	An object of the form:
				186
yoshi-code-bot	a933dad	2021-07-06 00:26:24 -0700	[diff] [blame]	187	{ # Response message for ExchangeAppAttestAttestation and ExchangeAppAttestDebugAttestation
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	188	"artifact": "A String", # An artifact that should be passed back during the Assertion flow.
				189	"attestationToken": { # 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.
				190	"attestationToken": "A String", # 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.
				191	"ttl": "A String", # 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.
				192	},
				193	}</pre>
				194	</div>
				195
				196	<div class="method">
yoshi-code-bot	4c9ccb0	2021-05-27 00:38:02 -0700	[diff] [blame]	197	<code class="details" id="exchangeCustomToken">exchangeCustomToken(app, body=None, x__xgafv=None)</code>
				198	<pre>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.
				199
				200	Args:
				201	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's [AIP 2510](https://google.aip.dev/cloud/2510) standard. (required)
				202	body: object, The request body.
				203	The object takes the form of:
				204
				205	{ # Request message for the ExchangeCustomToken method.
				206	"customToken": "A String", # A custom token signed using your project's Admin SDK service account credentials.
				207	}
				208
				209	x__xgafv: string, V1 error format.
				210	Allowed values
				211	1 - v1 error format
				212	2 - v2 error format
				213
				214	Returns:
				215	An object of the form:
				216
				217	{ # Encapsulates an App Check token, which are used to access Firebase services protected by App Check.
				218	"attestationToken": "A String", # 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.
				219	"ttl": "A String", # 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.
				220	}</pre>
				221	</div>
				222
				223	<div class="method">
				224	<code class="details" id="exchangeDebugToken">exchangeDebugToken(app, body=None, x__xgafv=None)</code>
				225	<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.
				226
				227	Args:
				228	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's [AIP 2510](https://google.aip.dev/cloud/2510) standard. (required)
				229	body: object, The request body.
				230	The object takes the form of:
				231
				232	{ # Request message for the ExchangeDebugToken method.
				233	"debugToken": "A String", # A debug token secret. This string must match a debug token secret previously created using CreateDebugToken.
				234	}
				235
				236	x__xgafv: string, V1 error format.
				237	Allowed values
				238	1 - v1 error format
				239	2 - v2 error format
				240
				241	Returns:
				242	An object of the form:
				243
				244	{ # Encapsulates an App Check token, which are used to access Firebase services protected by App Check.
				245	"attestationToken": "A String", # 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.
				246	"ttl": "A String", # 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.
				247	}</pre>
				248	</div>
				249
				250	<div class="method">
				251	<code class="details" id="exchangeDeviceCheckToken">exchangeDeviceCheckToken(app, body=None, x__xgafv=None)</code>
				252	<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.
				253
				254	Args:
				255	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's [AIP 2510](https://google.aip.dev/cloud/2510) standard. (required)
				256	body: object, The request body.
				257	The object takes the form of:
				258
				259	{ # Request message for the ExchangeDeviceCheckToken method.
				260	"deviceToken": "A String", # The `device_token` as returned by Apple's client-side [DeviceCheck API](https://developer.apple.com/documentation/devicecheck/dcdevice). This is the Base64 encoded `Data` (Swift) or `NSData` (ObjC) object.
				261	}
				262
				263	x__xgafv: string, V1 error format.
				264	Allowed values
				265	1 - v1 error format
				266	2 - v2 error format
				267
				268	Returns:
				269	An object of the form:
				270
				271	{ # Encapsulates an App Check token, which are used to access Firebase services protected by App Check.
				272	"attestationToken": "A String", # 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.
				273	"ttl": "A String", # 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.
				274	}</pre>
				275	</div>
				276
				277	<div class="method">
				278	<code class="details" id="exchangeRecaptchaToken">exchangeRecaptchaToken(app, body=None, x__xgafv=None)</code>
				279	<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.
				280
				281	Args:
				282	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's [AIP 2510](https://google.aip.dev/cloud/2510) standard. (required)
				283	body: object, The request body.
				284	The object takes the form of:
				285
				286	{ # Request message for the ExchangeRecaptchaToken method.
				287	"recaptchaToken": "A String", # The reCAPTCHA token as returned by the [reCAPTCHA v3 JavaScript API](https://developers.google.com/recaptcha/docs/v3).
				288	}
				289
				290	x__xgafv: string, V1 error format.
				291	Allowed values
				292	1 - v1 error format
				293	2 - v2 error format
				294
				295	Returns:
				296	An object of the form:
				297
				298	{ # Encapsulates an App Check token, which are used to access Firebase services protected by App Check.
				299	"attestationToken": "A String", # 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.
				300	"ttl": "A String", # 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.
				301	}</pre>
				302	</div>
				303
				304	<div class="method">
				305	<code class="details" id="exchangeSafetyNetToken">exchangeSafetyNetToken(app, body=None, x__xgafv=None)</code>
				306	<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.
				307
				308	Args:
				309	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's [AIP 2510](https://google.aip.dev/cloud/2510) standard. (required)
				310	body: object, The request body.
				311	The object takes the form of:
				312
				313	{ # Request message for the ExchangeSafetyNetToken method.
				314	"safetyNetToken": "A String", # The [SafetyNet attestation response](https://developer.android.com/training/safetynet/attestation#request-attestation-step) issued to your app.
				315	}
				316
				317	x__xgafv: string, V1 error format.
				318	Allowed values
				319	1 - v1 error format
				320	2 - v2 error format
				321
				322	Returns:
				323	An object of the form:
				324
				325	{ # Encapsulates an App Check token, which are used to access Firebase services protected by App Check.
				326	"attestationToken": "A String", # 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.
				327	"ttl": "A String", # 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.
				328	}</pre>
				329	</div>
				330
yoshi-code-bot	04bafe1	2021-06-29 00:20:25 -0700	[diff] [blame]	331	<div class="method">
				332	<code class="details" id="generateAppAttestChallenge">generateAppAttestChallenge(app, body=None, x__xgafv=None)</code>
				333	<pre>Initiates the App Attest flow by generating a challenge which will be used as a type of nonce for this attestation.
				334
				335	Args:
				336	app: string, Required. The full resource name to the iOS App. Format: "projects/{project_id}/apps/{app_id}" (required)
				337	body: object, The request body.
				338	The object takes the form of:
				339
				340	{ # Request message for GenerateAppAttestChallenge
				341	}
				342
				343	x__xgafv: string, V1 error format.
				344	Allowed values
				345	1 - v1 error format
				346	2 - v2 error format
				347
				348	Returns:
				349	An object of the form:
				350
				351	{ # Response object for GenerateAppAttestChallenge
				352	"challenge": "A String", # A one time use challenge for the client to pass to Apple's App Attest API.
				353	"ttl": "A String", # 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.
				354	}</pre>
				355	</div>
				356
yoshi-code-bot	4c9ccb0	2021-05-27 00:38:02 -0700	[diff] [blame]	357	</body></html>