Skip to main content

device_check_config

Overview

Namedevice_check_config
TypeResource
Idfirebase.firebaseappcheck.device_check_config

Fields

NameDatatypeDescription
namestringRequired. The relative resource name of the DeviceCheck configuration object, in the format: projects/{project_number}/apps/{app_id}/deviceCheckConfig
tokenTtlstringSpecifies 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.
keyIdstringRequired. The key identifier of a private key enabled with DeviceCheck, created in your Apple Developer account.
privateKeystringRequired. 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.
privateKeySetbooleanOutput 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.

Methods

NameAccessible byRequired ParamsDescription
projects_apps_deviceCheckConfig_getSELECTappsId, projectsIdGets the DeviceCheckConfig for the specified app. For security reasons, the private_key field is never populated in the response.
projects_apps_deviceCheckConfig_batchGetEXECprojectsIdAtomically gets the DeviceCheckConfigs for the specified list of apps. For security reasons, the private_key field is never populated in the response.
projects_apps_deviceCheckConfig_patchEXECappsId, projectsIdUpdates the DeviceCheckConfig for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange DeviceCheck tokens for App Check tokens. For security reasons, the private_key field is never populated in the response.