app_attest_config
Creates, updates, deletes, gets or lists an app_attest_config resource.
Overview
| Name | app_attest_config |
| Type | Resource |
| Id | firebase.appcheck.app_attest_config |
Fields
The following fields are returned by SELECT queries:
- get
- batch_get
Successful response
| Name | Datatype | Description |
|---|---|---|
name | string | Required. The relative resource name of the App Attest configuration object, in the format: projects/{project_number}/apps/{app_id}/appAttestConfig |
tokenTtl | string (google-duration) | 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. |
Successful response
| Name | Datatype | Description |
|---|---|---|
configs | array | AppAttestConfigs retrieved. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | projectsId, appsId | Gets the AppAttestConfig for the specified app. | |
batch_get | select | projectsId | names | Atomically gets the AppAttestConfigs for the specified list of apps. |
patch | update | projectsId, appsId | updateMask | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
appsId | string | |
projectsId | string | |
names | string | |
updateMask | string (google-fieldmask) |
SELECT examples
- get
- batch_get
Gets the AppAttestConfig for the specified app.
SELECT
name,
tokenTtl
FROM firebase.appcheck.app_attest_config
WHERE projectsId = '{{ projectsId }}' -- required
AND appsId = '{{ appsId }}' -- required;
Atomically gets the AppAttestConfigs for the specified list of apps.
SELECT
configs
FROM firebase.appcheck.app_attest_config
WHERE projectsId = '{{ projectsId }}' -- required
AND names = '{{ names }}';
UPDATE examples
- patch
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.
UPDATE firebase.appcheck.app_attest_config
SET
data__name = '{{ name }}',
data__tokenTtl = '{{ tokenTtl }}'
WHERE
projectsId = '{{ projectsId }}' --required
AND appsId = '{{ appsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
tokenTtl;