Method: projects.verifyAppCheckToken

驗證指定的 App Check 權杖,並傳回呼叫端可採取行動的權杖使用信號。這個方法目前僅支援由下列認證提供者交換的 App Check 權杖:

  • Play Integrity API
  • App Attest
  • DeviceCheck ( DCDevice 個符記)
  • reCAPTCHA Enterprise
  • reCAPTCHA v3
  • 自訂提供者

系統也支援透過偵錯密鑰交換 App Check 權杖。針對內含不支援的供應商的其他有效 App Check 權杖呼叫此方法,系統就會傳回 HTTP 400 錯誤。

傳回此呼叫先前是否已取用此權杖。如果這是第一次看到指定 App Check 權杖,則回應中的 alreadyConsumed 欄位不會顯示。這樣一來,指定權杖就會標示為 alreadyConsumed (設為 true ),供該權杖日後使用此方法的所有叫用作業。

請注意,如果指定的 App Check 權杖無效,無論權杖是否已使用,系統都會傳回 HTTP 403 錯誤,而非回應物件。

目前,在評估是否已使用 App Check 權杖時,系統只會計入對這個方法發出的呼叫。如果您在其他地方使用 App Check 權杖,則系統不會將該權杖標示為已使用。

呼叫端必須擁有 firebaseappcheck.appCheckTokens.verify 權限才能呼叫這個方法。這項權限是 Firebase App Check 權杖驗證者角色 的一部分。

HTTP 要求

POST https://firebaseappcheck.googleapis.com/v1beta/{project=projects/*}:verifyAppCheckToken

這個網址使用 gRPC 轉碼 語法。

路徑參數

參數
project

string

必要欄位。產生憑證的專案相對資源名稱,格式為:

projects/{project_number}

如有需要,您可以將 project_number 元素替換為 Firebase 專案的專案 ID。請參閱 Google 的 AIP 2510 標準,進一步瞭解如何使用專案 ID。

要求主體

要求主體會包含結構如下的資料:

JSON 表示法
{
  "appCheckToken": string
}
欄位
appCheckToken

string

必要欄位。要驗證的 App Check 權杖。

系統不支援透過 SafetyNet 供應商交換的 App Check 權杖,會傳回 HTTP 400 錯誤。

回應主體

projects.verifyAppCheckToken 方法的回應訊息。

如果成功,回應主體會包含結構如下的資料:

JSON 表示法
{
  "alreadyConsumed": boolean
}
欄位
alreadyConsumed

boolean

這個權杖是否已使用。

如果這是第一次看到指定 App Check 權杖,則回應會省略這個欄位。這樣一來,指定權杖就會標示為 alreadyConsumed (設為 true ),供該權杖日後使用此方法的所有叫用作業。

請注意,如果指定的 App Check 權杖無效,系統會傳回 HTTP 403 錯誤,而非包含這個欄位的回應,無論權杖是否已取用為何。

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/firebase

詳情請參閱 驗證總覽