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

Go to download







Firebaseappcheck.OauthClients (Firebase App Check API v1-rev20240930-2.0.0)











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.OauthClients



java.lang.Object


com.google.api.services.firebaseappcheck.v1.Firebaseappcheck.OauthClients







Enclosing class:
Firebaseappcheck




public class Firebaseappcheck.OauthClients
extends Object
The "oauthClients" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Firebaseappcheck.OauthClients.ExchangeAppAttestAssertion 


class 
Firebaseappcheck.OauthClients.ExchangeAppAttestAttestation 


class 
Firebaseappcheck.OauthClients.ExchangeDebugToken 


class 
Firebaseappcheck.OauthClients.GenerateAppAttestChallenge 









Constructor Summary

Constructors 

Constructor and Description


OauthClients() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


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



Firebaseappcheck.OauthClients.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.OauthClients.ExchangeDebugToken
exchangeDebugToken(String app,
                  GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest content)
Validates a debug token secret that you have previously created using CreateDebugToken.



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







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














Constructor Detail





OauthClients
public OauthClients()









Method Detail





exchangeAppAttestAssertion
public Firebaseappcheck.OauthClients.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 "oauthClients.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.OauthClients.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 "oauthClients.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








exchangeDebugToken
public Firebaseappcheck.OauthClients.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 "oauthClients.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








generateAppAttestChallenge
public Firebaseappcheck.OauthClients.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 "oauthClients.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














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.

Modifier and Type	Class and Description
`class`	`Firebaseappcheck.OauthClients.ExchangeAppAttestAssertion`
`class`	`Firebaseappcheck.OauthClients.ExchangeAppAttestAttestation`
`class`	`Firebaseappcheck.OauthClients.ExchangeDebugToken`
`class`	`Firebaseappcheck.OauthClients.GenerateAppAttestChallenge`

Modifier and Type	Method and Description
`Firebaseappcheck.OauthClients.ExchangeAppAttestAssertion`	`exchangeAppAttestAssertion(String app, GoogleFirebaseAppcheckV1ExchangeAppAttestAssertionRequest content)` Accepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple.
`Firebaseappcheck.OauthClients.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.OauthClients.ExchangeDebugToken`	`exchangeDebugToken(String app, GoogleFirebaseAppcheckV1ExchangeDebugTokenRequest content)` Validates a debug token secret that you have previously created using CreateDebugToken.
`Firebaseappcheck.OauthClients.GenerateAppAttestChallenge`	`generateAppAttestChallenge(String app, GoogleFirebaseAppcheckV1GenerateAppAttestChallengeRequest content)` Generates a challenge that protects the integrity of an immediately following call to ExchangeAppAttestAttestation or ExchangeAppAttestAssertion.