device_check_config
Overview
Name | device_check_config |
Type | Resource |
Id | firebase.firebaseappcheck.device_check_config |
Fields
Name | Datatype | Description |
---|---|---|
name | string | Required. The relative resource name of the DeviceCheck configuration object, in the format: projects/{project_number}/apps/{app_id}/deviceCheckConfig |
keyId | string | Required. The key identifier of a private key enabled with DeviceCheck, created in your Apple Developer account. |
privateKey | 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 | boolean | 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 | 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. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
projects_apps_deviceCheckConfig_get | SELECT | appsId, projectsId | Gets the DeviceCheckConfig for the specified app. For security reasons, the private_key field is never populated in the response. |
projects_apps_deviceCheckConfig_batchGet | EXEC | projectsId | Atomically 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_patch | EXEC | appsId, projectsId | Updates 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. |