REST Resource: projects.apps.deviceCheckConfig

リソース: DeviceCheckConfig

アプリの DeviceCheck 構成オブジェクト。この構成は、DeviceCheck によってアプリに発行されたデバイス トークンを検証するために、ExchangeDeviceCheckToken によって使用されます。また、返される AppCheckToken の特定のプロパティ(ttl など)も制御します。

アプリに登録されたチーム ID は検証プロセスの一環として使用されます。Firebase コンソールから、または Firebase Management Service からプログラムによって登録してください。

JSON 表現
{
  "name": string,
  "tokenTtl": string,
  "keyId": string,
  "privateKey": string,
  "privateKeySet": boolean
}
フィールド
name

string

必須。DeviceCheck 構成オブジェクトの相対リソース名。形式は次のとおりです。

projects/{project_number}/apps/{app_id}/deviceCheckConfig
tokenTtl

string (Duration format)

DeviceCheck トークンから交換された App Check トークンの有効期間を指定します。設定しない場合、デフォルト値の 1 時間が使用されます。30 分~ 7 日の範囲で指定してください。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

keyId

string

必須。DeviceCheck で有効になっている秘密鍵の鍵識別子。Apple Developer アカウントで作成されています。

privateKey

string

必須。入力のみのkeyId で指定された鍵に関連付けられている秘密鍵(.p8)ファイルの内容。

セキュリティ上の理由から、このフィールドはどのレスポンスでも入力されません。

privateKeySet

boolean

出力専用。privateKey フィールドが以前に設定されているかどうか。privateKey フィールドは返されないため、以前に設定済みかどうかを確認するには、このフィールドが唯一の方法です。

メソッド

batchGet

指定されたアプリリストの DeviceCheckConfig をアトミックに取得します。

get

指定されたアプリの DeviceCheckConfig を取得します。

patch

指定したアプリの DeviceCheckConfig を更新します。