Firebase App Check API

Firebase App Check จะทำงานร่วมกับบริการอื่นๆ ของ Firebase เพื่อช่วยปกป้องทรัพยากรแบ็กเอนด์ของคุณจากการละเมิด เช่น การฉ้อโกงผ่านการเรียกเก็บเงินหรือฟิชชิง

บริการ: firebaseappcheck.googleapis.com

หากต้องการเรียกใช้บริการนี้ เราขอแนะนำให้ใช้ไลบรารีของไคลเอ็นต์ที่ Google มีให้ หากแอปพลิเคชันของคุณจำเป็นต้องใช้ไลบรารีของคุณเองเพื่อเรียกใช้บริการนี้ ให้ใช้ข้อมูลต่อไปนี้เมื่อคุณส่งคำขอ API

เอกสารการค้นพบ

เอกสารการค้นพบเป็นข้อกำหนดที่เครื่องอ่านได้เพื่ออธิบายและใช้ REST API ใช้สำหรับสร้างไลบรารีไคลเอ็นต์, ปลั๊กอิน IDE และเครื่องมืออื่นๆ ที่โต้ตอบกับ Google APIs บริการเดียวอาจมีเอกสารการค้นพบหลายรายการ บริการนี้มีเอกสารการค้นพบต่อไปนี้

ปลายทางบริการ

ปลายทางของบริการคือ URL พื้นฐานที่ระบุที่อยู่เครือข่ายของบริการ API บริการหนึ่งอาจมีปลายทางบริการหลายจุด บริการนี้มีปลายทางบริการต่อไปนี้และ URI ด้านล่างทั้งหมดเกี่ยวข้องกับปลายทางของบริการนี้

  • https://firebaseappcheck.googleapis.com

ทรัพยากร REST: v1beta.jwks

วิธีการ
get GET /v1beta/{name}
แสดงผล JWK สาธารณะที่ตั้งค่าโดย RFC 7517 ซึ่งใช้เพื่อยืนยันโทเค็น App Check ได้

ทรัพยากร REST: v1beta.oauthClients

วิธีการ
exchangeAppAttestAssertion POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAssertion
ยอมรับการยืนยัน App Attest และอาร์ติแฟกต์ที่ได้รับจาก ExchangeAppAttestAttestation ก่อนหน้านี้และยืนยันกับ Apple
exchangeAppAttestAttestation POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAttestation
ยอมรับเอกสารรับรอง CBOR สำหรับ App Attest และยืนยันกับ Apple โดยใช้รหัสทีมและรหัสชุดที่กำหนดค่าไว้ล่วงหน้า
exchangeDebugToken POST /v1beta/{app=oauthClients/*}:exchangeDebugToken
ตรวจสอบข้อมูลลับของโทเค็นการแก้ไขข้อบกพร่องที่คุณสร้างไว้ก่อนหน้านี้โดยใช้ CreateDebugToken
generateAppAttestChallenge POST /v1beta/{app=oauthClients/*}:generateAppAttestChallenge
สร้างความท้าทายที่จะปกป้องความสมบูรณ์ของการเรียกใช้ทันทีหลังจากโทรหา ExchangeAppAttestAttestation หรือ ExchangeAppAttestAssertion

ทรัพยากร REST: v1beta.projects

วิธีการ
verifyAppCheckToken POST /v1beta/{project=projects/*}:verifyAppCheckToken
ยืนยันโทเค็น App Check ที่ระบุและแสดงผลสัญญาณการใช้งานโทเค็นที่ผู้โทรอาจดำเนินการ

ทรัพยากร REST: v1beta.projects.apps

วิธีการ
exchangeAppAttestAssertion POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAssertion
ยอมรับการยืนยัน App Attest และอาร์ติแฟกต์ที่ได้รับจาก ExchangeAppAttestAttestation ก่อนหน้านี้และยืนยันกับ Apple
exchangeAppAttestAttestation POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAttestation
ยอมรับเอกสารรับรอง CBOR สำหรับ App Attest และยืนยันกับ Apple โดยใช้รหัสทีมและรหัสชุดที่กำหนดค่าไว้ล่วงหน้า
exchangeCustomToken POST /v1beta/{app=projects/*/apps/*}:exchangeCustomToken
ตรวจสอบโทเค็นที่กำหนดเองซึ่งลงนามโดยใช้ข้อมูลเข้าสู่ระบบบัญชีบริการ Admin SDK ของโปรเจ็กต์
exchangeDebugToken POST /v1beta/{app=projects/*/apps/*}:exchangeDebugToken
ตรวจสอบข้อมูลลับของโทเค็นการแก้ไขข้อบกพร่องที่คุณสร้างไว้ก่อนหน้านี้โดยใช้ CreateDebugToken
exchangeDeviceCheckToken POST /v1beta/{app=projects/*/apps/*}:exchangeDeviceCheckToken
ยอมรับ device_token ที่ออกโดย DeviceCheck และพยายามตรวจสอบกับ Apple
exchangePlayIntegrityToken POST /v1beta/{app=projects/*/apps/*}:exchangePlayIntegrityToken
ตรวจสอบโทเค็นการตอบกลับคำตัดสินความสมบูรณ์จาก Play Integrity
exchangeRecaptchaEnterpriseToken POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
ตรวจสอบโทเค็นการตอบกลับ reCAPTCHA Enterprise
exchangeRecaptchaToken
(deprecated)		 POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaToken
ตรวจสอบโทเค็นการตอบกลับ reCAPTCHA v3
exchangeRecaptchaV3Token POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaV3Token
ตรวจสอบโทเค็นการตอบกลับ reCAPTCHA v3
exchangeSafetyNetToken
(deprecated)		 POST /v1beta/{app=projects/*/apps/*}:exchangeSafetyNetToken
ตรวจสอบโทเค็น SafetyNet
generateAppAttestChallenge POST /v1beta/{app=projects/*/apps/*}:generateAppAttestChallenge
สร้างความท้าทายที่จะปกป้องความสมบูรณ์ของการเรียกใช้ทันทีหลังจากโทรหา ExchangeAppAttestAttestation หรือ ExchangeAppAttestAssertion
generatePlayIntegrityChallenge POST /v1beta/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
สร้างความท้าทายที่จะปกป้องความสมบูรณ์ของคำขอการตัดสินความสมบูรณ์ที่ส่งไปยัง Play Integrity API โดยทันที

ทรัพยากร REST: v1beta.projects.apps.appAttestConfig

วิธีการ
batchGet GET /v1beta/{parent=projects/*}/apps/-/appAttestConfig:batchGet
ได้รับ AppAttestConfig สำหรับรายการแอปที่ระบุโดยเฉพาะ
get GET /v1beta/{name=projects/*/apps/*/appAttestConfig}
รับ AppAttestConfig สำหรับแอปที่ระบุ
patch PATCH /v1beta/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
อัปเดต AppAttestConfig สำหรับแอปที่ระบุ

ทรัพยากร REST: v1beta.projects.apps.debugTokens

วิธีการ
create POST /v1beta/{parent=projects/*/apps/*}/debugTokens
สร้าง DebugToken ใหม่สำหรับแอปที่ระบุ
delete DELETE /v1beta/{name=projects/*/apps/*/debugTokens/*}
ลบ DebugToken ที่ระบุ
get GET /v1beta/{name=projects/*/apps/*/debugTokens/*}
รับ DebugToken ที่ระบุ
list GET /v1beta/{parent=projects/*/apps/*}/debugTokens
แสดงรายการ DebugToken ทั้งหมดสำหรับแอปที่ระบุ
patch PATCH /v1beta/{debugToken.name=projects/*/apps/*/debugTokens/*}
อัปเดต DebugToken ที่ระบุ

ทรัพยากร REST: v1beta.projects.apps.deviceCheckConfig

วิธีการ
batchGet GET /v1beta/{parent=projects/*}/apps/-/deviceCheckConfig:batchGet
ได้รับ DeviceCheckConfig สำหรับรายการแอปที่ระบุโดยเฉพาะ
get GET /v1beta/{name=projects/*/apps/*/deviceCheckConfig}
รับ DeviceCheckConfig สำหรับแอปที่ระบุ
patch PATCH /v1beta/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
อัปเดต DeviceCheckConfig สำหรับแอปที่ระบุ

ทรัพยากร REST: v1beta.projects.apps.playIntegrityConfig

วิธีการ
batchGet GET /v1beta/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
ได้รับ PlayIntegrityConfig สำหรับรายการแอปที่ระบุโดยเฉพาะ
get GET /v1beta/{name=projects/*/apps/*/playIntegrityConfig}
รับ PlayIntegrityConfig สำหรับแอปที่ระบุ
patch PATCH /v1beta/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
อัปเดต PlayIntegrityConfig สำหรับแอปที่ระบุ

ทรัพยากร REST: v1beta.projects.apps.recaptchaConfig

วิธีการ
batchGet
(deprecated)		 GET /v1beta/{parent=projects/*}/apps/-/recaptchaConfig:batchGet
ได้รับ RecaptchaConfig สำหรับรายการแอปที่ระบุโดยเฉพาะ
get
(deprecated)		 GET /v1beta/{name=projects/*/apps/*/recaptchaConfig}
รับ RecaptchaConfig สำหรับแอปที่ระบุ
patch
(deprecated)		 PATCH /v1beta/{recaptchaConfig.name=projects/*/apps/*/recaptchaConfig}
อัปเดต RecaptchaConfig สำหรับแอปที่ระบุ

ทรัพยากร REST: v1beta.projects.apps.recaptchaEnterpriseConfig

วิธีการ
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
ได้รับ RecaptchaEnterpriseConfig สำหรับรายการแอปที่ระบุโดยเฉพาะ
get GET /v1beta/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
รับ RecaptchaEnterpriseConfig สำหรับแอปที่ระบุ
patch PATCH /v1beta/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
อัปเดต RecaptchaEnterpriseConfig สำหรับแอปที่ระบุ

ทรัพยากร REST: v1beta.projects.apps.recaptchaV3Config

วิธีการ
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
ได้รับ RecaptchaV3Config สำหรับรายการแอปที่ระบุโดยเฉพาะ
get GET /v1beta/{name=projects/*/apps/*/recaptchaV3Config}
รับ RecaptchaV3Config สำหรับแอปที่ระบุ
patch PATCH /v1beta/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
อัปเดต RecaptchaV3Config สำหรับแอปที่ระบุ

ทรัพยากร REST: v1beta.projects.apps.safetyNetConfig

วิธีการ
batchGet
(deprecated)		 GET /v1beta/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
ได้รับ SafetyNetConfig สำหรับรายการแอปที่ระบุโดยเฉพาะ
get
(deprecated)		 GET /v1beta/{name=projects/*/apps/*/safetyNetConfig}
รับ SafetyNetConfig สำหรับแอปที่ระบุ
patch
(deprecated)		 PATCH /v1beta/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
อัปเดต SafetyNetConfig สำหรับแอปที่ระบุ

ทรัพยากร REST: v1beta.projects.services

วิธีการ
batchUpdate POST /v1beta/{parent=projects/*}/services:batchUpdate
อัปเดตการกำหนดค่า Service ที่ระบุโดยอัตโนมัติ
get GET /v1beta/{name=projects/*/services/*}
รับการกำหนดค่า Service สำหรับชื่อบริการที่ระบุ
list GET /v1beta/{parent=projects/*}/services
แสดงการกำหนดค่า Service ทั้งหมดสำหรับโปรเจ็กต์ที่ระบุ
patch PATCH /v1beta/{service.name=projects/*/services/*}
อัปเดตการกำหนดค่า Service ที่ระบุ

ทรัพยากร REST: v1.jwks

วิธีการ
get GET /v1/{name}
แสดงผล JWK สาธารณะที่ตั้งค่าโดย RFC 7517 ซึ่งใช้เพื่อยืนยันโทเค็น App Check ได้

ทรัพยากร REST: v1.projects.apps

วิธีการ
exchangeAppAttestAssertion POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAssertion
ยอมรับการยืนยัน App Attest และอาร์ติแฟกต์ที่ได้รับจาก ExchangeAppAttestAttestation ก่อนหน้านี้และยืนยันกับ Apple
exchangeAppAttestAttestation POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAttestation
ยอมรับเอกสารรับรอง CBOR สำหรับ App Attest และยืนยันกับ Apple โดยใช้รหัสทีมและรหัสชุดที่กำหนดค่าไว้ล่วงหน้า
exchangeCustomToken POST /v1/{app=projects/*/apps/*}:exchangeCustomToken
ตรวจสอบโทเค็นที่กำหนดเองซึ่งลงนามโดยใช้ข้อมูลเข้าสู่ระบบบัญชีบริการ Admin SDK ของโปรเจ็กต์
exchangeDebugToken POST /v1/{app=projects/*/apps/*}:exchangeDebugToken
ตรวจสอบข้อมูลลับของโทเค็นการแก้ไขข้อบกพร่องที่คุณสร้างไว้ก่อนหน้านี้โดยใช้ CreateDebugToken
exchangeDeviceCheckToken POST /v1/{app=projects/*/apps/*}:exchangeDeviceCheckToken
ยอมรับ device_token ที่ออกโดย DeviceCheck และพยายามตรวจสอบกับ Apple
exchangePlayIntegrityToken POST /v1/{app=projects/*/apps/*}:exchangePlayIntegrityToken
ตรวจสอบโทเค็นการตอบกลับคำตัดสินความสมบูรณ์จาก Play Integrity
exchangeRecaptchaEnterpriseToken POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
ตรวจสอบโทเค็นการตอบกลับ reCAPTCHA Enterprise
exchangeRecaptchaV3Token POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaV3Token
ตรวจสอบโทเค็นการตอบกลับ reCAPTCHA v3
exchangeSafetyNetToken
(deprecated)		 POST /v1/{app=projects/*/apps/*}:exchangeSafetyNetToken
ตรวจสอบโทเค็น SafetyNet
generateAppAttestChallenge POST /v1/{app=projects/*/apps/*}:generateAppAttestChallenge
สร้างความท้าทายที่จะปกป้องความสมบูรณ์ของการเรียกใช้ทันทีหลังจากโทรหา ExchangeAppAttestAttestation หรือ ExchangeAppAttestAssertion
generatePlayIntegrityChallenge POST /v1/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
สร้างความท้าทายที่จะปกป้องความสมบูรณ์ของคำขอการตัดสินความสมบูรณ์ที่ส่งไปยัง Play Integrity API โดยทันที

ทรัพยากร REST: v1.projects.apps.appAttestConfig

วิธีการ
batchGet GET /v1/{parent=projects/*}/apps/-/appAttestConfig:batchGet
ได้รับ AppAttestConfig สำหรับรายการแอปที่ระบุโดยเฉพาะ
get GET /v1/{name=projects/*/apps/*/appAttestConfig}
รับ AppAttestConfig สำหรับแอปที่ระบุ
patch PATCH /v1/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
อัปเดต AppAttestConfig สำหรับแอปที่ระบุ

ทรัพยากร REST: v1.projects.apps.debugTokens

วิธีการ
create POST /v1/{parent=projects/*/apps/*}/debugTokens
สร้าง DebugToken ใหม่สำหรับแอปที่ระบุ
delete DELETE /v1/{name=projects/*/apps/*/debugTokens/*}
ลบ DebugToken ที่ระบุ
get GET /v1/{name=projects/*/apps/*/debugTokens/*}
รับ DebugToken ที่ระบุ
list GET /v1/{parent=projects/*/apps/*}/debugTokens
แสดงรายการ DebugToken ทั้งหมดสำหรับแอปที่ระบุ
patch PATCH /v1/{debugToken.name=projects/*/apps/*/debugTokens/*}
อัปเดต DebugToken ที่ระบุ

ทรัพยากร REST: v1.projects.apps.deviceCheckConfig

วิธีการ
batchGet GET /v1/{parent=projects/*}/apps/-/deviceCheckConfig:batchGet
ได้รับ DeviceCheckConfig สำหรับรายการแอปที่ระบุโดยเฉพาะ
get GET /v1/{name=projects/*/apps/*/deviceCheckConfig}
รับ DeviceCheckConfig สำหรับแอปที่ระบุ
patch PATCH /v1/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
อัปเดต DeviceCheckConfig สำหรับแอปที่ระบุ

ทรัพยากร REST: v1.projects.apps.playIntegrityConfig

วิธีการ
batchGet GET /v1/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
ได้รับ PlayIntegrityConfig สำหรับรายการแอปที่ระบุโดยเฉพาะ
get GET /v1/{name=projects/*/apps/*/playIntegrityConfig}
รับ PlayIntegrityConfig สำหรับแอปที่ระบุ
patch PATCH /v1/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
อัปเดต PlayIntegrityConfig สำหรับแอปที่ระบุ

ทรัพยากร REST: v1.projects.apps.recaptchaEnterpriseConfig

วิธีการ
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
ได้รับ RecaptchaEnterpriseConfig สำหรับรายการแอปที่ระบุโดยเฉพาะ
get GET /v1/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
รับ RecaptchaEnterpriseConfig สำหรับแอปที่ระบุ
patch PATCH /v1/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
อัปเดต RecaptchaEnterpriseConfig สำหรับแอปที่ระบุ

ทรัพยากร REST: v1.projects.apps.recaptchaV3Config

วิธีการ
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
ได้รับ RecaptchaV3Config สำหรับรายการแอปที่ระบุโดยเฉพาะ
get GET /v1/{name=projects/*/apps/*/recaptchaV3Config}
รับ RecaptchaV3Config สำหรับแอปที่ระบุ
patch PATCH /v1/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
อัปเดต RecaptchaV3Config สำหรับแอปที่ระบุ

ทรัพยากร REST: v1.projects.apps.safetyNetConfig

วิธีการ
batchGet
(deprecated)		 GET /v1/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
ได้รับ SafetyNetConfig สำหรับรายการแอปที่ระบุโดยเฉพาะ
get
(deprecated)		 GET /v1/{name=projects/*/apps/*/safetyNetConfig}
รับ SafetyNetConfig สำหรับแอปที่ระบุ
patch
(deprecated)		 PATCH /v1/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
อัปเดต SafetyNetConfig สำหรับแอปที่ระบุ

ทรัพยากร REST: v1.projects.services

วิธีการ
batchUpdate POST /v1/{parent=projects/*}/services:batchUpdate
อัปเดตการกำหนดค่า Service ที่ระบุโดยอัตโนมัติ
get GET /v1/{name=projects/*/services/*}
รับการกำหนดค่า Service สำหรับชื่อบริการที่ระบุ
list GET /v1/{parent=projects/*}/services
แสดงการกำหนดค่า Service ทั้งหมดสำหรับโปรเจ็กต์ที่ระบุ
patch PATCH /v1/{service.name=projects/*/services/*}
อัปเดตการกำหนดค่า Service ที่ระบุ