-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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)
- Loading branch information
1 parent
fbc224e
commit f8c3901
Showing
6 changed files
with
621 additions
and
1 deletion.
There are no files selected for viewing
169 changes: 169 additions & 0 deletions
169
docs/dyn/firebaseappcheck_v1beta.projects.apps.appAttestConfig.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| <html><body> | ||
| <style> | ||
|
|
||
| body, h1, h2, h3, div, span, p, pre, a { | ||
| margin: 0; | ||
| padding: 0; | ||
| border: 0; | ||
| font-weight: inherit; | ||
| font-style: inherit; | ||
| font-size: 100%; | ||
| font-family: inherit; | ||
| vertical-align: baseline; | ||
| } | ||
|
|
||
| body { | ||
| font-size: 13px; | ||
| padding: 1em; | ||
| } | ||
|
|
||
| h1 { | ||
| font-size: 26px; | ||
| margin-bottom: 1em; | ||
| } | ||
|
|
||
| h2 { | ||
| font-size: 24px; | ||
| margin-bottom: 1em; | ||
| } | ||
|
|
||
| h3 { | ||
| font-size: 20px; | ||
| margin-bottom: 1em; | ||
| margin-top: 1em; | ||
| } | ||
|
|
||
| pre, code { | ||
| line-height: 1.5; | ||
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | ||
| } | ||
|
|
||
| pre { | ||
| margin-top: 0.5em; | ||
| } | ||
|
|
||
| h1, h2, h3, p { | ||
| font-family: Arial, sans serif; | ||
| } | ||
|
|
||
| h1, h2, h3 { | ||
| border-bottom: solid #CCC 1px; | ||
| } | ||
|
|
||
| .toc_element { | ||
| margin-top: 0.5em; | ||
| } | ||
|
|
||
| .firstline { | ||
| margin-left: 2 em; | ||
| } | ||
|
|
||
| .method { | ||
| margin-top: 1em; | ||
| border: solid 1px #CCC; | ||
| padding: 1em; | ||
| background: #EEE; | ||
| } | ||
|
|
||
| .details { | ||
| font-weight: bold; | ||
| font-size: 14px; | ||
| } | ||
|
|
||
| </style> | ||
|
|
||
| <h1><a href="firebaseappcheck_v1beta.html">Firebase App Check API</a> . <a href="firebaseappcheck_v1beta.projects.html">projects</a> . <a href="firebaseappcheck_v1beta.projects.apps.html">apps</a> . <a href="firebaseappcheck_v1beta.projects.apps.appAttestConfig.html">appAttestConfig</a></h1> | ||
| <h2>Instance Methods</h2> | ||
| <p class="toc_element"> | ||
| <code><a href="#batchGet">batchGet(parent, names=None, x__xgafv=None)</a></code></p> | ||
| <p class="firstline">Gets the AppAttestConfigs for the specified list of apps atomically.</p> | ||
| <p class="toc_element"> | ||
| <code><a href="#close">close()</a></code></p> | ||
| <p class="firstline">Close httplib2 connections.</p> | ||
| <p class="toc_element"> | ||
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> | ||
| <p class="firstline">Gets the AppAttestConfig for the specified app.</p> | ||
| <p class="toc_element"> | ||
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> | ||
| <p class="firstline">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.</p> | ||
| <h3>Method Details</h3> | ||
| <div class="method"> | ||
| <code class="details" id="batchGet">batchGet(parent, names=None, x__xgafv=None)</code> | ||
| <pre>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. | ||
| }, | ||
| ], | ||
| }</pre> | ||
| </div> | ||
|
|
||
| <div class="method"> | ||
| <code class="details" id="close">close()</code> | ||
| <pre>Close httplib2 connections.</pre> | ||
| </div> | ||
|
|
||
| <div class="method"> | ||
| <code class="details" id="get">get(name, x__xgafv=None)</code> | ||
| <pre>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. | ||
| }</pre> | ||
| </div> | ||
|
|
||
| <div class="method"> | ||
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> | ||
| <pre>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. | ||
| }</pre> | ||
| </div> | ||
|
|
||
| </body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.