1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Firebaseappcheck
  7. \
  8. Resource
  9. \
  10. ProjectsApps

ProjectsApps

class ProjectsApps extends Resource (View source)

The "apps" collection of methods.

Typical usage is:

 $firebaseappcheckService = new Google\Service\Firebaseappcheck(...);
 $apps = $firebaseappcheckService->projects_apps;

Methods

GoogleFirebaseAppcheckV1AppCheckToken
exchangeAppAttestAssertion(string $app, GoogleFirebaseAppcheckV1ExchangeAppAttestAssertionRequest $postBody, array $optParams = [])

Accepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns an AppCheckToken. (apps.exchangeAppAttestAssertion)

GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse
exchangeAppAttestAttestation(string $app, GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationRequest $postBody, array $optParams = [])

Accepts an App Attest CBOR attestation and verifies it with Apple using your preconfigured team and bundle IDs. If valid, returns an attestation artifact that can later be exchanged for an AppCheckToken using ExchangeAppAttestAssertion. For convenience and performance, this method's response object will also contain an AppCheckToken (if the verification is successful). (apps.exchangeAppAttestAttestation)

GoogleFirebaseAppcheckV1AppCheckToken
exchangeCustomToken(string $app, GoogleFirebaseAppcheckV1ExchangeCustomTokenRequest $postBody, array $optParams = [])

Validates a custom token signed using your project's Admin SDK service account credentials. If valid, returns an AppCheckToken.

GoogleFirebaseAppcheckV1AppCheckToken
exchangeDebugToken(string $app, GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest $postBody, array $optParams = [])

Validates a debug token secret that you have previously created using CreateDebugToken. If valid, returns an AppCheckToken. Note that a restrictive quota is enforced on this method to prevent accidental exposure of the app to abuse. (apps.exchangeDebugToken)

GoogleFirebaseAppcheckV1AppCheckToken
exchangeDeviceCheckToken(string $app, GoogleFirebaseAppcheckV1ExchangeDeviceCheckTokenRequest $postBody, array $optParams = [])

Accepts a device_token issued by DeviceCheck, and attempts to validate it with Apple.

GoogleFirebaseAppcheckV1AppCheckToken
exchangePlayIntegrityToken(string $app, GoogleFirebaseAppcheckV1ExchangePlayIntegrityTokenRequest $postBody, array $optParams = [])

Validates an integrity verdict response token from Play Integrity. If valid, returns an AppCheckToken. (apps.exchangePlayIntegrityToken)

GoogleFirebaseAppcheckV1AppCheckToken
exchangeRecaptchaEnterpriseToken(string $app, GoogleFirebaseAppcheckV1ExchangeRecaptchaEnterpriseTokenRequest $postBody, array $optParams = [])

Validates a reCAPTCHA Enterprise response token. If valid, returns an AppCheckToken.

GoogleFirebaseAppcheckV1AppCheckToken
exchangeRecaptchaV3Token(string $app, GoogleFirebaseAppcheckV1ExchangeRecaptchaV3TokenRequest $postBody, array $optParams = [])

Validates a reCAPTCHA v3 response token. If valid, returns an AppCheckToken. (apps.exchangeRecaptchaV3Token)

GoogleFirebaseAppcheckV1AppCheckToken
exchangeSafetyNetToken(string $app, GoogleFirebaseAppcheckV1ExchangeSafetyNetTokenRequest $postBody, array $optParams = [])

Validates a SafetyNet token. If valid, returns an AppCheckToken.

GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse
generateAppAttestChallenge(string $app, GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest $postBody, array $optParams = [])

Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge should not be reused for multiple calls.

GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeResponse
generatePlayIntegrityChallenge(string $app, GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeRequest $postBody, array $optParams = [])

Generates a challenge that protects the integrity of an immediately following integrity verdict request to the Play Integrity API. The next call to ExchangePlayIntegrityToken using the resulting integrity token will verify the presence and validity of the challenge. A challenge should not be reused for multiple calls. (apps.generatePlayIntegrityChallenge)

Details

at line 61
GoogleFirebaseAppcheckV1AppCheckToken exchangeAppAttestAssertion(string $app, GoogleFirebaseAppcheckV1ExchangeAppAttestAssertionRequest $postBody, array $optParams = [])

Accepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns an AppCheckToken. (apps.exchangeAppAttestAssertion)

Parameters

string $app

Required. The relative resource name of the iOS app, in the format: projects/{project_number}/apps/{app_id} If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.
GoogleFirebaseAppcheckV1ExchangeAppAttestAssertionRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1AppCheckToken

Exceptions

Exception

at line 85
GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse exchangeAppAttestAttestation(string $app, GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationRequest $postBody, array $optParams = [])

Accepts an App Attest CBOR attestation and verifies it with Apple using your preconfigured team and bundle IDs. If valid, returns an attestation artifact that can later be exchanged for an AppCheckToken using ExchangeAppAttestAssertion. For convenience and performance, this method's response object will also contain an AppCheckToken (if the verification is successful). (apps.exchangeAppAttestAttestation)

Parameters

string $app

Required. The relative resource name of the iOS app, in the format: projects/{project_number}/apps/{app_id} If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.
GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationResponse

Exceptions

Exception

at line 106
GoogleFirebaseAppcheckV1AppCheckToken exchangeCustomToken(string $app, GoogleFirebaseAppcheckV1ExchangeCustomTokenRequest $postBody, array $optParams = [])

Validates a custom token signed using your project's Admin SDK service account credentials. If valid, returns an AppCheckToken.

(apps.exchangeCustomToken)

Parameters

string $app

Required. The relative resource name of the app, in the format: projects/{project_number}/apps/{app_id} If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.
GoogleFirebaseAppcheckV1ExchangeCustomTokenRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1AppCheckToken

Exceptions

Exception

at line 128
GoogleFirebaseAppcheckV1AppCheckToken exchangeDebugToken(string $app, GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest $postBody, array $optParams = [])

Validates a debug token secret that you have previously created using CreateDebugToken. If valid, returns an AppCheckToken. Note that a restrictive quota is enforced on this method to prevent accidental exposure of the app to abuse. (apps.exchangeDebugToken)

Parameters

string $app

Required. The relative resource name of the app, in the format: projects/{project_number}/apps/{app_id} If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.
GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1AppCheckToken

Exceptions

Exception

at line 149
GoogleFirebaseAppcheckV1AppCheckToken exchangeDeviceCheckToken(string $app, GoogleFirebaseAppcheckV1ExchangeDeviceCheckTokenRequest $postBody, array $optParams = [])

Accepts a device_token issued by DeviceCheck, and attempts to validate it with Apple.

If valid, returns an AppCheckToken. (apps.exchangeDeviceCheckToken)

Parameters

string $app

Required. The relative resource name of the iOS app, in the format: projects/{project_number}/apps/{app_id} If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.
GoogleFirebaseAppcheckV1ExchangeDeviceCheckTokenRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1AppCheckToken

Exceptions

Exception

at line 170
GoogleFirebaseAppcheckV1AppCheckToken exchangePlayIntegrityToken(string $app, GoogleFirebaseAppcheckV1ExchangePlayIntegrityTokenRequest $postBody, array $optParams = [])

Validates an integrity verdict response token from Play Integrity. If valid, returns an AppCheckToken. (apps.exchangePlayIntegrityToken)

Parameters

string $app

Required. The relative resource name of the Android app, in the format: projects/{project_number}/apps/{app_id} If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.
GoogleFirebaseAppcheckV1ExchangePlayIntegrityTokenRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1AppCheckToken

Exceptions

Exception

at line 192
GoogleFirebaseAppcheckV1AppCheckToken exchangeRecaptchaEnterpriseToken(string $app, GoogleFirebaseAppcheckV1ExchangeRecaptchaEnterpriseTokenRequest $postBody, array $optParams = [])

Validates a reCAPTCHA Enterprise response token. If valid, returns an AppCheckToken.

(apps.exchangeRecaptchaEnterpriseToken)

Parameters

string $app

Required. The relative resource name of the web app, in the format: projects/{project_number}/apps/{app_id} If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.
GoogleFirebaseAppcheckV1ExchangeRecaptchaEnterpriseTokenRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1AppCheckToken

Exceptions

Exception

at line 213
GoogleFirebaseAppcheckV1AppCheckToken exchangeRecaptchaV3Token(string $app, GoogleFirebaseAppcheckV1ExchangeRecaptchaV3TokenRequest $postBody, array $optParams = [])

Validates a reCAPTCHA v3 response token. If valid, returns an AppCheckToken. (apps.exchangeRecaptchaV3Token)

Parameters

string $app

Required. The relative resource name of the web app, in the format: projects/{project_number}/apps/{app_id} If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.
GoogleFirebaseAppcheckV1ExchangeRecaptchaV3TokenRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1AppCheckToken

Exceptions

Exception

at line 235
GoogleFirebaseAppcheckV1AppCheckToken exchangeSafetyNetToken(string $app, GoogleFirebaseAppcheckV1ExchangeSafetyNetTokenRequest $postBody, array $optParams = [])

Validates a SafetyNet token. If valid, returns an AppCheckToken.

(apps.exchangeSafetyNetToken)

Parameters

string $app

Required. The relative resource name of the Android app, in the format: projects/{project_number}/apps/{app_id} If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.
GoogleFirebaseAppcheckV1ExchangeSafetyNetTokenRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1AppCheckToken

Exceptions

Exception

at line 257
GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse generateAppAttestChallenge(string $app, GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest $postBody, array $optParams = [])

Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion. A challenge should not be reused for multiple calls.

(apps.generateAppAttestChallenge)

Parameters

string $app

Required. The relative resource name of the iOS app, in the format: projects/{project_number}/apps/{app_id} If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.
GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1GenerateAppAttestChallengeResponse

Exceptions

Exception

at line 280
GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeResponse generatePlayIntegrityChallenge(string $app, GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeRequest $postBody, array $optParams = [])

Generates a challenge that protects the integrity of an immediately following integrity verdict request to the Play Integrity API. The next call to ExchangePlayIntegrityToken using the resulting integrity token will verify the presence and validity of the challenge. A challenge should not be reused for multiple calls. (apps.generatePlayIntegrityChallenge)

Parameters

string $app

Required. The relative resource name of the app, in the format: projects/{project_number}/apps/{app_id} If necessary, the project_number element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's AIP 2510 standard.
GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeResponse

Exceptions

Exception