GoogleFirebaseAppcheckV1DeviceCheckConfig

import type { GoogleFirebaseAppcheckV1DeviceCheckConfig } from "https://googleapis.deno.dev/v1/firebaseappcheck:v1.ts";

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 AppCheckToken, 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.

interface GoogleFirebaseAppcheckV1DeviceCheckConfig {

keyId?: string;

name?: string;

privateKey?: string;

readonly privateKeySet?: boolean;

tokenTtl?: number;

}

§Properties

keyId?: string

[src]

Required. The key identifier of a private key enabled with DeviceCheck, created in your Apple Developer account.

name?: string

[src]

Required. The relative resource name of the DeviceCheck configuration object, in the format: projects/{project_number}/apps/{app_id}/deviceCheckConfig

privateKey?: string

[src]

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.

readonly privateKeySet?: boolean

[src]

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?: number

[src]

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.