You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="firstline">Accepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns an AppCheckToken.</p>
<pclass="firstline">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).</p>
<pclass="firstline">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.</p>
<pclass="firstline">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.</p>
<pre>Accepts an App Attest assertion and an artifact previously obtained from ExchangeAppAttestAttestation and verifies those with Apple. If valid, returns an AppCheckToken.
101
+
102
+
Args:
103
+
app: string, 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. (required)
104
+
body: object, The request body.
105
+
The object takes the form of:
106
+
107
+
{ # Request message for the ExchangeAppAttestAssertion method.
108
+
"artifact": "A String", # Required. The artifact returned by a previous call to ExchangeAppAttestAttestation.
109
+
"assertion": "A String", # Required. The CBOR-encoded assertion returned by the client-side App Attest API.
110
+
"challenge": "A String", # Required. A one-time challenge returned by an immediately prior call to GenerateAppAttestChallenge.
111
+
"limitedUse": True or False, # Specifies whether this attestation is for use in a *limited use* (`true`) or *session based* (`false`) context. To enable this attestation to be used with the *replay protection* feature, set this to `true`. The default value is `false`.
112
+
}
113
+
114
+
x__xgafv: string, V1 error format.
115
+
Allowed values
116
+
1 - v1 error format
117
+
2 - v2 error format
118
+
119
+
Returns:
120
+
An object of the form:
121
+
122
+
{ # Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check.
123
+
"token": "A String", # The App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK.
124
+
"ttl": "A String", # The duration from the time this token is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.
<pre>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).
131
+
132
+
Args:
133
+
app: string, 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. (required)
134
+
body: object, The request body.
135
+
The object takes the form of:
136
+
137
+
{ # Request message for the ExchangeAppAttestAttestation method.
138
+
"attestationStatement": "A String", # Required. The App Attest statement returned by the client-side App Attest API. This is a base64url encoded CBOR object in the JSON response.
139
+
"challenge": "A String", # Required. A one-time challenge returned by an immediately prior call to GenerateAppAttestChallenge.
140
+
"keyId": "A String", # Required. The key ID generated by App Attest for the client app.
141
+
"limitedUse": True or False, # Specifies whether this attestation is for use in a *limited use* (`true`) or *session based* (`false`) context. To enable this attestation to be used with the *replay protection* feature, set this to `true`. The default value is `false`.
142
+
}
143
+
144
+
x__xgafv: string, V1 error format.
145
+
Allowed values
146
+
1 - v1 error format
147
+
2 - v2 error format
148
+
149
+
Returns:
150
+
An object of the form:
151
+
152
+
{ # Response message for the ExchangeAppAttestAttestation method.
153
+
"appCheckToken": { # Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check. # Encapsulates an App Check token.
154
+
"token": "A String", # The App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK.
155
+
"ttl": "A String", # The duration from the time this token is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.
156
+
},
157
+
"artifact": "A String", # An artifact that can be used in future calls to ExchangeAppAttestAssertion.
<pre>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.
164
+
165
+
Args:
166
+
app: string, 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. (required)
167
+
body: object, The request body.
168
+
The object takes the form of:
169
+
170
+
{ # Request message for the ExchangeDebugToken method.
171
+
"debugToken": "A String", # Required. A debug token secret. This string must match a debug token secret previously created using CreateDebugToken.
172
+
"limitedUse": True or False, # Specifies whether this attestation is for use in a *limited use* (`true`) or *session based* (`false`) context. To enable this attestation to be used with the *replay protection* feature, set this to `true`. The default value is `false`.
173
+
}
174
+
175
+
x__xgafv: string, V1 error format.
176
+
Allowed values
177
+
1 - v1 error format
178
+
2 - v2 error format
179
+
180
+
Returns:
181
+
An object of the form:
182
+
183
+
{ # Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check.
184
+
"token": "A String", # The App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK.
185
+
"ttl": "A String", # The duration from the time this token is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.
<pre>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.
192
+
193
+
Args:
194
+
app: string, 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. (required)
195
+
body: object, The request body.
196
+
The object takes the form of:
197
+
198
+
{ # Request message for the GenerateAppAttestChallenge method.
199
+
}
200
+
201
+
x__xgafv: string, V1 error format.
202
+
Allowed values
203
+
1 - v1 error format
204
+
2 - v2 error format
205
+
206
+
Returns:
207
+
An object of the form:
208
+
209
+
{ # Response message for the GenerateAppAttestChallenge method.
210
+
"challenge": "A String", # A one-time use challenge for the client to pass to the App Attest API.
211
+
"ttl": "A String", # The duration from the time this challenge is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.
Copy file name to clipboardExpand all lines: docs/dyn/firebaseappcheck_v1.projects.apps.recaptchaV3Config.html
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -85,7 +85,7 @@ <h2>Instance Methods</h2>
85
85
<pclass="firstline">Gets the RecaptchaV3Config for the specified app. For security reasons, the `site_secret` field is never populated in the response.</p>
<pclass="firstline">Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.</p>
88
+
<pclass="firstline">Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3 tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.</p>
<pre>Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.
146
+
<pre>Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3 tokens for App Check tokens. For security reasons, the `site_secret` field is never populated in the response.
147
147
148
148
Args:
149
149
name: string, Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: ``` projects/{project_number}/apps/{app_id}/recaptchaV3Config ``` (required)
0 commit comments