VerifyAppCheckTokenOptions interface
Stay organized with collections
Save and categorize content based on your preferences.
Interface representing options for the AppCheck.verifyToken() method.
Signature:
export interface VerifyAppCheckTokenOptions
Properties
| Property |
Type |
Description |
| consume |
boolean |
To use the replay protection feature, set this to true. The AppCheck.verifyToken() method will mark the token as consumed after verifying it.Tokens that are found to be already consumed will be marked as such in the response.Tokens are only considered to be consumed if it is sent to App Check backend by calling the AppCheck.verifyToken() method with this field set to true; other uses of the token do not consume it.This replay protection feature requires an additional network call to the App Check backend and forces your clients to obtain a fresh attestation from your chosen attestation providers. This can therefore negatively impact performance and can potentially deplete your attestation providers' quotas faster. We recommend that you use this feature only for protecting low volume, security critical, or expensive operations. |
VerifyAppCheckTokenOptions.consume
To use the replay protection feature, set this to true. The AppCheck.verifyToken() method will mark the token as consumed after verifying it.
Tokens that are found to be already consumed will be marked as such in the response.
Tokens are only considered to be consumed if it is sent to App Check backend by calling the AppCheck.verifyToken() method with this field set to true; other uses of the token do not consume it.
This replay protection feature requires an additional network call to the App Check backend and forces your clients to obtain a fresh attestation from your chosen attestation providers. This can therefore negatively impact performance and can potentially deplete your attestation providers' quotas faster. We recommend that you use this feature only for protecting low volume, security critical, or expensive operations.
Signature:
consume?: boolean;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-05-09 UTC.
[null,null,["Last updated 2023-05-09 UTC."],[],[],null,["# VerifyAppCheckTokenOptions interface\n\nInterface representing options for the [AppCheck.verifyToken()](./firebase-admin.app-check.appcheck.md#appcheckverifytoken) method.\n\n**Signature:** \n\n export interface VerifyAppCheckTokenOptions \n\nProperties\n----------\n\n| Property | Type | Description |\n|-------------------------------------------------------------------------------------------------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [consume](./firebase-admin.app-check.verifyappchecktokenoptions.md#verifyappchecktokenoptionsconsume) | boolean | To use the replay protection feature, set this to `true`. The [AppCheck.verifyToken()](./firebase-admin.app-check.appcheck.md#appcheckverifytoken) method will mark the token as consumed after verifying it.Tokens that are found to be already consumed will be marked as such in the response.Tokens are only considered to be consumed if it is sent to App Check backend by calling the [AppCheck.verifyToken()](./firebase-admin.app-check.appcheck.md#appcheckverifytoken) method with this field set to `true`; other uses of the token do not consume it.This replay protection feature requires an additional network call to the App Check backend and forces your clients to obtain a fresh attestation from your chosen attestation providers. This can therefore negatively impact performance and can potentially deplete your attestation providers' quotas faster. We recommend that you use this feature only for protecting low volume, security critical, or expensive operations. |\n\nVerifyAppCheckTokenOptions.consume\n----------------------------------\n\nTo use the replay protection feature, set this to `true`. The [AppCheck.verifyToken()](./firebase-admin.app-check.appcheck.md#appcheckverifytoken) method will mark the token as consumed after verifying it.\n\nTokens that are found to be already consumed will be marked as such in the response.\n\nTokens are only considered to be consumed if it is sent to App Check backend by calling the [AppCheck.verifyToken()](./firebase-admin.app-check.appcheck.md#appcheckverifytoken) method with this field set to `true`; other uses of the token do not consume it.\n\nThis replay protection feature requires an additional network call to the App Check backend and forces your clients to obtain a fresh attestation from your chosen attestation providers. This can therefore negatively impact performance and can potentially deplete your attestation providers' quotas faster. We recommend that you use this feature only for protecting low volume, security critical, or expensive operations.\n\n**Signature:** \n\n consume?: boolean;"]]
