From f8c39017aa392c0930ab79cdf7f828fe1e97e313 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Jul 2021 07:07:17 +0000 Subject: [PATCH] feat(firebaseappcheck): update the api #### firebaseappcheck:v1beta The following keys were added: - resources.projects.resources.apps.resources.appAttestConfig.methods.batchGet (Total Keys: 14) - resources.projects.resources.apps.resources.appAttestConfig.methods.get (Total Keys: 11) - resources.projects.resources.apps.resources.appAttestConfig.methods.patch (Total Keys: 15) - resources.projects.resources.apps.resources.safetyNetConfig.methods.batchGet (Total Keys: 14) - resources.projects.resources.apps.resources.safetyNetConfig.methods.get (Total Keys: 11) - resources.projects.resources.apps.resources.safetyNetConfig.methods.patch (Total Keys: 15) - schemas.GoogleFirebaseAppcheckV1betaAppAttestConfig (Total Keys: 5) - schemas.GoogleFirebaseAppcheckV1betaBatchGetAppAttestConfigsResponse (Total Keys: 4) - schemas.GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse (Total Keys: 4) - schemas.GoogleFirebaseAppcheckV1betaDeviceCheckConfig.properties.tokenTtl (Total Keys: 2) - schemas.GoogleFirebaseAppcheckV1betaRecaptchaConfig.properties.tokenTtl (Total Keys: 2) - schemas.GoogleFirebaseAppcheckV1betaSafetyNetConfig (Total Keys: 5) --- ..._v1beta.projects.apps.appAttestConfig.html | 169 +++++++++++ ...1beta.projects.apps.deviceCheckConfig.html | 4 + ...firebaseappcheck_v1beta.projects.apps.html | 10 + ..._v1beta.projects.apps.recaptchaConfig.html | 4 + ..._v1beta.projects.apps.safetyNetConfig.html | 169 +++++++++++ .../documents/firebaseappcheck.v1beta.json | 266 +++++++++++++++++- 6 files changed, 621 insertions(+), 1 deletion(-) create mode 100644 docs/dyn/firebaseappcheck_v1beta.projects.apps.appAttestConfig.html create mode 100644 docs/dyn/firebaseappcheck_v1beta.projects.apps.safetyNetConfig.html diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.apps.appAttestConfig.html b/docs/dyn/firebaseappcheck_v1beta.projects.apps.appAttestConfig.html new file mode 100644 index 00000000000..605d45482a3 --- /dev/null +++ b/docs/dyn/firebaseappcheck_v1beta.projects.apps.appAttestConfig.html @@ -0,0 +1,169 @@ + + + +

Firebase App Check API . projects . apps . appAttestConfig

+

Instance Methods

+

+ batchGet(parent, names=None, x__xgafv=None)

+

Gets the AppAttestConfigs for the specified list of apps atomically.

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets the AppAttestConfig for the specified app.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the AppAttestConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange AppAttest tokens for App Check tokens.

+

Method Details

+
+ batchGet(parent, names=None, x__xgafv=None) + 
Gets the AppAttestConfigs for the specified list of apps atomically.
+
+Args:
+  parent: string, Required. The parent project name shared by all AppAttestConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails. (required)
+  names: string, Required. The relative resource names of the AppAttestConfigs to retrieve, in the format ``` projects/{project_number}/apps/{app_id}/appAttestConfig ``` A maximum of 100 objects can be retrieved in a batch. (repeated)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the BatchGetAppAttestConfigs method.
+  "configs": [ # AppAttestConfigs retrieved.
+    { # An app's App Attest configuration object. This configuration controls certain properties of the App Check token returned by ExchangeAppAttestAttestation and ExchangeAppAttestAttestation, such as its ttl. Note that the Team ID registered with your app is used as part of the validation process. Please register it via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.iosApps/patch).
+      "name": "A String", # Required. The relative resource name of the App Attest configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/appAttestConfig ```
+      "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from App Attest artifacts will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+    },
+  ],
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) + 
Gets the AppAttestConfig for the specified app.
+
+Args:
+  name: string, Required. The relative resource name of the AppAttestConfig, in the format: ``` projects/{project_number}/apps/{app_id}/appAttestConfig ``` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An app's App Attest configuration object. This configuration controls certain properties of the App Check token returned by ExchangeAppAttestAttestation and ExchangeAppAttestAttestation, such as its ttl. Note that the Team ID registered with your app is used as part of the validation process. Please register it via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.iosApps/patch).
+  "name": "A String", # Required. The relative resource name of the App Attest configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/appAttestConfig ```
+  "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from App Attest artifacts will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+}
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates the AppAttestConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange AppAttest tokens for App Check tokens.
+
+Args:
+  name: string, Required. The relative resource name of the App Attest configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/appAttestConfig ``` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An app's App Attest configuration object. This configuration controls certain properties of the App Check token returned by ExchangeAppAttestAttestation and ExchangeAppAttestAttestation, such as its ttl. Note that the Team ID registered with your app is used as part of the validation process. Please register it via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.iosApps/patch).
+  "name": "A String", # Required. The relative resource name of the App Attest configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/appAttestConfig ```
+  "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from App Attest artifacts will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+}
+
+  updateMask: string, Required. A comma-separated list of names of fields in the AppAttestConfig Gets to update. Example: `token_ttl`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An app's App Attest configuration object. This configuration controls certain properties of the App Check token returned by ExchangeAppAttestAttestation and ExchangeAppAttestAttestation, such as its ttl. Note that the Team ID registered with your app is used as part of the validation process. Please register it via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.iosApps/patch).
+  "name": "A String", # Required. The relative resource name of the App Attest configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/appAttestConfig ```
+  "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from App Attest artifacts will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.apps.deviceCheckConfig.html b/docs/dyn/firebaseappcheck_v1beta.projects.apps.deviceCheckConfig.html index 667c6e9ac98..99e9b930c5f 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.apps.deviceCheckConfig.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.apps.deviceCheckConfig.html @@ -109,6 +109,7 @@

Method Details

"name": "A String", # Required. The relative resource name of the DeviceCheck configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/deviceCheckConfig ``` "privateKey": "A String", # Required. Input only. The contents of the private key (`.p8`) file associated with the key specified by `key_id`. For security reasons, this field will never be populated in any response. "privateKeySet": True or False, # Output only. Whether the `private_key` field was previously set. Since we will never return the `private_key` field, this field is the only way to find out whether it was previously set. + "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from DeviceCheck tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. }, ], } @@ -138,6 +139,7 @@

Method Details

"name": "A String", # Required. The relative resource name of the DeviceCheck configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/deviceCheckConfig ``` "privateKey": "A String", # Required. Input only. The contents of the private key (`.p8`) file associated with the key specified by `key_id`. For security reasons, this field will never be populated in any response. "privateKeySet": True or False, # Output only. Whether the `private_key` field was previously set. Since we will never return the `private_key` field, this field is the only way to find out whether it was previously set. + "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from DeviceCheck tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. } @@ -155,6 +157,7 @@

Method Details

"name": "A String", # Required. The relative resource name of the DeviceCheck configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/deviceCheckConfig ``` "privateKey": "A String", # Required. Input only. The contents of the private key (`.p8`) file associated with the key specified by `key_id`. For security reasons, this field will never be populated in any response. "privateKeySet": True or False, # Output only. Whether the `private_key` field was previously set. Since we will never return the `private_key` field, this field is the only way to find out whether it was previously set. + "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from DeviceCheck tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. } updateMask: string, Required. A comma-separated list of names of fields in the DeviceCheckConfig Gets to update. Example: `key_id,private_key`. @@ -171,6 +174,7 @@

Method Details

"name": "A String", # Required. The relative resource name of the DeviceCheck configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/deviceCheckConfig ``` "privateKey": "A String", # Required. Input only. The contents of the private key (`.p8`) file associated with the key specified by `key_id`. For security reasons, this field will never be populated in any response. "privateKeySet": True or False, # Output only. Whether the `private_key` field was previously set. Since we will never return the `private_key` field, this field is the only way to find out whether it was previously set. + "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from DeviceCheck tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. } diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.apps.html b/docs/dyn/firebaseappcheck_v1beta.projects.apps.html index 1ebfac46a22..a3f27b3bf1e 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.apps.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.apps.html @@ -74,6 +74,11 @@

Firebase App Check API . projects . apps

Instance Methods

+

+ appAttestConfig() +

+

Returns the appAttestConfig Resource.

+

debugTokens()

@@ -89,6 +94,11 @@

Instance Methods

Returns the recaptchaConfig Resource.

+

+ safetyNetConfig() +

+

Returns the safetyNetConfig Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaConfig.html b/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaConfig.html index b7f1a05c354..e2be31a3be3 100644 --- a/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaConfig.html +++ b/docs/dyn/firebaseappcheck_v1beta.projects.apps.recaptchaConfig.html @@ -108,6 +108,7 @@

Method Details

"name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. + "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from reCAPTCHA tokens will be valid. If unset, a default value of 1 day is assumed. Must be between 30 minutes and 7 days, inclusive. }, ], } @@ -136,6 +137,7 @@

Method Details

"name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. + "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from reCAPTCHA tokens will be valid. If unset, a default value of 1 day is assumed. Must be between 30 minutes and 7 days, inclusive. } @@ -152,6 +154,7 @@

Method Details

"name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. + "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from reCAPTCHA tokens will be valid. If unset, a default value of 1 day is assumed. Must be between 30 minutes and 7 days, inclusive. } updateMask: string, Required. A comma-separated list of names of fields in the RecaptchaConfig to update. Example: `site_secret`. @@ -167,6 +170,7 @@

Method Details

"name": "A String", # Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaConfig ``` "siteSecret": "A String", # Required. Input only. The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. "siteSecretSet": True or False, # Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set. + "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from reCAPTCHA tokens will be valid. If unset, a default value of 1 day is assumed. Must be between 30 minutes and 7 days, inclusive. } diff --git a/docs/dyn/firebaseappcheck_v1beta.projects.apps.safetyNetConfig.html b/docs/dyn/firebaseappcheck_v1beta.projects.apps.safetyNetConfig.html new file mode 100644 index 00000000000..5993db891ef --- /dev/null +++ b/docs/dyn/firebaseappcheck_v1beta.projects.apps.safetyNetConfig.html @@ -0,0 +1,169 @@ + + + +

Firebase App Check API . projects . apps . safetyNetConfig

+

Instance Methods

+

+ batchGet(parent, names=None, x__xgafv=None)

+

Gets the SafetyNetConfigs for the specified list of apps atomically.

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets the SafetyNetConfig for the specified app.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the SafetyNetConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange SafetyNet tokens for App Check tokens.

+

Method Details

+
+ batchGet(parent, names=None, x__xgafv=None) + 
Gets the SafetyNetConfigs for the specified list of apps atomically.
+
+Args:
+  parent: string, Required. The parent project name shared by all SafetyNetConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails. (required)
+  names: string, Required. The relative resource names of the SafetyNetConfigs to retrieve, in the format ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ``` A maximum of 100 objects can be retrieved in a batch. (repeated)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the BatchGetSafetyNetConfigs method.
+  "configs": [ # SafetyNetConfigs retrieved.
+    { # An app's SafetyNet configuration object. This configuration controls certain properties of the App Check token returned by ExchangeSafetyNetToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by SafetyNet; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).
+      "name": "A String", # Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```
+      "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from SafetyNet tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+    },
+  ],
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) + 
Gets the SafetyNetConfig for the specified app.
+
+Args:
+  name: string, Required. The relative resource name of the SafetyNetConfig, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ``` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An app's SafetyNet configuration object. This configuration controls certain properties of the App Check token returned by ExchangeSafetyNetToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by SafetyNet; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).
+  "name": "A String", # Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```
+  "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from SafetyNet tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+}
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates the SafetyNetConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange SafetyNet tokens for App Check tokens.
+
+Args:
+  name: string, Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ``` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An app's SafetyNet configuration object. This configuration controls certain properties of the App Check token returned by ExchangeSafetyNetToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by SafetyNet; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).
+  "name": "A String", # Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```
+  "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from SafetyNet tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+}
+
+  updateMask: string, Required. A comma-separated list of names of fields in the SafetyNetConfig Gets to update. Example: `token_ttl`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An app's SafetyNet configuration object. This configuration controls certain properties of the App Check token returned by ExchangeSafetyNetToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by SafetyNet; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).
+  "name": "A String", # Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```
+  "tokenTtl": "A String", # Specifies the duration for which App Check tokens exchanged from SafetyNet tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json index 394e66a5182..882260e8cfa 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json @@ -376,6 +376,103 @@ } }, "resources": { + "appAttestConfig": { + "methods": { + "batchGet": { + "description": "Gets the AppAttestConfigs for the specified list of apps atomically.", + "flatPath": "v1beta/projects/{projectsId}/apps/-/appAttestConfig:batchGet", + "httpMethod": "GET", + "id": "firebaseappcheck.projects.apps.appAttestConfig.batchGet", + "parameterOrder": [ + "parent" + ], + "parameters": { + "names": { + "description": "Required. The relative resource names of the AppAttestConfigs to retrieve, in the format ``` projects/{project_number}/apps/{app_id}/appAttestConfig ``` A maximum of 100 objects can be retrieved in a batch.", + "location": "query", + "repeated": true, + "type": "string" + }, + "parent": { + "description": "Required. The parent project name shared by all AppAttestConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/apps/-/appAttestConfig:batchGet", + "response": { + "$ref": "GoogleFirebaseAppcheckV1betaBatchGetAppAttestConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "get": { + "description": "Gets the AppAttestConfig for the specified app.", + "flatPath": "v1beta/projects/{projectsId}/apps/{appsId}/appAttestConfig", + "httpMethod": "GET", + "id": "firebaseappcheck.projects.apps.appAttestConfig.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of the AppAttestConfig, in the format: ``` projects/{project_number}/apps/{app_id}/appAttestConfig ```", + "location": "path", + "pattern": "^projects/[^/]+/apps/[^/]+/appAttestConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleFirebaseAppcheckV1betaAppAttestConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "patch": { + "description": "Updates the AppAttestConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange AppAttest tokens for App Check tokens.", + "flatPath": "v1beta/projects/{projectsId}/apps/{appsId}/appAttestConfig", + "httpMethod": "PATCH", + "id": "firebaseappcheck.projects.apps.appAttestConfig.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of the App Attest configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/appAttestConfig ```", + "location": "path", + "pattern": "^projects/[^/]+/apps/[^/]+/appAttestConfig$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. A comma-separated list of names of fields in the AppAttestConfig Gets to update. Example: `token_ttl`.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleFirebaseAppcheckV1betaAppAttestConfig" + }, + "response": { + "$ref": "GoogleFirebaseAppcheckV1betaAppAttestConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + } + } + }, "debugTokens": { "methods": { "create": { @@ -726,6 +823,103 @@ ] } } + }, + "safetyNetConfig": { + "methods": { + "batchGet": { + "description": "Gets the SafetyNetConfigs for the specified list of apps atomically.", + "flatPath": "v1beta/projects/{projectsId}/apps/-/safetyNetConfig:batchGet", + "httpMethod": "GET", + "id": "firebaseappcheck.projects.apps.safetyNetConfig.batchGet", + "parameterOrder": [ + "parent" + ], + "parameters": { + "names": { + "description": "Required. The relative resource names of the SafetyNetConfigs to retrieve, in the format ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ``` A maximum of 100 objects can be retrieved in a batch.", + "location": "query", + "repeated": true, + "type": "string" + }, + "parent": { + "description": "Required. The parent project name shared by all SafetyNetConfigs being retrieved, in the format ``` projects/{project_number} ``` The parent collection in the `name` field of any resource being retrieved must match this field, or the entire batch fails.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/apps/-/safetyNetConfig:batchGet", + "response": { + "$ref": "GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "get": { + "description": "Gets the SafetyNetConfig for the specified app.", + "flatPath": "v1beta/projects/{projectsId}/apps/{appsId}/safetyNetConfig", + "httpMethod": "GET", + "id": "firebaseappcheck.projects.apps.safetyNetConfig.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of the SafetyNetConfig, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```", + "location": "path", + "pattern": "^projects/[^/]+/apps/[^/]+/safetyNetConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleFirebaseAppcheckV1betaSafetyNetConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "patch": { + "description": "Updates the SafetyNetConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange SafetyNet tokens for App Check tokens.", + "flatPath": "v1beta/projects/{projectsId}/apps/{appsId}/safetyNetConfig", + "httpMethod": "PATCH", + "id": "firebaseappcheck.projects.apps.safetyNetConfig.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```", + "location": "path", + "pattern": "^projects/[^/]+/apps/[^/]+/safetyNetConfig$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. A comma-separated list of names of fields in the SafetyNetConfig Gets to update. Example: `token_ttl`.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleFirebaseAppcheckV1betaSafetyNetConfig" + }, + "response": { + "$ref": "GoogleFirebaseAppcheckV1betaSafetyNetConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + } + } } } }, @@ -863,7 +1057,7 @@ } } }, - "revision": "20210709", + "revision": "20210712", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1betaAppAttestChallengeResponse": { @@ -883,6 +1077,22 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1betaAppAttestConfig": { + "description": "An app's App Attest configuration object. This configuration controls certain properties of the App Check token returned by ExchangeAppAttestAttestation and ExchangeAppAttestAttestation, such as its ttl. Note that the Team ID registered with your app is used as part of the validation process. Please register it via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.iosApps/patch).", + "id": "GoogleFirebaseAppcheckV1betaAppAttestConfig", + "properties": { + "name": { + "description": "Required. The relative resource name of the App Attest configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/appAttestConfig ```", + "type": "string" + }, + "tokenTtl": { + "description": "Specifies the duration for which App Check tokens exchanged from App Attest artifacts will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1betaAttestationTokenResponse": { "description": "Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check.", "id": "GoogleFirebaseAppcheckV1betaAttestationTokenResponse", @@ -899,6 +1109,20 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1betaBatchGetAppAttestConfigsResponse": { + "description": "Response message for the BatchGetAppAttestConfigs method.", + "id": "GoogleFirebaseAppcheckV1betaBatchGetAppAttestConfigsResponse", + "properties": { + "configs": { + "description": "AppAttestConfigs retrieved.", + "items": { + "$ref": "GoogleFirebaseAppcheckV1betaAppAttestConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1betaBatchGetDeviceCheckConfigsResponse": { "description": "Response message for the BatchGetDeviceCheckConfigs method.", "id": "GoogleFirebaseAppcheckV1betaBatchGetDeviceCheckConfigsResponse", @@ -927,6 +1151,20 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse": { + "description": "Response message for the BatchGetSafetyNetConfigs method.", + "id": "GoogleFirebaseAppcheckV1betaBatchGetSafetyNetConfigsResponse", + "properties": { + "configs": { + "description": "SafetyNetConfigs retrieved.", + "items": { + "$ref": "GoogleFirebaseAppcheckV1betaSafetyNetConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest": { "description": "Request message for the BatchUpdateServices method.", "id": "GoogleFirebaseAppcheckV1betaBatchUpdateServicesRequest", @@ -999,6 +1237,11 @@ "description": "Output only. Whether the `private_key` field was previously set. Since we will never return the `private_key` field, this field is the only way to find out whether it was previously set.", "readOnly": true, "type": "boolean" + }, + "tokenTtl": { + "description": "Specifies the duration for which App Check tokens exchanged from DeviceCheck tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.", + "format": "google-duration", + "type": "string" } }, "type": "object" @@ -1221,6 +1464,27 @@ "description": "Output only. Whether the `site_secret` field was previously set. Since we will never return the `site_secret` field, this field is the only way to find out whether it was previously set.", "readOnly": true, "type": "boolean" + }, + "tokenTtl": { + "description": "Specifies the duration for which App Check tokens exchanged from reCAPTCHA tokens will be valid. If unset, a default value of 1 day is assumed. Must be between 30 minutes and 7 days, inclusive.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GoogleFirebaseAppcheckV1betaSafetyNetConfig": { + "description": "An app's SafetyNet configuration object. This configuration controls certain properties of the App Check token returned by ExchangeSafetyNetToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by SafetyNet; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).", + "id": "GoogleFirebaseAppcheckV1betaSafetyNetConfig", + "properties": { + "name": { + "description": "Required. The relative resource name of the SafetyNet configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/safetyNetConfig ```", + "type": "string" + }, + "tokenTtl": { + "description": "Specifies the duration for which App Check tokens exchanged from SafetyNet tokens will be valid. If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.", + "format": "google-duration", + "type": "string" } }, "type": "object"