Skip to content

Commit 2b1cab0

Browse files
feat(firebaseappcheck): update the api
#### firebaseappcheck:v1 The following keys were added: - schemas.GoogleFirebaseAppcheckV1ExchangeAppAttestAssertionRequest.properties.limitedUse.type (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationRequest.properties.limitedUse.type (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1ExchangeCustomTokenRequest.properties.limitedUse.type (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest.properties.limitedUse.type (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1ExchangeDeviceCheckTokenRequest.properties.limitedUse.type (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1ExchangePlayIntegrityTokenRequest.properties.limitedUse.type (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1ExchangeRecaptchaEnterpriseTokenRequest.properties.limitedUse.type (Total Keys: 1) - schemas.GoogleFirebaseAppcheckV1ExchangeRecaptchaV3TokenRequest.properties.limitedUse.type (Total Keys: 1)
1 parent fc41885 commit 2b1cab0

File tree

4 files changed

+59
-19
lines changed

4 files changed

+59
-19
lines changed

docs/dyn/firebaseappcheck_v1.projects.apps.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,7 @@ <h3>Method Details</h3>
164164
&quot;artifact&quot;: &quot;A String&quot;, # Required. The artifact returned by a previous call to ExchangeAppAttestAttestation.
165165
&quot;assertion&quot;: &quot;A String&quot;, # Required. The CBOR-encoded assertion returned by the client-side App Attest API.
166166
&quot;challenge&quot;: &quot;A String&quot;, # Required. A one-time challenge returned by an immediately prior call to GenerateAppAttestChallenge.
167+
&quot;limitedUse&quot;: True or False, # Forces a short lived token with a 5 minute TTL. Useful when the client wishes to self impose stricter TTL requirements for this exchange. Default: false.
167168
}
168169

169170
x__xgafv: string, V1 error format.
@@ -193,6 +194,7 @@ <h3>Method Details</h3>
193194
&quot;attestationStatement&quot;: &quot;A String&quot;, # Required. The App Attest statement returned by the client-side App Attest API. This is a base64url encoded CBOR object in the JSON response.
194195
&quot;challenge&quot;: &quot;A String&quot;, # Required. A one-time challenge returned by an immediately prior call to GenerateAppAttestChallenge.
195196
&quot;keyId&quot;: &quot;A String&quot;, # Required. The key ID generated by App Attest for the client app.
197+
&quot;limitedUse&quot;: True or False, # Forces a short lived token with a 5 minute TTL. Useful when the client wishes to self impose stricter TTL requirements for this exchange. Default: false.
196198
}
197199

198200
x__xgafv: string, V1 error format.
@@ -223,6 +225,7 @@ <h3>Method Details</h3>
223225

224226
{ # Request message for the ExchangeCustomToken method.
225227
&quot;customToken&quot;: &quot;A String&quot;, # Required. A custom token signed using your project&#x27;s Admin SDK service account credentials.
228+
&quot;limitedUse&quot;: True or False, # Forces a short lived token with a 5 minute TTL. Useful when the client wishes to self impose stricter TTL requirements for this exchange. Default: false.
226229
}
227230

228231
x__xgafv: string, V1 error format.
@@ -250,6 +253,7 @@ <h3>Method Details</h3>
250253

251254
{ # Request message for the ExchangeDebugToken method.
252255
&quot;debugToken&quot;: &quot;A String&quot;, # Required. A debug token secret. This string must match a debug token secret previously created using CreateDebugToken.
256+
&quot;limitedUse&quot;: True or False, # Forces a short lived token with a 5 minute TTL. Useful when the client wishes to self impose stricter TTL requirements for this exchange. Default: false.
253257
}
254258

255259
x__xgafv: string, V1 error format.
@@ -277,6 +281,7 @@ <h3>Method Details</h3>
277281

278282
{ # Request message for the ExchangeDeviceCheckToken method.
279283
&quot;deviceToken&quot;: &quot;A String&quot;, # Required. 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.
284+
&quot;limitedUse&quot;: True or False, # Forces a short lived token with a 5 minute TTL. Useful when the client wishes to self impose stricter TTL requirements for this exchange. Default: false.
280285
}
281286

282287
x__xgafv: string, V1 error format.
@@ -303,6 +308,7 @@ <h3>Method Details</h3>
303308
The object takes the form of:
304309

305310
{ # Request message for the ExchangePlayIntegrityToken method.
311+
&quot;limitedUse&quot;: True or False, # Forces a short-lived token with a 5 minute TTL. Useful when the client wishes to impose stricter TTL requirements for this exchange. Default: false.
306312
&quot;playIntegrityToken&quot;: &quot;A String&quot;, # Required. The [integrity verdict response token from Play Integrity](https://developer.android.com/google/play/integrity/verdict#decrypt-verify) issued to your app.
307313
}
308314

@@ -330,6 +336,7 @@ <h3>Method Details</h3>
330336
The object takes the form of:
331337

332338
{ # Request message for the ExchangeRecaptchaEnterpriseToken method.
339+
&quot;limitedUse&quot;: True or False, # Forces a short lived token with a 5 minute TTL. Useful when the client wishes to self impose stricter TTL requirements for this exchange. Default: false.
333340
&quot;recaptchaEnterpriseToken&quot;: &quot;A String&quot;, # Required. The reCAPTCHA token as returned by the [reCAPTCHA Enterprise JavaScript API](https://cloud.google.com/recaptcha-enterprise/docs/instrument-web-pages).
334341
}
335342

@@ -357,6 +364,7 @@ <h3>Method Details</h3>
357364
The object takes the form of:
358365

359366
{ # Request message for the ExchangeRecaptchaV3Token method.
367+
&quot;limitedUse&quot;: True or False, # Forces a short lived token with a 5 minute TTL. Useful when the client wishes to self impose stricter TTL requirements for this exchange. Default: false.
360368
&quot;recaptchaV3Token&quot;: &quot;A String&quot;, # Required. The reCAPTCHA token as returned by the [reCAPTCHA v3 JavaScript API](https://developers.google.com/recaptcha/docs/v3).
361369
}
362370

docs/dyn/firebaseappcheck_v1beta.projects.services.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ <h3>Method Details</h3>
105105
{ # Request message for the BatchUpdateServices method.
106106
&quot;requests&quot;: [ # Required. The request messages specifying the Services to update. A maximum of 100 objects can be updated in a batch.
107107
{ # Request message for the UpdateService method as well as an individual update message for the BatchUpdateServices method.
108-
&quot;service&quot;: { # The enforcement configuration for a Firebase service supported by App Check. # Required. The Service to update. The Service&#x27;s `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore)
108+
&quot;service&quot;: { # The enforcement configuration for a Firebase service supported by App Check. # Required. The Service to update. The Service&#x27;s `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) For Firebase Authentication to work with App Check, you must first upgrade to [Firebase Authentication with Identity Platform](https://firebase.google.com/docs/auth#identity-platform).
109109
&quot;enforcementMode&quot;: &quot;A String&quot;, # Required. The App Check enforcement mode for this service.
110-
&quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore)
110+
&quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform)
111111
},
112112
&quot;updateMask&quot;: &quot;A String&quot;, # Required. A comma-separated list of names of fields in the Service to update. Example: `enforcement_mode`.
113113
},
@@ -127,7 +127,7 @@ <h3>Method Details</h3>
127127
&quot;services&quot;: [ # Service objects after the updates have been applied.
128128
{ # The enforcement configuration for a Firebase service supported by App Check.
129129
&quot;enforcementMode&quot;: &quot;A String&quot;, # Required. The App Check enforcement mode for this service.
130-
&quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore)
130+
&quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform)
131131
},
132132
],
133133
}</pre>
@@ -143,7 +143,7 @@ <h3>Method Details</h3>
143143
<pre>Gets the Service configuration for the specified service name.
144144

145145
Args:
146-
name: string, Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) (required)
146+
name: string, Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) (required)
147147
x__xgafv: string, V1 error format.
148148
Allowed values
149149
1 - v1 error format
@@ -154,7 +154,7 @@ <h3>Method Details</h3>
154154

155155
{ # The enforcement configuration for a Firebase service supported by App Check.
156156
&quot;enforcementMode&quot;: &quot;A String&quot;, # Required. The App Check enforcement mode for this service.
157-
&quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore)
157+
&quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform)
158158
}</pre>
159159
</div>
160160

@@ -179,7 +179,7 @@ <h3>Method Details</h3>
179179
&quot;services&quot;: [ # The Services retrieved.
180180
{ # The enforcement configuration for a Firebase service supported by App Check.
181181
&quot;enforcementMode&quot;: &quot;A String&quot;, # Required. The App Check enforcement mode for this service.
182-
&quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore)
182+
&quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform)
183183
},
184184
],
185185
}</pre>
@@ -204,13 +204,13 @@ <h3>Method Details</h3>
204204
<pre>Updates the specified Service configuration.
205205

206206
Args:
207-
name: string, Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) (required)
207+
name: string, Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) (required)
208208
body: object, The request body.
209209
The object takes the form of:
210210

211211
{ # The enforcement configuration for a Firebase service supported by App Check.
212212
&quot;enforcementMode&quot;: &quot;A String&quot;, # Required. The App Check enforcement mode for this service.
213-
&quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore)
213+
&quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform)
214214
}
215215

216216
updateMask: string, Required. A comma-separated list of names of fields in the Service to update. Example: `enforcement_mode`.
@@ -224,7 +224,7 @@ <h3>Method Details</h3>
224224

225225
{ # The enforcement configuration for a Firebase service supported by App Check.
226226
&quot;enforcementMode&quot;: &quot;A String&quot;, # Required. The App Check enforcement mode for this service.
227-
&quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore)
227+
&quot;name&quot;: &quot;A String&quot;, # Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform)
228228
}</pre>
229229
</div>
230230

0 commit comments

Comments
 (0)