google-apis-firebaseappcheck_v1 0.1.0 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/firebaseappcheck_v1/classes.rb +1022 -0
- data/lib/google/apis/firebaseappcheck_v1/gem_version.rb +2 -2
- data/lib/google/apis/firebaseappcheck_v1/representations.rb +523 -0
- data/lib/google/apis/firebaseappcheck_v1/service.rb +1481 -0
- data/lib/google/apis/firebaseappcheck_v1.rb +6 -0
- metadata +3 -3
@@ -49,6 +49,1487 @@ module Google
|
|
49
49
|
client_version: Google::Apis::FirebaseappcheckV1::GEM_VERSION)
|
50
50
|
@batch_path = 'batch'
|
51
51
|
end
|
52
|
+
|
53
|
+
# Returns a public JWK set as specified by [RFC 7517](https://tools.ietf.org/
|
54
|
+
# html/rfc7517) that can be used to verify App Check tokens. Exactly one of the
|
55
|
+
# public keys in the returned set will successfully validate any App Check token
|
56
|
+
# that is currently valid.
|
57
|
+
# @param [String] name
|
58
|
+
# Required. The relative resource name to the public JWK set. Must always be
|
59
|
+
# exactly the string `jwks`.
|
60
|
+
# @param [String] fields
|
61
|
+
# Selector specifying which fields to include in a partial response.
|
62
|
+
# @param [String] quota_user
|
63
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
64
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
65
|
+
# @param [Google::Apis::RequestOptions] options
|
66
|
+
# Request-specific options
|
67
|
+
#
|
68
|
+
# @yield [result, err] Result & error if block supplied
|
69
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PublicJwkSet] parsed result object
|
70
|
+
# @yieldparam err [StandardError] error object if request failed
|
71
|
+
#
|
72
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PublicJwkSet]
|
73
|
+
#
|
74
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
75
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
76
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
77
|
+
def get_jwk(name, fields: nil, quota_user: nil, options: nil, &block)
|
78
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
79
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PublicJwkSet::Representation
|
80
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PublicJwkSet
|
81
|
+
command.params['name'] = name unless name.nil?
|
82
|
+
command.query['fields'] = fields unless fields.nil?
|
83
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
84
|
+
execute_or_queue_command(command, &block)
|
85
|
+
end
|
86
|
+
|
87
|
+
# Accepts an App Attest assertion and an artifact previously obtained from
|
88
|
+
# ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns
|
89
|
+
# an AppCheckToken.
|
90
|
+
# @param [String] app
|
91
|
+
# Required. The relative resource name of the iOS app, in the format: ```
|
92
|
+
# projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
|
93
|
+
# element can be replaced with the project ID of the Firebase project. Learn
|
94
|
+
# more about using project identifiers in Google's [AIP 2510](https://google.aip.
|
95
|
+
# dev/cloud/2510) standard.
|
96
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAssertionRequest] google_firebase_appcheck_v1_exchange_app_attest_assertion_request_object
|
97
|
+
# @param [String] fields
|
98
|
+
# Selector specifying which fields to include in a partial response.
|
99
|
+
# @param [String] quota_user
|
100
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
101
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
102
|
+
# @param [Google::Apis::RequestOptions] options
|
103
|
+
# Request-specific options
|
104
|
+
#
|
105
|
+
# @yield [result, err] Result & error if block supplied
|
106
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken] parsed result object
|
107
|
+
# @yieldparam err [StandardError] error object if request failed
|
108
|
+
#
|
109
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken]
|
110
|
+
#
|
111
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
112
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
113
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
114
|
+
def exchange_project_app_app_attest_assertion(app, google_firebase_appcheck_v1_exchange_app_attest_assertion_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
115
|
+
command = make_simple_command(:post, 'v1/{+app}:exchangeAppAttestAssertion', options)
|
116
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAssertionRequest::Representation
|
117
|
+
command.request_object = google_firebase_appcheck_v1_exchange_app_attest_assertion_request_object
|
118
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
|
119
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
|
120
|
+
command.params['app'] = app unless app.nil?
|
121
|
+
command.query['fields'] = fields unless fields.nil?
|
122
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
123
|
+
execute_or_queue_command(command, &block)
|
124
|
+
end
|
125
|
+
|
126
|
+
# Accepts an App Attest CBOR attestation and verifies it with Apple using your
|
127
|
+
# preconfigured team and bundle IDs. If valid, returns an attestation artifact
|
128
|
+
# that can later be exchanged for an AppCheckToken using
|
129
|
+
# ExchangeAppAttestAssertion. For convenience and performance, this method's
|
130
|
+
# response object will also contain an AppCheckToken (if the verification is
|
131
|
+
# successful).
|
132
|
+
# @param [String] app
|
133
|
+
# Required. The relative resource name of the iOS app, in the format: ```
|
134
|
+
# projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
|
135
|
+
# element can be replaced with the project ID of the Firebase project. Learn
|
136
|
+
# more about using project identifiers in Google's [AIP 2510](https://google.aip.
|
137
|
+
# dev/cloud/2510) standard.
|
138
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationRequest] google_firebase_appcheck_v1_exchange_app_attest_attestation_request_object
|
139
|
+
# @param [String] fields
|
140
|
+
# Selector specifying which fields to include in a partial response.
|
141
|
+
# @param [String] quota_user
|
142
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
143
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
144
|
+
# @param [Google::Apis::RequestOptions] options
|
145
|
+
# Request-specific options
|
146
|
+
#
|
147
|
+
# @yield [result, err] Result & error if block supplied
|
148
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse] parsed result object
|
149
|
+
# @yieldparam err [StandardError] error object if request failed
|
150
|
+
#
|
151
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse]
|
152
|
+
#
|
153
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
154
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
155
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
156
|
+
def exchange_project_app_app_attest_attestation(app, google_firebase_appcheck_v1_exchange_app_attest_attestation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
157
|
+
command = make_simple_command(:post, 'v1/{+app}:exchangeAppAttestAttestation', options)
|
158
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationRequest::Representation
|
159
|
+
command.request_object = google_firebase_appcheck_v1_exchange_app_attest_attestation_request_object
|
160
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse::Representation
|
161
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse
|
162
|
+
command.params['app'] = app unless app.nil?
|
163
|
+
command.query['fields'] = fields unless fields.nil?
|
164
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
165
|
+
execute_or_queue_command(command, &block)
|
166
|
+
end
|
167
|
+
|
168
|
+
# Validates a custom token signed using your project's Admin SDK service account
|
169
|
+
# credentials. If valid, returns an AppCheckToken.
|
170
|
+
# @param [String] app
|
171
|
+
# Required. The relative resource name of the app, in the format: ``` projects/`
|
172
|
+
# project_number`/apps/`app_id` ``` If necessary, the `project_number` element
|
173
|
+
# can be replaced with the project ID of the Firebase project. Learn more about
|
174
|
+
# using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/
|
175
|
+
# 2510) standard.
|
176
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeCustomTokenRequest] google_firebase_appcheck_v1_exchange_custom_token_request_object
|
177
|
+
# @param [String] fields
|
178
|
+
# Selector specifying which fields to include in a partial response.
|
179
|
+
# @param [String] quota_user
|
180
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
181
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
182
|
+
# @param [Google::Apis::RequestOptions] options
|
183
|
+
# Request-specific options
|
184
|
+
#
|
185
|
+
# @yield [result, err] Result & error if block supplied
|
186
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken] parsed result object
|
187
|
+
# @yieldparam err [StandardError] error object if request failed
|
188
|
+
#
|
189
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken]
|
190
|
+
#
|
191
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
192
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
193
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
194
|
+
def exchange_project_app_custom_token(app, google_firebase_appcheck_v1_exchange_custom_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
195
|
+
command = make_simple_command(:post, 'v1/{+app}:exchangeCustomToken', options)
|
196
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeCustomTokenRequest::Representation
|
197
|
+
command.request_object = google_firebase_appcheck_v1_exchange_custom_token_request_object
|
198
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
|
199
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
|
200
|
+
command.params['app'] = app unless app.nil?
|
201
|
+
command.query['fields'] = fields unless fields.nil?
|
202
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
203
|
+
execute_or_queue_command(command, &block)
|
204
|
+
end
|
205
|
+
|
206
|
+
# Validates a debug token secret that you have previously created using
|
207
|
+
# CreateDebugToken. If valid, returns an AppCheckToken. Note that a restrictive
|
208
|
+
# quota is enforced on this method to prevent accidental exposure of the app to
|
209
|
+
# abuse.
|
210
|
+
# @param [String] app
|
211
|
+
# Required. The relative resource name of the app, in the format: ``` projects/`
|
212
|
+
# project_number`/apps/`app_id` ``` If necessary, the `project_number` element
|
213
|
+
# can be replaced with the project ID of the Firebase project. Learn more about
|
214
|
+
# using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/
|
215
|
+
# 2510) standard.
|
216
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest] google_firebase_appcheck_v1_exchange_debug_token_request_object
|
217
|
+
# @param [String] fields
|
218
|
+
# Selector specifying which fields to include in a partial response.
|
219
|
+
# @param [String] quota_user
|
220
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
221
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
222
|
+
# @param [Google::Apis::RequestOptions] options
|
223
|
+
# Request-specific options
|
224
|
+
#
|
225
|
+
# @yield [result, err] Result & error if block supplied
|
226
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken] parsed result object
|
227
|
+
# @yieldparam err [StandardError] error object if request failed
|
228
|
+
#
|
229
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken]
|
230
|
+
#
|
231
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
232
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
233
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
234
|
+
def exchange_project_app_debug_token(app, google_firebase_appcheck_v1_exchange_debug_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
235
|
+
command = make_simple_command(:post, 'v1/{+app}:exchangeDebugToken', options)
|
236
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest::Representation
|
237
|
+
command.request_object = google_firebase_appcheck_v1_exchange_debug_token_request_object
|
238
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
|
239
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
|
240
|
+
command.params['app'] = app unless app.nil?
|
241
|
+
command.query['fields'] = fields unless fields.nil?
|
242
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
243
|
+
execute_or_queue_command(command, &block)
|
244
|
+
end
|
245
|
+
|
246
|
+
# Accepts a [`device_token`](https://developer.apple.com/documentation/
|
247
|
+
# devicecheck/dcdevice) issued by DeviceCheck, and attempts to validate it with
|
248
|
+
# Apple. If valid, returns an AppCheckToken.
|
249
|
+
# @param [String] app
|
250
|
+
# Required. The relative resource name of the iOS app, in the format: ```
|
251
|
+
# projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
|
252
|
+
# element can be replaced with the project ID of the Firebase project. Learn
|
253
|
+
# more about using project identifiers in Google's [AIP 2510](https://google.aip.
|
254
|
+
# dev/cloud/2510) standard.
|
255
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeDeviceCheckTokenRequest] google_firebase_appcheck_v1_exchange_device_check_token_request_object
|
256
|
+
# @param [String] fields
|
257
|
+
# Selector specifying which fields to include in a partial response.
|
258
|
+
# @param [String] quota_user
|
259
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
260
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
261
|
+
# @param [Google::Apis::RequestOptions] options
|
262
|
+
# Request-specific options
|
263
|
+
#
|
264
|
+
# @yield [result, err] Result & error if block supplied
|
265
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken] parsed result object
|
266
|
+
# @yieldparam err [StandardError] error object if request failed
|
267
|
+
#
|
268
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken]
|
269
|
+
#
|
270
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
271
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
272
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
273
|
+
def exchange_project_app_device_check_token(app, google_firebase_appcheck_v1_exchange_device_check_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
274
|
+
command = make_simple_command(:post, 'v1/{+app}:exchangeDeviceCheckToken', options)
|
275
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeDeviceCheckTokenRequest::Representation
|
276
|
+
command.request_object = google_firebase_appcheck_v1_exchange_device_check_token_request_object
|
277
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
|
278
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
|
279
|
+
command.params['app'] = app unless app.nil?
|
280
|
+
command.query['fields'] = fields unless fields.nil?
|
281
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
282
|
+
execute_or_queue_command(command, &block)
|
283
|
+
end
|
284
|
+
|
285
|
+
# Validates an [integrity verdict response token from Play Integrity](https://
|
286
|
+
# developer.android.com/google/play/integrity/verdict#decrypt-verify). If valid,
|
287
|
+
# returns an AppCheckToken.
|
288
|
+
# @param [String] app
|
289
|
+
# Required. The relative resource name of the Android app, in the format: ```
|
290
|
+
# projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
|
291
|
+
# element can be replaced with the project ID of the Firebase project. Learn
|
292
|
+
# more about using project identifiers in Google's [AIP 2510](https://google.aip.
|
293
|
+
# dev/cloud/2510) standard.
|
294
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangePlayIntegrityTokenRequest] google_firebase_appcheck_v1_exchange_play_integrity_token_request_object
|
295
|
+
# @param [String] fields
|
296
|
+
# Selector specifying which fields to include in a partial response.
|
297
|
+
# @param [String] quota_user
|
298
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
299
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
300
|
+
# @param [Google::Apis::RequestOptions] options
|
301
|
+
# Request-specific options
|
302
|
+
#
|
303
|
+
# @yield [result, err] Result & error if block supplied
|
304
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken] parsed result object
|
305
|
+
# @yieldparam err [StandardError] error object if request failed
|
306
|
+
#
|
307
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken]
|
308
|
+
#
|
309
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
310
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
311
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
312
|
+
def exchange_project_app_play_integrity_token(app, google_firebase_appcheck_v1_exchange_play_integrity_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
313
|
+
command = make_simple_command(:post, 'v1/{+app}:exchangePlayIntegrityToken', options)
|
314
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangePlayIntegrityTokenRequest::Representation
|
315
|
+
command.request_object = google_firebase_appcheck_v1_exchange_play_integrity_token_request_object
|
316
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
|
317
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
|
318
|
+
command.params['app'] = app unless app.nil?
|
319
|
+
command.query['fields'] = fields unless fields.nil?
|
320
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
321
|
+
execute_or_queue_command(command, &block)
|
322
|
+
end
|
323
|
+
|
324
|
+
# Validates a [reCAPTCHA Enterprise response token](https://cloud.google.com/
|
325
|
+
# recaptcha-enterprise/docs/create-assessment#retrieve_token). If valid, returns
|
326
|
+
# an AppCheckToken.
|
327
|
+
# @param [String] app
|
328
|
+
# Required. The relative resource name of the web app, in the format: ```
|
329
|
+
# projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
|
330
|
+
# element can be replaced with the project ID of the Firebase project. Learn
|
331
|
+
# more about using project identifiers in Google's [AIP 2510](https://google.aip.
|
332
|
+
# dev/cloud/2510) standard.
|
333
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeRecaptchaEnterpriseTokenRequest] google_firebase_appcheck_v1_exchange_recaptcha_enterprise_token_request_object
|
334
|
+
# @param [String] fields
|
335
|
+
# Selector specifying which fields to include in a partial response.
|
336
|
+
# @param [String] quota_user
|
337
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
338
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
339
|
+
# @param [Google::Apis::RequestOptions] options
|
340
|
+
# Request-specific options
|
341
|
+
#
|
342
|
+
# @yield [result, err] Result & error if block supplied
|
343
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken] parsed result object
|
344
|
+
# @yieldparam err [StandardError] error object if request failed
|
345
|
+
#
|
346
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken]
|
347
|
+
#
|
348
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
349
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
350
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
351
|
+
def exchange_project_app_recaptcha_enterprise_token(app, google_firebase_appcheck_v1_exchange_recaptcha_enterprise_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
352
|
+
command = make_simple_command(:post, 'v1/{+app}:exchangeRecaptchaEnterpriseToken', options)
|
353
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeRecaptchaEnterpriseTokenRequest::Representation
|
354
|
+
command.request_object = google_firebase_appcheck_v1_exchange_recaptcha_enterprise_token_request_object
|
355
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
|
356
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
|
357
|
+
command.params['app'] = app unless app.nil?
|
358
|
+
command.query['fields'] = fields unless fields.nil?
|
359
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
360
|
+
execute_or_queue_command(command, &block)
|
361
|
+
end
|
362
|
+
|
363
|
+
# Validates a [reCAPTCHA v3 response token](https://developers.google.com/
|
364
|
+
# recaptcha/docs/v3). If valid, returns an AppCheckToken.
|
365
|
+
# @param [String] app
|
366
|
+
# Required. The relative resource name of the web app, in the format: ```
|
367
|
+
# projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
|
368
|
+
# element can be replaced with the project ID of the Firebase project. Learn
|
369
|
+
# more about using project identifiers in Google's [AIP 2510](https://google.aip.
|
370
|
+
# dev/cloud/2510) standard.
|
371
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeRecaptchaV3TokenRequest] google_firebase_appcheck_v1_exchange_recaptcha_v3_token_request_object
|
372
|
+
# @param [String] fields
|
373
|
+
# Selector specifying which fields to include in a partial response.
|
374
|
+
# @param [String] quota_user
|
375
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
376
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
377
|
+
# @param [Google::Apis::RequestOptions] options
|
378
|
+
# Request-specific options
|
379
|
+
#
|
380
|
+
# @yield [result, err] Result & error if block supplied
|
381
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken] parsed result object
|
382
|
+
# @yieldparam err [StandardError] error object if request failed
|
383
|
+
#
|
384
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken]
|
385
|
+
#
|
386
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
387
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
388
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
389
|
+
def exchange_project_app_recaptcha_v3_token(app, google_firebase_appcheck_v1_exchange_recaptcha_v3_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
390
|
+
command = make_simple_command(:post, 'v1/{+app}:exchangeRecaptchaV3Token', options)
|
391
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeRecaptchaV3TokenRequest::Representation
|
392
|
+
command.request_object = google_firebase_appcheck_v1_exchange_recaptcha_v3_token_request_object
|
393
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
|
394
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
|
395
|
+
command.params['app'] = app unless app.nil?
|
396
|
+
command.query['fields'] = fields unless fields.nil?
|
397
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
398
|
+
execute_or_queue_command(command, &block)
|
399
|
+
end
|
400
|
+
|
401
|
+
# Validates a [SafetyNet token](https://developer.android.com/training/safetynet/
|
402
|
+
# attestation#request-attestation-step). If valid, returns an AppCheckToken.
|
403
|
+
# @param [String] app
|
404
|
+
# Required. The relative resource name of the Android app, in the format: ```
|
405
|
+
# projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
|
406
|
+
# element can be replaced with the project ID of the Firebase project. Learn
|
407
|
+
# more about using project identifiers in Google's [AIP 2510](https://google.aip.
|
408
|
+
# dev/cloud/2510) standard.
|
409
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeSafetyNetTokenRequest] google_firebase_appcheck_v1_exchange_safety_net_token_request_object
|
410
|
+
# @param [String] fields
|
411
|
+
# Selector specifying which fields to include in a partial response.
|
412
|
+
# @param [String] quota_user
|
413
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
414
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
415
|
+
# @param [Google::Apis::RequestOptions] options
|
416
|
+
# Request-specific options
|
417
|
+
#
|
418
|
+
# @yield [result, err] Result & error if block supplied
|
419
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken] parsed result object
|
420
|
+
# @yieldparam err [StandardError] error object if request failed
|
421
|
+
#
|
422
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken]
|
423
|
+
#
|
424
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
425
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
426
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
427
|
+
def exchange_project_app_safety_net_token(app, google_firebase_appcheck_v1_exchange_safety_net_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
428
|
+
command = make_simple_command(:post, 'v1/{+app}:exchangeSafetyNetToken', options)
|
429
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ExchangeSafetyNetTokenRequest::Representation
|
430
|
+
command.request_object = google_firebase_appcheck_v1_exchange_safety_net_token_request_object
|
431
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken::Representation
|
432
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppCheckToken
|
433
|
+
command.params['app'] = app unless app.nil?
|
434
|
+
command.query['fields'] = fields unless fields.nil?
|
435
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
436
|
+
execute_or_queue_command(command, &block)
|
437
|
+
end
|
438
|
+
|
439
|
+
# Generates a challenge that protects the integrity of an immediately following
|
440
|
+
# call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A
|
441
|
+
# challenge should not be reused for multiple calls.
|
442
|
+
# @param [String] app
|
443
|
+
# Required. The relative resource name of the iOS app, in the format: ```
|
444
|
+
# projects/`project_number`/apps/`app_id` ``` If necessary, the `project_number`
|
445
|
+
# element can be replaced with the project ID of the Firebase project. Learn
|
446
|
+
# more about using project identifiers in Google's [AIP 2510](https://google.aip.
|
447
|
+
# dev/cloud/2510) standard.
|
448
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest] google_firebase_appcheck_v1_generate_app_attest_challenge_request_object
|
449
|
+
# @param [String] fields
|
450
|
+
# Selector specifying which fields to include in a partial response.
|
451
|
+
# @param [String] quota_user
|
452
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
453
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
454
|
+
# @param [Google::Apis::RequestOptions] options
|
455
|
+
# Request-specific options
|
456
|
+
#
|
457
|
+
# @yield [result, err] Result & error if block supplied
|
458
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse] parsed result object
|
459
|
+
# @yieldparam err [StandardError] error object if request failed
|
460
|
+
#
|
461
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse]
|
462
|
+
#
|
463
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
464
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
465
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
466
|
+
def generate_project_app_app_attest_challenge(app, google_firebase_appcheck_v1_generate_app_attest_challenge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
467
|
+
command = make_simple_command(:post, 'v1/{+app}:generateAppAttestChallenge', options)
|
468
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest::Representation
|
469
|
+
command.request_object = google_firebase_appcheck_v1_generate_app_attest_challenge_request_object
|
470
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse::Representation
|
471
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse
|
472
|
+
command.params['app'] = app unless app.nil?
|
473
|
+
command.query['fields'] = fields unless fields.nil?
|
474
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
475
|
+
execute_or_queue_command(command, &block)
|
476
|
+
end
|
477
|
+
|
478
|
+
# Generates a challenge that protects the integrity of an immediately following
|
479
|
+
# integrity verdict request to the Play Integrity API. The next call to
|
480
|
+
# ExchangePlayIntegrityToken using the resulting integrity token will verify the
|
481
|
+
# presence and validity of the challenge. A challenge should not be reused for
|
482
|
+
# multiple calls.
|
483
|
+
# @param [String] app
|
484
|
+
# Required. The relative resource name of the app, in the format: ``` projects/`
|
485
|
+
# project_number`/apps/`app_id` ``` If necessary, the `project_number` element
|
486
|
+
# can be replaced with the project ID of the Firebase project. Learn more about
|
487
|
+
# using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/
|
488
|
+
# 2510) standard.
|
489
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeRequest] google_firebase_appcheck_v1_generate_play_integrity_challenge_request_object
|
490
|
+
# @param [String] fields
|
491
|
+
# Selector specifying which fields to include in a partial response.
|
492
|
+
# @param [String] quota_user
|
493
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
494
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
495
|
+
# @param [Google::Apis::RequestOptions] options
|
496
|
+
# Request-specific options
|
497
|
+
#
|
498
|
+
# @yield [result, err] Result & error if block supplied
|
499
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeResponse] parsed result object
|
500
|
+
# @yieldparam err [StandardError] error object if request failed
|
501
|
+
#
|
502
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeResponse]
|
503
|
+
#
|
504
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
505
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
506
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
507
|
+
def generate_project_app_play_integrity_challenge(app, google_firebase_appcheck_v1_generate_play_integrity_challenge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
508
|
+
command = make_simple_command(:post, 'v1/{+app}:generatePlayIntegrityChallenge', options)
|
509
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeRequest::Representation
|
510
|
+
command.request_object = google_firebase_appcheck_v1_generate_play_integrity_challenge_request_object
|
511
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeResponse::Representation
|
512
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeResponse
|
513
|
+
command.params['app'] = app unless app.nil?
|
514
|
+
command.query['fields'] = fields unless fields.nil?
|
515
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
516
|
+
execute_or_queue_command(command, &block)
|
517
|
+
end
|
518
|
+
|
519
|
+
# Atomically gets the AppAttestConfigs for the specified list of apps.
|
520
|
+
# @param [String] parent
|
521
|
+
# Required. The parent project name shared by all AppAttestConfigs being
|
522
|
+
# retrieved, in the format ``` projects/`project_number` ``` The parent
|
523
|
+
# collection in the `name` field of any resource being retrieved must match this
|
524
|
+
# field, or the entire batch fails.
|
525
|
+
# @param [Array<String>, String] names
|
526
|
+
# Required. The relative resource names of the AppAttestConfigs to retrieve, in
|
527
|
+
# the format ``` projects/`project_number`/apps/`app_id`/appAttestConfig ``` A
|
528
|
+
# maximum of 100 objects can be retrieved in a batch.
|
529
|
+
# @param [String] fields
|
530
|
+
# Selector specifying which fields to include in a partial response.
|
531
|
+
# @param [String] quota_user
|
532
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
533
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
534
|
+
# @param [Google::Apis::RequestOptions] options
|
535
|
+
# Request-specific options
|
536
|
+
#
|
537
|
+
# @yield [result, err] Result & error if block supplied
|
538
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetAppAttestConfigsResponse] parsed result object
|
539
|
+
# @yieldparam err [StandardError] error object if request failed
|
540
|
+
#
|
541
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetAppAttestConfigsResponse]
|
542
|
+
#
|
543
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
544
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
545
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
546
|
+
def batch_project_app_app_attest_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
|
547
|
+
command = make_simple_command(:get, 'v1/{+parent}/apps/-/appAttestConfig:batchGet', options)
|
548
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetAppAttestConfigsResponse::Representation
|
549
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetAppAttestConfigsResponse
|
550
|
+
command.params['parent'] = parent unless parent.nil?
|
551
|
+
command.query['names'] = names unless names.nil?
|
552
|
+
command.query['fields'] = fields unless fields.nil?
|
553
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
554
|
+
execute_or_queue_command(command, &block)
|
555
|
+
end
|
556
|
+
|
557
|
+
# Gets the AppAttestConfig for the specified app.
|
558
|
+
# @param [String] name
|
559
|
+
# Required. The relative resource name of the AppAttestConfig, in the format: ```
|
560
|
+
# projects/`project_number`/apps/`app_id`/appAttestConfig ```
|
561
|
+
# @param [String] fields
|
562
|
+
# Selector specifying which fields to include in a partial response.
|
563
|
+
# @param [String] quota_user
|
564
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
565
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
566
|
+
# @param [Google::Apis::RequestOptions] options
|
567
|
+
# Request-specific options
|
568
|
+
#
|
569
|
+
# @yield [result, err] Result & error if block supplied
|
570
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig] parsed result object
|
571
|
+
# @yieldparam err [StandardError] error object if request failed
|
572
|
+
#
|
573
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig]
|
574
|
+
#
|
575
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
576
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
577
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
578
|
+
def get_project_app_app_attest_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
579
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
580
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig::Representation
|
581
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig
|
582
|
+
command.params['name'] = name unless name.nil?
|
583
|
+
command.query['fields'] = fields unless fields.nil?
|
584
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
585
|
+
execute_or_queue_command(command, &block)
|
586
|
+
end
|
587
|
+
|
588
|
+
# Updates the AppAttestConfig for the specified app. While this configuration is
|
589
|
+
# incomplete or invalid, the app will be unable to exchange AppAttest tokens for
|
590
|
+
# App Check tokens.
|
591
|
+
# @param [String] name
|
592
|
+
# Required. The relative resource name of the App Attest configuration object,
|
593
|
+
# in the format: ``` projects/`project_number`/apps/`app_id`/appAttestConfig ```
|
594
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig] google_firebase_appcheck_v1_app_attest_config_object
|
595
|
+
# @param [String] update_mask
|
596
|
+
# Required. A comma-separated list of names of fields in the AppAttestConfig
|
597
|
+
# Gets to update. Example: `token_ttl`.
|
598
|
+
# @param [String] fields
|
599
|
+
# Selector specifying which fields to include in a partial response.
|
600
|
+
# @param [String] quota_user
|
601
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
602
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
603
|
+
# @param [Google::Apis::RequestOptions] options
|
604
|
+
# Request-specific options
|
605
|
+
#
|
606
|
+
# @yield [result, err] Result & error if block supplied
|
607
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig] parsed result object
|
608
|
+
# @yieldparam err [StandardError] error object if request failed
|
609
|
+
#
|
610
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig]
|
611
|
+
#
|
612
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
613
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
614
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
615
|
+
def patch_project_app_app_attest_config(name, google_firebase_appcheck_v1_app_attest_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
616
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
617
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig::Representation
|
618
|
+
command.request_object = google_firebase_appcheck_v1_app_attest_config_object
|
619
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig::Representation
|
620
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1AppAttestConfig
|
621
|
+
command.params['name'] = name unless name.nil?
|
622
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
623
|
+
command.query['fields'] = fields unless fields.nil?
|
624
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
625
|
+
execute_or_queue_command(command, &block)
|
626
|
+
end
|
627
|
+
|
628
|
+
# Creates a new DebugToken for the specified app. For security reasons, after
|
629
|
+
# the creation operation completes, the `token` field cannot be updated or
|
630
|
+
# retrieved, but you can revoke the debug token using DeleteDebugToken. Each app
|
631
|
+
# can have a maximum of 20 debug tokens.
|
632
|
+
# @param [String] parent
|
633
|
+
# Required. The relative resource name of the parent app in which the specified
|
634
|
+
# DebugToken will be created, in the format: ``` projects/`project_number`/apps/`
|
635
|
+
# app_id` ```
|
636
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken] google_firebase_appcheck_v1_debug_token_object
|
637
|
+
# @param [String] fields
|
638
|
+
# Selector specifying which fields to include in a partial response.
|
639
|
+
# @param [String] quota_user
|
640
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
641
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
642
|
+
# @param [Google::Apis::RequestOptions] options
|
643
|
+
# Request-specific options
|
644
|
+
#
|
645
|
+
# @yield [result, err] Result & error if block supplied
|
646
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken] parsed result object
|
647
|
+
# @yieldparam err [StandardError] error object if request failed
|
648
|
+
#
|
649
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken]
|
650
|
+
#
|
651
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
652
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
653
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
654
|
+
def create_project_app_debug_token(parent, google_firebase_appcheck_v1_debug_token_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
655
|
+
command = make_simple_command(:post, 'v1/{+parent}/debugTokens', options)
|
656
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken::Representation
|
657
|
+
command.request_object = google_firebase_appcheck_v1_debug_token_object
|
658
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken::Representation
|
659
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken
|
660
|
+
command.params['parent'] = parent unless parent.nil?
|
661
|
+
command.query['fields'] = fields unless fields.nil?
|
662
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
663
|
+
execute_or_queue_command(command, &block)
|
664
|
+
end
|
665
|
+
|
666
|
+
# Deletes the specified DebugToken. A deleted debug token cannot be used to
|
667
|
+
# exchange for an App Check token. Use this method when you suspect the secret `
|
668
|
+
# token` has been compromised or when you no longer need the debug token.
|
669
|
+
# @param [String] name
|
670
|
+
# Required. The relative resource name of the DebugToken to delete, in the
|
671
|
+
# format: ``` projects/`project_number`/apps/`app_id`/debugTokens/`
|
672
|
+
# debug_token_id` ```
|
673
|
+
# @param [String] fields
|
674
|
+
# Selector specifying which fields to include in a partial response.
|
675
|
+
# @param [String] quota_user
|
676
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
677
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
678
|
+
# @param [Google::Apis::RequestOptions] options
|
679
|
+
# Request-specific options
|
680
|
+
#
|
681
|
+
# @yield [result, err] Result & error if block supplied
|
682
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty] parsed result object
|
683
|
+
# @yieldparam err [StandardError] error object if request failed
|
684
|
+
#
|
685
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty]
|
686
|
+
#
|
687
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
688
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
689
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
690
|
+
def delete_project_app_debug_token(name, fields: nil, quota_user: nil, options: nil, &block)
|
691
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
692
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty::Representation
|
693
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleProtobufEmpty
|
694
|
+
command.params['name'] = name unless name.nil?
|
695
|
+
command.query['fields'] = fields unless fields.nil?
|
696
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
697
|
+
execute_or_queue_command(command, &block)
|
698
|
+
end
|
699
|
+
|
700
|
+
# Gets the specified DebugToken. For security reasons, the `token` field is
|
701
|
+
# never populated in the response.
|
702
|
+
# @param [String] name
|
703
|
+
# Required. The relative resource name of the debug token, in the format: ```
|
704
|
+
# projects/`project_number`/apps/`app_id`/debugTokens/`debug_token_id` ```
|
705
|
+
# @param [String] fields
|
706
|
+
# Selector specifying which fields to include in a partial response.
|
707
|
+
# @param [String] quota_user
|
708
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
709
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
710
|
+
# @param [Google::Apis::RequestOptions] options
|
711
|
+
# Request-specific options
|
712
|
+
#
|
713
|
+
# @yield [result, err] Result & error if block supplied
|
714
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken] parsed result object
|
715
|
+
# @yieldparam err [StandardError] error object if request failed
|
716
|
+
#
|
717
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken]
|
718
|
+
#
|
719
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
720
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
721
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
722
|
+
def get_project_app_debug_token(name, fields: nil, quota_user: nil, options: nil, &block)
|
723
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
724
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken::Representation
|
725
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken
|
726
|
+
command.params['name'] = name unless name.nil?
|
727
|
+
command.query['fields'] = fields unless fields.nil?
|
728
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
729
|
+
execute_or_queue_command(command, &block)
|
730
|
+
end
|
731
|
+
|
732
|
+
# Lists all DebugTokens for the specified app. For security reasons, the `token`
|
733
|
+
# field is never populated in the response.
|
734
|
+
# @param [String] parent
|
735
|
+
# Required. The relative resource name of the parent app for which to list each
|
736
|
+
# associated DebugToken, in the format: ``` projects/`project_number`/apps/`
|
737
|
+
# app_id` ```
|
738
|
+
# @param [Fixnum] page_size
|
739
|
+
# The maximum number of DebugTokens to return in the response. Note that an app
|
740
|
+
# can have at most 20 debug tokens. The server may return fewer than this at its
|
741
|
+
# own discretion. If no value is specified (or too large a value is specified),
|
742
|
+
# the server will impose its own limit.
|
743
|
+
# @param [String] page_token
|
744
|
+
# Token returned from a previous call to ListDebugTokens indicating where in the
|
745
|
+
# set of DebugTokens to resume listing. Provide this to retrieve the subsequent
|
746
|
+
# page. When paginating, all other parameters provided to ListDebugTokens must
|
747
|
+
# match the call that provided the page token; if they do not match, the result
|
748
|
+
# is undefined.
|
749
|
+
# @param [String] fields
|
750
|
+
# Selector specifying which fields to include in a partial response.
|
751
|
+
# @param [String] quota_user
|
752
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
753
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
754
|
+
# @param [Google::Apis::RequestOptions] options
|
755
|
+
# Request-specific options
|
756
|
+
#
|
757
|
+
# @yield [result, err] Result & error if block supplied
|
758
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListDebugTokensResponse] parsed result object
|
759
|
+
# @yieldparam err [StandardError] error object if request failed
|
760
|
+
#
|
761
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListDebugTokensResponse]
|
762
|
+
#
|
763
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
764
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
765
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
766
|
+
def list_project_app_debug_tokens(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
767
|
+
command = make_simple_command(:get, 'v1/{+parent}/debugTokens', options)
|
768
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListDebugTokensResponse::Representation
|
769
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListDebugTokensResponse
|
770
|
+
command.params['parent'] = parent unless parent.nil?
|
771
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
772
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
773
|
+
command.query['fields'] = fields unless fields.nil?
|
774
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
775
|
+
execute_or_queue_command(command, &block)
|
776
|
+
end
|
777
|
+
|
778
|
+
# Updates the specified DebugToken. For security reasons, the `token` field
|
779
|
+
# cannot be updated, nor will it be populated in the response, but you can
|
780
|
+
# revoke the debug token using DeleteDebugToken.
|
781
|
+
# @param [String] name
|
782
|
+
# Required. The relative resource name of the debug token, in the format: ```
|
783
|
+
# projects/`project_number`/apps/`app_id`/debugTokens/`debug_token_id` ```
|
784
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken] google_firebase_appcheck_v1_debug_token_object
|
785
|
+
# @param [String] update_mask
|
786
|
+
# Required. A comma-separated list of names of fields in the DebugToken to
|
787
|
+
# update. Example: `display_name`.
|
788
|
+
# @param [String] fields
|
789
|
+
# Selector specifying which fields to include in a partial response.
|
790
|
+
# @param [String] quota_user
|
791
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
792
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
793
|
+
# @param [Google::Apis::RequestOptions] options
|
794
|
+
# Request-specific options
|
795
|
+
#
|
796
|
+
# @yield [result, err] Result & error if block supplied
|
797
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken] parsed result object
|
798
|
+
# @yieldparam err [StandardError] error object if request failed
|
799
|
+
#
|
800
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken]
|
801
|
+
#
|
802
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
803
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
804
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
805
|
+
def patch_project_app_debug_token(name, google_firebase_appcheck_v1_debug_token_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
806
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
807
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken::Representation
|
808
|
+
command.request_object = google_firebase_appcheck_v1_debug_token_object
|
809
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken::Representation
|
810
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DebugToken
|
811
|
+
command.params['name'] = name unless name.nil?
|
812
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
813
|
+
command.query['fields'] = fields unless fields.nil?
|
814
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
815
|
+
execute_or_queue_command(command, &block)
|
816
|
+
end
|
817
|
+
|
818
|
+
# Atomically gets the DeviceCheckConfigs for the specified list of apps. For
|
819
|
+
# security reasons, the `private_key` field is never populated in the response.
|
820
|
+
# @param [String] parent
|
821
|
+
# Required. The parent project name shared by all DeviceCheckConfigs being
|
822
|
+
# retrieved, in the format ``` projects/`project_number` ``` The parent
|
823
|
+
# collection in the `name` field of any resource being retrieved must match this
|
824
|
+
# field, or the entire batch fails.
|
825
|
+
# @param [Array<String>, String] names
|
826
|
+
# Required. The relative resource names of the DeviceCheckConfigs to retrieve,
|
827
|
+
# in the format ``` projects/`project_number`/apps/`app_id`/deviceCheckConfig ```
|
828
|
+
# A maximum of 100 objects can be retrieved in a batch.
|
829
|
+
# @param [String] fields
|
830
|
+
# Selector specifying which fields to include in a partial response.
|
831
|
+
# @param [String] quota_user
|
832
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
833
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
834
|
+
# @param [Google::Apis::RequestOptions] options
|
835
|
+
# Request-specific options
|
836
|
+
#
|
837
|
+
# @yield [result, err] Result & error if block supplied
|
838
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetDeviceCheckConfigsResponse] parsed result object
|
839
|
+
# @yieldparam err [StandardError] error object if request failed
|
840
|
+
#
|
841
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetDeviceCheckConfigsResponse]
|
842
|
+
#
|
843
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
844
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
845
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
846
|
+
def batch_project_app_device_check_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
|
847
|
+
command = make_simple_command(:get, 'v1/{+parent}/apps/-/deviceCheckConfig:batchGet', options)
|
848
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetDeviceCheckConfigsResponse::Representation
|
849
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetDeviceCheckConfigsResponse
|
850
|
+
command.params['parent'] = parent unless parent.nil?
|
851
|
+
command.query['names'] = names unless names.nil?
|
852
|
+
command.query['fields'] = fields unless fields.nil?
|
853
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
854
|
+
execute_or_queue_command(command, &block)
|
855
|
+
end
|
856
|
+
|
857
|
+
# Gets the DeviceCheckConfig for the specified app. For security reasons, the `
|
858
|
+
# private_key` field is never populated in the response.
|
859
|
+
# @param [String] name
|
860
|
+
# Required. The relative resource name of the DeviceCheckConfig, in the format: `
|
861
|
+
# `` projects/`project_number`/apps/`app_id`/deviceCheckConfig ```
|
862
|
+
# @param [String] fields
|
863
|
+
# Selector specifying which fields to include in a partial response.
|
864
|
+
# @param [String] quota_user
|
865
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
866
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
867
|
+
# @param [Google::Apis::RequestOptions] options
|
868
|
+
# Request-specific options
|
869
|
+
#
|
870
|
+
# @yield [result, err] Result & error if block supplied
|
871
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig] parsed result object
|
872
|
+
# @yieldparam err [StandardError] error object if request failed
|
873
|
+
#
|
874
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig]
|
875
|
+
#
|
876
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
877
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
878
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
879
|
+
def get_project_app_device_check_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
880
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
881
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig::Representation
|
882
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig
|
883
|
+
command.params['name'] = name unless name.nil?
|
884
|
+
command.query['fields'] = fields unless fields.nil?
|
885
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
886
|
+
execute_or_queue_command(command, &block)
|
887
|
+
end
|
888
|
+
|
889
|
+
# Updates the DeviceCheckConfig for the specified app. While this configuration
|
890
|
+
# is incomplete or invalid, the app will be unable to exchange DeviceCheck
|
891
|
+
# tokens for App Check tokens. For security reasons, the `private_key` field is
|
892
|
+
# never populated in the response.
|
893
|
+
# @param [String] name
|
894
|
+
# Required. The relative resource name of the DeviceCheck configuration object,
|
895
|
+
# in the format: ``` projects/`project_number`/apps/`app_id`/deviceCheckConfig ``
|
896
|
+
# `
|
897
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig] google_firebase_appcheck_v1_device_check_config_object
|
898
|
+
# @param [String] update_mask
|
899
|
+
# Required. A comma-separated list of names of fields in the DeviceCheckConfig
|
900
|
+
# Gets to update. Example: `key_id,private_key`.
|
901
|
+
# @param [String] fields
|
902
|
+
# Selector specifying which fields to include in a partial response.
|
903
|
+
# @param [String] quota_user
|
904
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
905
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
906
|
+
# @param [Google::Apis::RequestOptions] options
|
907
|
+
# Request-specific options
|
908
|
+
#
|
909
|
+
# @yield [result, err] Result & error if block supplied
|
910
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig] parsed result object
|
911
|
+
# @yieldparam err [StandardError] error object if request failed
|
912
|
+
#
|
913
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig]
|
914
|
+
#
|
915
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
916
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
917
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
918
|
+
def patch_project_app_device_check_config(name, google_firebase_appcheck_v1_device_check_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
919
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
920
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig::Representation
|
921
|
+
command.request_object = google_firebase_appcheck_v1_device_check_config_object
|
922
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig::Representation
|
923
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1DeviceCheckConfig
|
924
|
+
command.params['name'] = name unless name.nil?
|
925
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
926
|
+
command.query['fields'] = fields unless fields.nil?
|
927
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
928
|
+
execute_or_queue_command(command, &block)
|
929
|
+
end
|
930
|
+
|
931
|
+
# Atomically gets the PlayIntegrityConfigs for the specified list of apps.
|
932
|
+
# @param [String] parent
|
933
|
+
# Required. The parent project name shared by all PlayIntegrityConfigs being
|
934
|
+
# retrieved, in the format ``` projects/`project_number` ``` The parent
|
935
|
+
# collection in the `name` field of any resource being retrieved must match this
|
936
|
+
# field, or the entire batch fails.
|
937
|
+
# @param [Array<String>, String] names
|
938
|
+
# Required. The relative resource names of the PlayIntegrityConfigs to retrieve,
|
939
|
+
# in the format ``` projects/`project_number`/apps/`app_id`/playIntegrityConfig `
|
940
|
+
# `` A maximum of 100 objects can be retrieved in a batch.
|
941
|
+
# @param [String] fields
|
942
|
+
# Selector specifying which fields to include in a partial response.
|
943
|
+
# @param [String] quota_user
|
944
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
945
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
946
|
+
# @param [Google::Apis::RequestOptions] options
|
947
|
+
# Request-specific options
|
948
|
+
#
|
949
|
+
# @yield [result, err] Result & error if block supplied
|
950
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetPlayIntegrityConfigsResponse] parsed result object
|
951
|
+
# @yieldparam err [StandardError] error object if request failed
|
952
|
+
#
|
953
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetPlayIntegrityConfigsResponse]
|
954
|
+
#
|
955
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
956
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
957
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
958
|
+
def batch_project_app_play_integrity_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
|
959
|
+
command = make_simple_command(:get, 'v1/{+parent}/apps/-/playIntegrityConfig:batchGet', options)
|
960
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetPlayIntegrityConfigsResponse::Representation
|
961
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetPlayIntegrityConfigsResponse
|
962
|
+
command.params['parent'] = parent unless parent.nil?
|
963
|
+
command.query['names'] = names unless names.nil?
|
964
|
+
command.query['fields'] = fields unless fields.nil?
|
965
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
966
|
+
execute_or_queue_command(command, &block)
|
967
|
+
end
|
968
|
+
|
969
|
+
# Gets the PlayIntegrityConfig for the specified app.
|
970
|
+
# @param [String] name
|
971
|
+
# Required. The relative resource name of the PlayIntegrityConfig, in the format:
|
972
|
+
# ``` projects/`project_number`/apps/`app_id`/playIntegrityConfig ```
|
973
|
+
# @param [String] fields
|
974
|
+
# Selector specifying which fields to include in a partial response.
|
975
|
+
# @param [String] quota_user
|
976
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
977
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
978
|
+
# @param [Google::Apis::RequestOptions] options
|
979
|
+
# Request-specific options
|
980
|
+
#
|
981
|
+
# @yield [result, err] Result & error if block supplied
|
982
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig] parsed result object
|
983
|
+
# @yieldparam err [StandardError] error object if request failed
|
984
|
+
#
|
985
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig]
|
986
|
+
#
|
987
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
988
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
989
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
990
|
+
def get_project_app_play_integrity_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
991
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
992
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig::Representation
|
993
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig
|
994
|
+
command.params['name'] = name unless name.nil?
|
995
|
+
command.query['fields'] = fields unless fields.nil?
|
996
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
997
|
+
execute_or_queue_command(command, &block)
|
998
|
+
end
|
999
|
+
|
1000
|
+
# Updates the PlayIntegrityConfig for the specified app. While this
|
1001
|
+
# configuration is incomplete or invalid, the app will be unable to exchange
|
1002
|
+
# Play Integrity tokens for App Check tokens.
|
1003
|
+
# @param [String] name
|
1004
|
+
# Required. The relative resource name of the Play Integrity configuration
|
1005
|
+
# object, in the format: ``` projects/`project_number`/apps/`app_id`/
|
1006
|
+
# playIntegrityConfig ```
|
1007
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig] google_firebase_appcheck_v1_play_integrity_config_object
|
1008
|
+
# @param [String] update_mask
|
1009
|
+
# Required. A comma-separated list of names of fields in the PlayIntegrityConfig
|
1010
|
+
# Gets to update. Example: `token_ttl`.
|
1011
|
+
# @param [String] fields
|
1012
|
+
# Selector specifying which fields to include in a partial response.
|
1013
|
+
# @param [String] quota_user
|
1014
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1015
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1016
|
+
# @param [Google::Apis::RequestOptions] options
|
1017
|
+
# Request-specific options
|
1018
|
+
#
|
1019
|
+
# @yield [result, err] Result & error if block supplied
|
1020
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig] parsed result object
|
1021
|
+
# @yieldparam err [StandardError] error object if request failed
|
1022
|
+
#
|
1023
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig]
|
1024
|
+
#
|
1025
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1026
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1027
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1028
|
+
def patch_project_app_play_integrity_config(name, google_firebase_appcheck_v1_play_integrity_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1029
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
1030
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig::Representation
|
1031
|
+
command.request_object = google_firebase_appcheck_v1_play_integrity_config_object
|
1032
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig::Representation
|
1033
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1PlayIntegrityConfig
|
1034
|
+
command.params['name'] = name unless name.nil?
|
1035
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1036
|
+
command.query['fields'] = fields unless fields.nil?
|
1037
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1038
|
+
execute_or_queue_command(command, &block)
|
1039
|
+
end
|
1040
|
+
|
1041
|
+
# Atomically gets the RecaptchaEnterpriseConfigs for the specified list of apps.
|
1042
|
+
# @param [String] parent
|
1043
|
+
# Required. The parent project name shared by all RecaptchaEnterpriseConfigs
|
1044
|
+
# being retrieved, in the format ``` projects/`project_number` ``` The parent
|
1045
|
+
# collection in the `name` field of any resource being retrieved must match this
|
1046
|
+
# field, or the entire batch fails.
|
1047
|
+
# @param [Array<String>, String] names
|
1048
|
+
# Required. The relative resource names of the RecaptchaEnterpriseConfigs to
|
1049
|
+
# retrieve, in the format: ``` projects/`project_number`/apps/`app_id`/
|
1050
|
+
# recaptchaEnterpriseConfig ``` A maximum of 100 objects can be retrieved in a
|
1051
|
+
# batch.
|
1052
|
+
# @param [String] fields
|
1053
|
+
# Selector specifying which fields to include in a partial response.
|
1054
|
+
# @param [String] quota_user
|
1055
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1056
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1057
|
+
# @param [Google::Apis::RequestOptions] options
|
1058
|
+
# Request-specific options
|
1059
|
+
#
|
1060
|
+
# @yield [result, err] Result & error if block supplied
|
1061
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaEnterpriseConfigsResponse] parsed result object
|
1062
|
+
# @yieldparam err [StandardError] error object if request failed
|
1063
|
+
#
|
1064
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaEnterpriseConfigsResponse]
|
1065
|
+
#
|
1066
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1067
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1068
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1069
|
+
def batch_project_app_recaptcha_enterprise_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1070
|
+
command = make_simple_command(:get, 'v1/{+parent}/apps/-/recaptchaEnterpriseConfig:batchGet', options)
|
1071
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaEnterpriseConfigsResponse::Representation
|
1072
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaEnterpriseConfigsResponse
|
1073
|
+
command.params['parent'] = parent unless parent.nil?
|
1074
|
+
command.query['names'] = names unless names.nil?
|
1075
|
+
command.query['fields'] = fields unless fields.nil?
|
1076
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1077
|
+
execute_or_queue_command(command, &block)
|
1078
|
+
end
|
1079
|
+
|
1080
|
+
# Gets the RecaptchaEnterpriseConfig for the specified app.
|
1081
|
+
# @param [String] name
|
1082
|
+
# Required. The relative resource name of the RecaptchaEnterpriseConfig, in the
|
1083
|
+
# format: ``` projects/`project_number`/apps/`app_id`/recaptchaEnterpriseConfig `
|
1084
|
+
# ``
|
1085
|
+
# @param [String] fields
|
1086
|
+
# Selector specifying which fields to include in a partial response.
|
1087
|
+
# @param [String] quota_user
|
1088
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1089
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1090
|
+
# @param [Google::Apis::RequestOptions] options
|
1091
|
+
# Request-specific options
|
1092
|
+
#
|
1093
|
+
# @yield [result, err] Result & error if block supplied
|
1094
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig] parsed result object
|
1095
|
+
# @yieldparam err [StandardError] error object if request failed
|
1096
|
+
#
|
1097
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig]
|
1098
|
+
#
|
1099
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1100
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1101
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1102
|
+
def get_project_app_recaptcha_enterprise_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
1103
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
1104
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig::Representation
|
1105
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig
|
1106
|
+
command.params['name'] = name unless name.nil?
|
1107
|
+
command.query['fields'] = fields unless fields.nil?
|
1108
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1109
|
+
execute_or_queue_command(command, &block)
|
1110
|
+
end
|
1111
|
+
|
1112
|
+
# Updates the RecaptchaEnterpriseConfig for the specified app. While this
|
1113
|
+
# configuration is incomplete or invalid, the app will be unable to exchange
|
1114
|
+
# reCAPTCHA Enterprise tokens for App Check tokens.
|
1115
|
+
# @param [String] name
|
1116
|
+
# Required. The relative resource name of the reCAPTCHA Enterprise configuration
|
1117
|
+
# object, in the format: ``` projects/`project_number`/apps/`app_id`/
|
1118
|
+
# recaptchaEnterpriseConfig ```
|
1119
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig] google_firebase_appcheck_v1_recaptcha_enterprise_config_object
|
1120
|
+
# @param [String] update_mask
|
1121
|
+
# Required. A comma-separated list of names of fields in the
|
1122
|
+
# RecaptchaEnterpriseConfig to update. Example: `site_key`.
|
1123
|
+
# @param [String] fields
|
1124
|
+
# Selector specifying which fields to include in a partial response.
|
1125
|
+
# @param [String] quota_user
|
1126
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1127
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1128
|
+
# @param [Google::Apis::RequestOptions] options
|
1129
|
+
# Request-specific options
|
1130
|
+
#
|
1131
|
+
# @yield [result, err] Result & error if block supplied
|
1132
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig] parsed result object
|
1133
|
+
# @yieldparam err [StandardError] error object if request failed
|
1134
|
+
#
|
1135
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig]
|
1136
|
+
#
|
1137
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1138
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1139
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1140
|
+
def patch_project_app_recaptcha_enterprise_config(name, google_firebase_appcheck_v1_recaptcha_enterprise_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1141
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
1142
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig::Representation
|
1143
|
+
command.request_object = google_firebase_appcheck_v1_recaptcha_enterprise_config_object
|
1144
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig::Representation
|
1145
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig
|
1146
|
+
command.params['name'] = name unless name.nil?
|
1147
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1148
|
+
command.query['fields'] = fields unless fields.nil?
|
1149
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1150
|
+
execute_or_queue_command(command, &block)
|
1151
|
+
end
|
1152
|
+
|
1153
|
+
# Atomically gets the RecaptchaV3Configs for the specified list of apps. For
|
1154
|
+
# security reasons, the `site_secret` field is never populated in the response.
|
1155
|
+
# @param [String] parent
|
1156
|
+
# Required. The parent project name shared by all RecaptchaV3Configs being
|
1157
|
+
# retrieved, in the format ``` projects/`project_number` ``` The parent
|
1158
|
+
# collection in the `name` field of any resource being retrieved must match this
|
1159
|
+
# field, or the entire batch fails.
|
1160
|
+
# @param [Array<String>, String] names
|
1161
|
+
# Required. The relative resource names of the RecaptchaV3Configs to retrieve,
|
1162
|
+
# in the format: ``` projects/`project_number`/apps/`app_id`/recaptchaV3Config ``
|
1163
|
+
# ` A maximum of 100 objects can be retrieved in a batch.
|
1164
|
+
# @param [String] fields
|
1165
|
+
# Selector specifying which fields to include in a partial response.
|
1166
|
+
# @param [String] quota_user
|
1167
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1168
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1169
|
+
# @param [Google::Apis::RequestOptions] options
|
1170
|
+
# Request-specific options
|
1171
|
+
#
|
1172
|
+
# @yield [result, err] Result & error if block supplied
|
1173
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaV3ConfigsResponse] parsed result object
|
1174
|
+
# @yieldparam err [StandardError] error object if request failed
|
1175
|
+
#
|
1176
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaV3ConfigsResponse]
|
1177
|
+
#
|
1178
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1179
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1180
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1181
|
+
def batch_project_app_recaptcha_v3_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1182
|
+
command = make_simple_command(:get, 'v1/{+parent}/apps/-/recaptchaV3Config:batchGet', options)
|
1183
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaV3ConfigsResponse::Representation
|
1184
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetRecaptchaV3ConfigsResponse
|
1185
|
+
command.params['parent'] = parent unless parent.nil?
|
1186
|
+
command.query['names'] = names unless names.nil?
|
1187
|
+
command.query['fields'] = fields unless fields.nil?
|
1188
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1189
|
+
execute_or_queue_command(command, &block)
|
1190
|
+
end
|
1191
|
+
|
1192
|
+
# Gets the RecaptchaV3Config for the specified app. For security reasons, the `
|
1193
|
+
# site_secret` field is never populated in the response.
|
1194
|
+
# @param [String] name
|
1195
|
+
# Required. The relative resource name of the RecaptchaV3Config, in the format: `
|
1196
|
+
# `` projects/`project_number`/apps/`app_id`/recaptchaV3Config ```
|
1197
|
+
# @param [String] fields
|
1198
|
+
# Selector specifying which fields to include in a partial response.
|
1199
|
+
# @param [String] quota_user
|
1200
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1201
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1202
|
+
# @param [Google::Apis::RequestOptions] options
|
1203
|
+
# Request-specific options
|
1204
|
+
#
|
1205
|
+
# @yield [result, err] Result & error if block supplied
|
1206
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config] parsed result object
|
1207
|
+
# @yieldparam err [StandardError] error object if request failed
|
1208
|
+
#
|
1209
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config]
|
1210
|
+
#
|
1211
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1212
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1213
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1214
|
+
def get_project_app_recaptcha_v3_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
1215
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
1216
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config::Representation
|
1217
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config
|
1218
|
+
command.params['name'] = name unless name.nil?
|
1219
|
+
command.query['fields'] = fields unless fields.nil?
|
1220
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1221
|
+
execute_or_queue_command(command, &block)
|
1222
|
+
end
|
1223
|
+
|
1224
|
+
# Updates the RecaptchaV3Config for the specified app. While this configuration
|
1225
|
+
# is incomplete or invalid, the app will be unable to exchange reCAPTCHA tokens
|
1226
|
+
# for App Check tokens. For security reasons, the `site_secret` field is never
|
1227
|
+
# populated in the response.
|
1228
|
+
# @param [String] name
|
1229
|
+
# Required. The relative resource name of the reCAPTCHA v3 configuration object,
|
1230
|
+
# in the format: ``` projects/`project_number`/apps/`app_id`/recaptchaV3Config ``
|
1231
|
+
# `
|
1232
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config] google_firebase_appcheck_v1_recaptcha_v3_config_object
|
1233
|
+
# @param [String] update_mask
|
1234
|
+
# Required. A comma-separated list of names of fields in the RecaptchaV3Config
|
1235
|
+
# to update. Example: `site_secret`.
|
1236
|
+
# @param [String] fields
|
1237
|
+
# Selector specifying which fields to include in a partial response.
|
1238
|
+
# @param [String] quota_user
|
1239
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1240
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1241
|
+
# @param [Google::Apis::RequestOptions] options
|
1242
|
+
# Request-specific options
|
1243
|
+
#
|
1244
|
+
# @yield [result, err] Result & error if block supplied
|
1245
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config] parsed result object
|
1246
|
+
# @yieldparam err [StandardError] error object if request failed
|
1247
|
+
#
|
1248
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config]
|
1249
|
+
#
|
1250
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1251
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1252
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1253
|
+
def patch_project_app_recaptcha_v3_config(name, google_firebase_appcheck_v1_recaptcha_v3_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1254
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
1255
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config::Representation
|
1256
|
+
command.request_object = google_firebase_appcheck_v1_recaptcha_v3_config_object
|
1257
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config::Representation
|
1258
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1RecaptchaV3Config
|
1259
|
+
command.params['name'] = name unless name.nil?
|
1260
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1261
|
+
command.query['fields'] = fields unless fields.nil?
|
1262
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1263
|
+
execute_or_queue_command(command, &block)
|
1264
|
+
end
|
1265
|
+
|
1266
|
+
# Atomically gets the SafetyNetConfigs for the specified list of apps.
|
1267
|
+
# @param [String] parent
|
1268
|
+
# Required. The parent project name shared by all SafetyNetConfigs being
|
1269
|
+
# retrieved, in the format ``` projects/`project_number` ``` The parent
|
1270
|
+
# collection in the `name` field of any resource being retrieved must match this
|
1271
|
+
# field, or the entire batch fails.
|
1272
|
+
# @param [Array<String>, String] names
|
1273
|
+
# Required. The relative resource names of the SafetyNetConfigs to retrieve, in
|
1274
|
+
# the format ``` projects/`project_number`/apps/`app_id`/safetyNetConfig ``` A
|
1275
|
+
# maximum of 100 objects can be retrieved in a batch.
|
1276
|
+
# @param [String] fields
|
1277
|
+
# Selector specifying which fields to include in a partial response.
|
1278
|
+
# @param [String] quota_user
|
1279
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1280
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1281
|
+
# @param [Google::Apis::RequestOptions] options
|
1282
|
+
# Request-specific options
|
1283
|
+
#
|
1284
|
+
# @yield [result, err] Result & error if block supplied
|
1285
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetSafetyNetConfigsResponse] parsed result object
|
1286
|
+
# @yieldparam err [StandardError] error object if request failed
|
1287
|
+
#
|
1288
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetSafetyNetConfigsResponse]
|
1289
|
+
#
|
1290
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1291
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1292
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1293
|
+
def batch_project_app_safety_net_config_get(parent, names: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1294
|
+
command = make_simple_command(:get, 'v1/{+parent}/apps/-/safetyNetConfig:batchGet', options)
|
1295
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetSafetyNetConfigsResponse::Representation
|
1296
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchGetSafetyNetConfigsResponse
|
1297
|
+
command.params['parent'] = parent unless parent.nil?
|
1298
|
+
command.query['names'] = names unless names.nil?
|
1299
|
+
command.query['fields'] = fields unless fields.nil?
|
1300
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1301
|
+
execute_or_queue_command(command, &block)
|
1302
|
+
end
|
1303
|
+
|
1304
|
+
# Gets the SafetyNetConfig for the specified app.
|
1305
|
+
# @param [String] name
|
1306
|
+
# Required. The relative resource name of the SafetyNetConfig, in the format: ```
|
1307
|
+
# projects/`project_number`/apps/`app_id`/safetyNetConfig ```
|
1308
|
+
# @param [String] fields
|
1309
|
+
# Selector specifying which fields to include in a partial response.
|
1310
|
+
# @param [String] quota_user
|
1311
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1312
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1313
|
+
# @param [Google::Apis::RequestOptions] options
|
1314
|
+
# Request-specific options
|
1315
|
+
#
|
1316
|
+
# @yield [result, err] Result & error if block supplied
|
1317
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1SafetyNetConfig] parsed result object
|
1318
|
+
# @yieldparam err [StandardError] error object if request failed
|
1319
|
+
#
|
1320
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1SafetyNetConfig]
|
1321
|
+
#
|
1322
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1323
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1324
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1325
|
+
def get_project_app_safety_net_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
1326
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
1327
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1SafetyNetConfig::Representation
|
1328
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1SafetyNetConfig
|
1329
|
+
command.params['name'] = name unless name.nil?
|
1330
|
+
command.query['fields'] = fields unless fields.nil?
|
1331
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1332
|
+
execute_or_queue_command(command, &block)
|
1333
|
+
end
|
1334
|
+
|
1335
|
+
# Updates the SafetyNetConfig for the specified app. While this configuration is
|
1336
|
+
# incomplete or invalid, the app will be unable to exchange SafetyNet tokens for
|
1337
|
+
# App Check tokens.
|
1338
|
+
# @param [String] name
|
1339
|
+
# Required. The relative resource name of the SafetyNet configuration object, in
|
1340
|
+
# the format: ``` projects/`project_number`/apps/`app_id`/safetyNetConfig ```
|
1341
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1SafetyNetConfig] google_firebase_appcheck_v1_safety_net_config_object
|
1342
|
+
# @param [String] update_mask
|
1343
|
+
# Required. A comma-separated list of names of fields in the SafetyNetConfig
|
1344
|
+
# Gets to update. Example: `token_ttl`.
|
1345
|
+
# @param [String] fields
|
1346
|
+
# Selector specifying which fields to include in a partial response.
|
1347
|
+
# @param [String] quota_user
|
1348
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1349
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1350
|
+
# @param [Google::Apis::RequestOptions] options
|
1351
|
+
# Request-specific options
|
1352
|
+
#
|
1353
|
+
# @yield [result, err] Result & error if block supplied
|
1354
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1SafetyNetConfig] parsed result object
|
1355
|
+
# @yieldparam err [StandardError] error object if request failed
|
1356
|
+
#
|
1357
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1SafetyNetConfig]
|
1358
|
+
#
|
1359
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1360
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1361
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1362
|
+
def patch_project_app_safety_net_config(name, google_firebase_appcheck_v1_safety_net_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1363
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
1364
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1SafetyNetConfig::Representation
|
1365
|
+
command.request_object = google_firebase_appcheck_v1_safety_net_config_object
|
1366
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1SafetyNetConfig::Representation
|
1367
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1SafetyNetConfig
|
1368
|
+
command.params['name'] = name unless name.nil?
|
1369
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1370
|
+
command.query['fields'] = fields unless fields.nil?
|
1371
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1372
|
+
execute_or_queue_command(command, &block)
|
1373
|
+
end
|
1374
|
+
|
1375
|
+
# Atomically updates the specified Service configurations.
|
1376
|
+
# @param [String] parent
|
1377
|
+
# Required. The parent project name shared by all Service configurations being
|
1378
|
+
# updated, in the format ``` projects/`project_number` ``` The parent collection
|
1379
|
+
# in the `name` field of any resource being updated must match this field, or
|
1380
|
+
# the entire batch fails.
|
1381
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateServicesRequest] google_firebase_appcheck_v1_batch_update_services_request_object
|
1382
|
+
# @param [String] fields
|
1383
|
+
# Selector specifying which fields to include in a partial response.
|
1384
|
+
# @param [String] quota_user
|
1385
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1386
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1387
|
+
# @param [Google::Apis::RequestOptions] options
|
1388
|
+
# Request-specific options
|
1389
|
+
#
|
1390
|
+
# @yield [result, err] Result & error if block supplied
|
1391
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateServicesResponse] parsed result object
|
1392
|
+
# @yieldparam err [StandardError] error object if request failed
|
1393
|
+
#
|
1394
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateServicesResponse]
|
1395
|
+
#
|
1396
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1397
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1398
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1399
|
+
def batch_project_service_update(parent, google_firebase_appcheck_v1_batch_update_services_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1400
|
+
command = make_simple_command(:post, 'v1/{+parent}/services:batchUpdate', options)
|
1401
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateServicesRequest::Representation
|
1402
|
+
command.request_object = google_firebase_appcheck_v1_batch_update_services_request_object
|
1403
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateServicesResponse::Representation
|
1404
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1BatchUpdateServicesResponse
|
1405
|
+
command.params['parent'] = parent unless parent.nil?
|
1406
|
+
command.query['fields'] = fields unless fields.nil?
|
1407
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1408
|
+
execute_or_queue_command(command, &block)
|
1409
|
+
end
|
1410
|
+
|
1411
|
+
# Gets the Service configuration for the specified service name.
|
1412
|
+
# @param [String] name
|
1413
|
+
# Required. The relative resource name of the Service to retrieve, in the format:
|
1414
|
+
# ``` projects/`project_number`/services/`service_id` ``` Note that the `
|
1415
|
+
# service_id` element must be a supported service ID. Currently, the following
|
1416
|
+
# service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage
|
1417
|
+
# for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database)
|
1418
|
+
# * `firestore.googleapis.com` (Cloud Firestore)
|
1419
|
+
# @param [String] fields
|
1420
|
+
# Selector specifying which fields to include in a partial response.
|
1421
|
+
# @param [String] quota_user
|
1422
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1423
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1424
|
+
# @param [Google::Apis::RequestOptions] options
|
1425
|
+
# Request-specific options
|
1426
|
+
#
|
1427
|
+
# @yield [result, err] Result & error if block supplied
|
1428
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service] parsed result object
|
1429
|
+
# @yieldparam err [StandardError] error object if request failed
|
1430
|
+
#
|
1431
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service]
|
1432
|
+
#
|
1433
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1434
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1435
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1436
|
+
def get_project_service(name, fields: nil, quota_user: nil, options: nil, &block)
|
1437
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
1438
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service::Representation
|
1439
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service
|
1440
|
+
command.params['name'] = name unless name.nil?
|
1441
|
+
command.query['fields'] = fields unless fields.nil?
|
1442
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1443
|
+
execute_or_queue_command(command, &block)
|
1444
|
+
end
|
1445
|
+
|
1446
|
+
# Lists all Service configurations for the specified project. Only Services
|
1447
|
+
# which were explicitly configured using UpdateService or BatchUpdateServices
|
1448
|
+
# will be returned.
|
1449
|
+
# @param [String] parent
|
1450
|
+
# Required. The relative resource name of the parent project for which to list
|
1451
|
+
# each associated Service, in the format: ``` projects/`project_number` ```
|
1452
|
+
# @param [Fixnum] page_size
|
1453
|
+
# The maximum number of Services to return in the response. Only explicitly
|
1454
|
+
# configured services are returned. The server may return fewer than this at its
|
1455
|
+
# own discretion. If no value is specified (or too large a value is specified),
|
1456
|
+
# the server will impose its own limit.
|
1457
|
+
# @param [String] page_token
|
1458
|
+
# Token returned from a previous call to ListServices indicating where in the
|
1459
|
+
# set of Services to resume listing. Provide this to retrieve the subsequent
|
1460
|
+
# page. When paginating, all other parameters provided to ListServices must
|
1461
|
+
# match the call that provided the page token; if they do not match, the result
|
1462
|
+
# is undefined.
|
1463
|
+
# @param [String] fields
|
1464
|
+
# Selector specifying which fields to include in a partial response.
|
1465
|
+
# @param [String] quota_user
|
1466
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1467
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1468
|
+
# @param [Google::Apis::RequestOptions] options
|
1469
|
+
# Request-specific options
|
1470
|
+
#
|
1471
|
+
# @yield [result, err] Result & error if block supplied
|
1472
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListServicesResponse] parsed result object
|
1473
|
+
# @yieldparam err [StandardError] error object if request failed
|
1474
|
+
#
|
1475
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListServicesResponse]
|
1476
|
+
#
|
1477
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1478
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1479
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1480
|
+
def list_project_services(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1481
|
+
command = make_simple_command(:get, 'v1/{+parent}/services', options)
|
1482
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListServicesResponse::Representation
|
1483
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1ListServicesResponse
|
1484
|
+
command.params['parent'] = parent unless parent.nil?
|
1485
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1486
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1487
|
+
command.query['fields'] = fields unless fields.nil?
|
1488
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1489
|
+
execute_or_queue_command(command, &block)
|
1490
|
+
end
|
1491
|
+
|
1492
|
+
# Updates the specified Service configuration.
|
1493
|
+
# @param [String] name
|
1494
|
+
# Required. The relative resource name of the service configuration object, in
|
1495
|
+
# the format: ``` projects/`project_number`/services/`service_id` ``` Note that
|
1496
|
+
# the `service_id` element must be a supported service ID. Currently, the
|
1497
|
+
# following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud
|
1498
|
+
# Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime
|
1499
|
+
# Database) * `firestore.googleapis.com` (Cloud Firestore)
|
1500
|
+
# @param [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service] google_firebase_appcheck_v1_service_object
|
1501
|
+
# @param [String] update_mask
|
1502
|
+
# Required. A comma-separated list of names of fields in the Service to update.
|
1503
|
+
# Example: `enforcement_mode`.
|
1504
|
+
# @param [String] fields
|
1505
|
+
# Selector specifying which fields to include in a partial response.
|
1506
|
+
# @param [String] quota_user
|
1507
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1508
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1509
|
+
# @param [Google::Apis::RequestOptions] options
|
1510
|
+
# Request-specific options
|
1511
|
+
#
|
1512
|
+
# @yield [result, err] Result & error if block supplied
|
1513
|
+
# @yieldparam result [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service] parsed result object
|
1514
|
+
# @yieldparam err [StandardError] error object if request failed
|
1515
|
+
#
|
1516
|
+
# @return [Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service]
|
1517
|
+
#
|
1518
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1519
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1520
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1521
|
+
def patch_project_service(name, google_firebase_appcheck_v1_service_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1522
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
1523
|
+
command.request_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service::Representation
|
1524
|
+
command.request_object = google_firebase_appcheck_v1_service_object
|
1525
|
+
command.response_representation = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service::Representation
|
1526
|
+
command.response_class = Google::Apis::FirebaseappcheckV1::GoogleFirebaseAppcheckV1Service
|
1527
|
+
command.params['name'] = name unless name.nil?
|
1528
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1529
|
+
command.query['fields'] = fields unless fields.nil?
|
1530
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1531
|
+
execute_or_queue_command(command, &block)
|
1532
|
+
end
|
52
1533
|
|
53
1534
|
protected
|
54
1535
|
|