https.CallableOptions interface

Opções que podem ser definidas em uma função HTTPS chamável.

Assinatura:

export interface CallableOptions extends HttpsOptions 

Estende: HttpsOptions

Propriedades

Propriedade Tipo Descrição
consumeAppCheckToken (em inglês) booleano Determina se o token do Firebase App Check é consumido mediante solicitação. O padrão é "false".
enforceAppCheck (em inglês) booleano Determina se o Firebase AppCheck é aplicado. Quando verdadeiro, as solicitações com tokens inválidos respondem automaticamente com um erro 401 (não autorizado). Quando falso, solicitações com tokens inválidos definem event.app para indefiend.

https.CallableOptions.consumeAppCheckToken

Determina se o token do Firebase App Check é consumido mediante solicitação. O padrão é "false".

Defina como "true" para ativar o recurso de proteção contra repetição do App Check consumindo o token do App Check em uma solicitação chamável. Os tokens já consumidos terão a propriedade request.app.alreadyConsumed definida como "true".

Os tokens só serão considerados como consumidos se forem enviados para o serviço do App Check definindo essa opção como "true". O token não é usado em outros usos.

Esse recurso de proteção contra repetição exige uma chamada de rede extra para o back-end do App Check e força os clientes a receber um novo atestado dos provedores de atestado escolhidos. Isso pode afetar negativamente o desempenho e, possivelmente, sobrecarregar os provedores de atestado as cotas com mais rapidez. Use esse recurso apenas para proteger operações de baixo volume, essenciais para a segurança ou caras.

Essa opção não afeta a opção applyAppCheck. Definir o último como verdadeiro fará com que a função chamável responda automaticamente com um código de status 401 Não autorizado quando a solicitação incluir um token inválido do App Check. Quando a solicitação inclui tokens do App Check válidos, mas consumidos, elas não são rejeitadas automaticamente. Em vez disso, a propriedade request.app.alreadyConsumed será definida como "true" e passará a execução ao código do gerenciador para tomar outras decisões, como exigir verificações de segurança adicionais ou rejeitar a solicitação.

Assinatura:

consumeAppCheckToken?: boolean;

https.CallableOptions.enforceAppCheck

Determina se o Firebase AppCheck é aplicado. Quando verdadeiro, as solicitações com tokens inválidos respondem automaticamente com um erro 401 (não autorizado). Quando falso, solicitações com tokens inválidos definem event.app para indefiend.

Assinatura:

enforceAppCheck?: boolean;