• Home
• com.google.apis
• google-api-services-firebaseappcheck
• v1-rev20240930-2.0.0
• source code
• Firebaseappcheck.Projects.Apps.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.firebaseappcheck.v1.Firebaseappcheck.Projects.Apps.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.firebaseappcheck.v1
Class Firebaseappcheck.Projects.Apps



java.lang.Object


com.google.api.services.firebaseappcheck.v1.Firebaseappcheck.Projects.Apps







Enclosing class:
Firebaseappcheck.Projects




public class Firebaseappcheck.Projects.Apps
extends Object
The "apps" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Firebaseappcheck.Projects.Apps.AppAttestConfig
The "appAttestConfig" collection of methods.



class 
Firebaseappcheck.Projects.Apps.DebugTokens
The "debugTokens" collection of methods.



class 
Firebaseappcheck.Projects.Apps.DeviceCheckConfig
The "deviceCheckConfig" collection of methods.



class 
Firebaseappcheck.Projects.Apps.ExchangeAppAttestAssertion 


class 
Firebaseappcheck.Projects.Apps.ExchangeAppAttestAttestation 


class 
Firebaseappcheck.Projects.Apps.ExchangeCustomToken 


class 
Firebaseappcheck.Projects.Apps.ExchangeDebugToken 


class 
Firebaseappcheck.Projects.Apps.ExchangeDeviceCheckToken 


class 
Firebaseappcheck.Projects.Apps.ExchangePlayIntegrityToken 


class 
Firebaseappcheck.Projects.Apps.ExchangeRecaptchaEnterpriseToken 


class 
Firebaseappcheck.Projects.Apps.ExchangeRecaptchaV3Token 


class 
Firebaseappcheck.Projects.Apps.ExchangeSafetyNetToken 


class 
Firebaseappcheck.Projects.Apps.GenerateAppAttestChallenge 


class 
Firebaseappcheck.Projects.Apps.GeneratePlayIntegrityChallenge 


class 
Firebaseappcheck.Projects.Apps.PlayIntegrityConfig
The "playIntegrityConfig" collection of methods.



class 
Firebaseappcheck.Projects.Apps.RecaptchaEnterpriseConfig
The "recaptchaEnterpriseConfig" collection of methods.



class 
Firebaseappcheck.Projects.Apps.RecaptchaV3Config
The "recaptchaV3Config" collection of methods.



class 
Firebaseappcheck.Projects.Apps.SafetyNetConfig
The "safetyNetConfig" collection of methods.










Constructor Summary

Constructors 

Constructor and Description


Apps() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Firebaseappcheck.Projects.Apps.AppAttestConfig
appAttestConfig()
An accessor for creating requests from the AppAttestConfig collection.



Firebaseappcheck.Projects.Apps.DebugTokens
debugTokens()
An accessor for creating requests from the DebugTokens collection.



Firebaseappcheck.Projects.Apps.DeviceCheckConfig
deviceCheckConfig()
An accessor for creating requests from the DeviceCheckConfig collection.



Firebaseappcheck.Projects.Apps.ExchangeAppAttestAssertion
exchangeAppAttestAssertion(String app,
                          GoogleFirebaseAppcheckV1ExchangeAppAttestAssertionRequest content)
Accepts an App Attest assertion and an artifact previously obtained from
 ExchangeAppAttestAttestation and verifies those with Apple.



Firebaseappcheck.Projects.Apps.ExchangeAppAttestAttestation
exchangeAppAttestAttestation(String app,
                            GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationRequest content)
Accepts an App Attest CBOR attestation and verifies it with Apple using your preconfigured team
 and bundle IDs.



Firebaseappcheck.Projects.Apps.ExchangeCustomToken
exchangeCustomToken(String app,
                   GoogleFirebaseAppcheckV1ExchangeCustomTokenRequest content)
Validates a custom token signed using your project's Admin SDK service account credentials.



Firebaseappcheck.Projects.Apps.ExchangeDebugToken
exchangeDebugToken(String app,
                  GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest content)
Validates a debug token secret that you have previously created using CreateDebugToken.



Firebaseappcheck.Projects.Apps.ExchangeDeviceCheckToken
exchangeDeviceCheckToken(String app,
                        GoogleFirebaseAppcheckV1ExchangeDeviceCheckTokenRequest content)
Accepts a [`device_token`](https://developer.apple.com/documentation/devicecheck/dcdevice) issued
 by DeviceCheck, and attempts to validate it with Apple.



Firebaseappcheck.Projects.Apps.ExchangePlayIntegrityToken
exchangePlayIntegrityToken(String app,
                          GoogleFirebaseAppcheckV1ExchangePlayIntegrityTokenRequest content)
Validates an [integrity verdict response token from Play
 Integrity](https://developer.android.com/google/play/integrity/verdict#decrypt-verify).



Firebaseappcheck.Projects.Apps.ExchangeRecaptchaEnterpriseToken
exchangeRecaptchaEnterpriseToken(String app,
                                GoogleFirebaseAppcheckV1ExchangeRecaptchaEnterpriseTokenRequest content)
Validates a [reCAPTCHA Enterprise response token](https://cloud.google.com/recaptcha-
 enterprise/docs/create-assessment#retrieve_token).



Firebaseappcheck.Projects.Apps.ExchangeRecaptchaV3Token
exchangeRecaptchaV3Token(String app,
                        GoogleFirebaseAppcheckV1ExchangeRecaptchaV3TokenRequest content)
Validates a [reCAPTCHA v3 response token](https://developers.google.com/recaptcha/docs/v3).



Firebaseappcheck.Projects.Apps.ExchangeSafetyNetToken
exchangeSafetyNetToken(String app,
                      GoogleFirebaseAppcheckV1ExchangeSafetyNetTokenRequest content)
Validates a [SafetyNet
 token](https://developer.android.com/training/safetynet/attestation#request-attestation-step).



Firebaseappcheck.Projects.Apps.GenerateAppAttestChallenge
generateAppAttestChallenge(String app,
                          GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest content)
Generates a challenge that protects the integrity of an immediately following call to
 ExchangeAppAttestAttestation or ExchangeAppAttestAssertion.



Firebaseappcheck.Projects.Apps.GeneratePlayIntegrityChallenge
generatePlayIntegrityChallenge(String app,
                              GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeRequest content)
Generates a challenge that protects the integrity of an immediately following integrity verdict
 request to the Play Integrity API.



Firebaseappcheck.Projects.Apps.PlayIntegrityConfig
playIntegrityConfig()
An accessor for creating requests from the PlayIntegrityConfig collection.



Firebaseappcheck.Projects.Apps.RecaptchaEnterpriseConfig
recaptchaEnterpriseConfig()
An accessor for creating requests from the RecaptchaEnterpriseConfig collection.



Firebaseappcheck.Projects.Apps.RecaptchaV3Config
recaptchaV3Config()
An accessor for creating requests from the RecaptchaV3Config collection.



Firebaseappcheck.Projects.Apps.SafetyNetConfig
safetyNetConfig()
An accessor for creating requests from the SafetyNetConfig collection.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Apps
public Apps()









Method Detail





exchangeAppAttestAssertion
public Firebaseappcheck.Projects.Apps.ExchangeAppAttestAssertion exchangeAppAttestAssertion(String app,
                                                                                            GoogleFirebaseAppcheckV1ExchangeAppAttestAssertionRequest content)
                                                                                     throws IOException
Accepts an App Attest assertion and an artifact previously obtained from
 ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns an AppCheckToken.

 Create a request for the method "apps.exchangeAppAttestAssertion".

 This request holds the parameters needed by the firebaseappcheck server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the
 remote operation.

Parameters:
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](https://google.aip.dev/cloud/2510) standard.
content - the GoogleFirebaseAppcheckV1ExchangeAppAttestAssertionRequest
Returns:
the request
Throws:
IOException








exchangeAppAttestAttestation
public Firebaseappcheck.Projects.Apps.ExchangeAppAttestAttestation exchangeAppAttestAttestation(String app,
                                                                                                GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationRequest content)
                                                                                         throws IOException
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).

 Create a request for the method "apps.exchangeAppAttestAttestation".

 This request holds the parameters needed by the firebaseappcheck server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the
 remote operation.

Parameters:
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](https://google.aip.dev/cloud/2510) standard.
content - the GoogleFirebaseAppcheckV1ExchangeAppAttestAttestationRequest
Returns:
the request
Throws:
IOException








exchangeCustomToken
public Firebaseappcheck.Projects.Apps.ExchangeCustomToken exchangeCustomToken(String app,
                                                                              GoogleFirebaseAppcheckV1ExchangeCustomTokenRequest content)
                                                                       throws IOException
Validates a custom token signed using your project's Admin SDK service account credentials. If
 valid, returns an AppCheckToken.

 Create a request for the method "apps.exchangeCustomToken".

 This request holds the parameters needed by the firebaseappcheck server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
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](https://google.aip.dev/cloud/2510) standard.
content - the GoogleFirebaseAppcheckV1ExchangeCustomTokenRequest
Returns:
the request
Throws:
IOException








exchangeDebugToken
public Firebaseappcheck.Projects.Apps.ExchangeDebugToken exchangeDebugToken(String app,
                                                                            GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest content)
                                                                     throws IOException
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.

 Create a request for the method "apps.exchangeDebugToken".

 This request holds the parameters needed by the firebaseappcheck server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
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](https://google.aip.dev/cloud/2510) standard.
content - the GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest
Returns:
the request
Throws:
IOException








exchangeDeviceCheckToken
public Firebaseappcheck.Projects.Apps.ExchangeDeviceCheckToken exchangeDeviceCheckToken(String app,
                                                                                        GoogleFirebaseAppcheckV1ExchangeDeviceCheckTokenRequest content)
                                                                                 throws IOException
Accepts a [`device_token`](https://developer.apple.com/documentation/devicecheck/dcdevice) issued
 by DeviceCheck, and attempts to validate it with Apple. If valid, returns an AppCheckToken.

 Create a request for the method "apps.exchangeDeviceCheckToken".

 This request holds the parameters needed by the firebaseappcheck server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the
 remote operation.

Parameters:
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](https://google.aip.dev/cloud/2510) standard.
content - the GoogleFirebaseAppcheckV1ExchangeDeviceCheckTokenRequest
Returns:
the request
Throws:
IOException








exchangePlayIntegrityToken
public Firebaseappcheck.Projects.Apps.ExchangePlayIntegrityToken exchangePlayIntegrityToken(String app,
                                                                                            GoogleFirebaseAppcheckV1ExchangePlayIntegrityTokenRequest content)
                                                                                     throws IOException
Validates an [integrity verdict response token from Play
 Integrity](https://developer.android.com/google/play/integrity/verdict#decrypt-verify). If valid,
 returns an AppCheckToken.

 Create a request for the method "apps.exchangePlayIntegrityToken".

 This request holds the parameters needed by the firebaseappcheck server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the
 remote operation.

Parameters:
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](https://google.aip.dev/cloud/2510) standard.
content - the GoogleFirebaseAppcheckV1ExchangePlayIntegrityTokenRequest
Returns:
the request
Throws:
IOException








exchangeRecaptchaEnterpriseToken
public Firebaseappcheck.Projects.Apps.ExchangeRecaptchaEnterpriseToken exchangeRecaptchaEnterpriseToken(String app,
                                                                                                        GoogleFirebaseAppcheckV1ExchangeRecaptchaEnterpriseTokenRequest content)
                                                                                                 throws IOException
Validates a [reCAPTCHA Enterprise response token](https://cloud.google.com/recaptcha-
 enterprise/docs/create-assessment#retrieve_token). If valid, returns an AppCheckToken.

 Create a request for the method "apps.exchangeRecaptchaEnterpriseToken".

 This request holds the parameters needed by the firebaseappcheck server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke
 the remote operation.

Parameters:
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](https://google.aip.dev/cloud/2510) standard.
content - the GoogleFirebaseAppcheckV1ExchangeRecaptchaEnterpriseTokenRequest
Returns:
the request
Throws:
IOException








exchangeRecaptchaV3Token
public Firebaseappcheck.Projects.Apps.ExchangeRecaptchaV3Token exchangeRecaptchaV3Token(String app,
                                                                                        GoogleFirebaseAppcheckV1ExchangeRecaptchaV3TokenRequest content)
                                                                                 throws IOException
Validates a [reCAPTCHA v3 response token](https://developers.google.com/recaptcha/docs/v3). If
 valid, returns an AppCheckToken.

 Create a request for the method "apps.exchangeRecaptchaV3Token".

 This request holds the parameters needed by the firebaseappcheck server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the
 remote operation.

Parameters:
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](https://google.aip.dev/cloud/2510) standard.
content - the GoogleFirebaseAppcheckV1ExchangeRecaptchaV3TokenRequest
Returns:
the request
Throws:
IOException








exchangeSafetyNetToken
public Firebaseappcheck.Projects.Apps.ExchangeSafetyNetToken exchangeSafetyNetToken(String app,
                                                                                    GoogleFirebaseAppcheckV1ExchangeSafetyNetTokenRequest content)
                                                                             throws IOException
Validates a [SafetyNet
 token](https://developer.android.com/training/safetynet/attestation#request-attestation-step). If
 valid, returns an AppCheckToken.

 Create a request for the method "apps.exchangeSafetyNetToken".

 This request holds the parameters needed by the firebaseappcheck server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the
 remote operation.

Parameters:
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](https://google.aip.dev/cloud/2510) standard.
content - the GoogleFirebaseAppcheckV1ExchangeSafetyNetTokenRequest
Returns:
the request
Throws:
IOException








generateAppAttestChallenge
public Firebaseappcheck.Projects.Apps.GenerateAppAttestChallenge generateAppAttestChallenge(String app,
                                                                                            GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest content)
                                                                                     throws IOException
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.

 Create a request for the method "apps.generateAppAttestChallenge".

 This request holds the parameters needed by the firebaseappcheck server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the
 remote operation.

Parameters:
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](https://google.aip.dev/cloud/2510) standard.
content - the GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest
Returns:
the request
Throws:
IOException








generatePlayIntegrityChallenge
public Firebaseappcheck.Projects.Apps.GeneratePlayIntegrityChallenge generatePlayIntegrityChallenge(String app,
                                                                                                    GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeRequest content)
                                                                                             throws IOException
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.

 Create a request for the method "apps.generatePlayIntegrityChallenge".

 This request holds the parameters needed by the firebaseappcheck server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke
 the remote operation.

Parameters:
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](https://google.aip.dev/cloud/2510) standard.
content - the GoogleFirebaseAppcheckV1GeneratePlayIntegrityChallengeRequest
Returns:
the request
Throws:
IOException








appAttestConfig
public Firebaseappcheck.Projects.Apps.AppAttestConfig appAttestConfig()
An accessor for creating requests from the AppAttestConfig collection.

 
The typical use is:
 
    Firebaseappcheck firebaseappcheck = new Firebaseappcheck(...);
    Firebaseappcheck.AppAttestConfig.List request = firebaseappcheck.appAttestConfig().list(parameters ...)
 

Returns:
the resource collection








debugTokens
public Firebaseappcheck.Projects.Apps.DebugTokens debugTokens()
An accessor for creating requests from the DebugTokens collection.

 
The typical use is:
 
    Firebaseappcheck firebaseappcheck = new Firebaseappcheck(...);
    Firebaseappcheck.DebugTokens.List request = firebaseappcheck.debugTokens().list(parameters ...)
 

Returns:
the resource collection








deviceCheckConfig
public Firebaseappcheck.Projects.Apps.DeviceCheckConfig deviceCheckConfig()
An accessor for creating requests from the DeviceCheckConfig collection.

 
The typical use is:
 
    Firebaseappcheck firebaseappcheck = new Firebaseappcheck(...);
    Firebaseappcheck.DeviceCheckConfig.List request = firebaseappcheck.deviceCheckConfig().list(parameters ...)
 

Returns:
the resource collection








playIntegrityConfig
public Firebaseappcheck.Projects.Apps.PlayIntegrityConfig playIntegrityConfig()
An accessor for creating requests from the PlayIntegrityConfig collection.

 
The typical use is:
 
    Firebaseappcheck firebaseappcheck = new Firebaseappcheck(...);
    Firebaseappcheck.PlayIntegrityConfig.List request = firebaseappcheck.playIntegrityConfig().list(parameters ...)
 

Returns:
the resource collection








recaptchaEnterpriseConfig
public Firebaseappcheck.Projects.Apps.RecaptchaEnterpriseConfig recaptchaEnterpriseConfig()
An accessor for creating requests from the RecaptchaEnterpriseConfig collection.

 
The typical use is:
 
    Firebaseappcheck firebaseappcheck = new Firebaseappcheck(...);
    Firebaseappcheck.RecaptchaEnterpriseConfig.List request = firebaseappcheck.recaptchaEnterpriseConfig().list(parameters ...)
 

Returns:
the resource collection








recaptchaV3Config
public Firebaseappcheck.Projects.Apps.RecaptchaV3Config recaptchaV3Config()
An accessor for creating requests from the RecaptchaV3Config collection.

 
The typical use is:
 
    Firebaseappcheck firebaseappcheck = new Firebaseappcheck(...);
    Firebaseappcheck.RecaptchaV3Config.List request = firebaseappcheck.recaptchaV3Config().list(parameters ...)
 

Returns:
the resource collection








safetyNetConfig
public Firebaseappcheck.Projects.Apps.SafetyNetConfig safetyNetConfig()
An accessor for creating requests from the SafetyNetConfig collection.

 
The typical use is:
 
    Firebaseappcheck firebaseappcheck = new Firebaseappcheck(...);
    Firebaseappcheck.SafetyNetConfig.List request = firebaseappcheck.safetyNetConfig().list(parameters ...)
 

Returns:
the resource collection














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.