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

OauthClients

class OauthClients extends Resource (View source)

The "oauthClients" collection of methods.

Typical usage is:

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

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. (oauthClients.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). (oauthClients.exchangeAppAttestAttestation)

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. (oauthClients.exchangeDebugToken)

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.

Details

at line 53
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. (oauthClients.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 77
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). (oauthClients.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 99
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. (oauthClients.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 121
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.

(oauthClients.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