REST Resource: projects.apps.deviceCheckConfig
Stay organized with collections
Save and categorize content based on your preferences.
Resource: DeviceCheckConfig
An app's DeviceCheck configuration object. This configuration is used by ExchangeDeviceCheckToken to validate device tokens issued to apps by DeviceCheck. It also controls certain properties of the returned AppCheckTokenttl.
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.
| JSON representation |
{
"name": string,
"tokenTtl": string,
"keyId": string,
"privateKey": string,
"privateKeySet": boolean
} |
| Fields |
name |
string
Required. The relative resource name of the DeviceCheck configuration object, in the format:
projects/{project_number}/apps/{app_id}/deviceCheckConfig
|
tokenTtl |
string (Duration format)
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. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
|
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 keyId. For security reasons, this field will never be populated in any response.
|
privateKeySet |
boolean
Output only. Whether the privateKey field was previously set. Since we will never return the privateKey field, this field is the only way to find out whether it was previously set.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-04-05 UTC.
[null,null,["Last updated 2024-04-05 UTC."],[],[],null,["# REST Resource: projects.apps.deviceCheckConfig\n\nResource: DeviceCheckConfig\n---------------------------\n\nAn app's DeviceCheck configuration object. This configuration is used by [ExchangeDeviceCheckToken](/docs/reference/appcheck/rest/v1beta/projects.apps/exchangeDeviceCheckToken#google.firebase.appcheck.v1beta.TokenExchangeService.ExchangeDeviceCheckToken) to validate device tokens issued to apps by DeviceCheck. It also controls certain properties of the returned [`AppCheckToken`](/docs/reference/appcheck/rest/v1beta/AppCheckToken), such as its [ttl](/docs/reference/appcheck/rest/v1beta/AppCheckToken#FIELDS.ttl).\n\nNote 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).\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"tokenTtl\": string, \"keyId\": string, \"privateKey\": string, \"privateKeySet\": boolean } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The relative resource name of the DeviceCheck configuration object, in the format: projects/{project_number}/apps/{app_id}/deviceCheckConfig |\n| `tokenTtl` | `string (`[Duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration)` format)` 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. A duration in seconds with up to nine fractional digits, ending with '`s`'. Example: `\"3.5s\"`. |\n| `keyId` | `string` Required. The key identifier of a private key enabled with DeviceCheck, created in your Apple Developer account. |\n| `privateKey` | `string` Required. Input only. The contents of the private key (`.p8`) file associated with the key specified by `keyId`. For security reasons, this field will never be populated in any response. |\n| `privateKeySet` | `boolean` Output only. Whether the `privateKey` field was previously set. Since we will never return the `privateKey` field, this field is the only way to find out whether it was previously set. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### [batchGet](/docs/reference/appcheck/rest/v1beta/projects.apps.deviceCheckConfig/batchGet) | Atomically gets the [DeviceCheckConfig](/docs/reference/appcheck/rest/v1beta/projects.apps.deviceCheckConfig#DeviceCheckConfig)s for the specified list of apps. |\n| ### [get](/docs/reference/appcheck/rest/v1beta/projects.apps.deviceCheckConfig/get) | Gets the [DeviceCheckConfig](/docs/reference/appcheck/rest/v1beta/projects.apps.deviceCheckConfig#DeviceCheckConfig) for the specified app. |\n| ### [patch](/docs/reference/appcheck/rest/v1beta/projects.apps.deviceCheckConfig/patch) | Updates the [DeviceCheckConfig](/docs/reference/appcheck/rest/v1beta/projects.apps.deviceCheckConfig#DeviceCheckConfig) for the specified app. |"]]
