Pular para o conteúdo principal

Alias de Tipo: BearerAuthConfig

type BearerAuthConfig = {
  audience?: string;
  issuer: string;
  requiredScopes?: string[];
  showErrorDetails?: boolean;
  verifyAccessToken: VerifyAccessTokenFunction;
};

Propriedades​

audience?​

optional audience: string;

O público (Audience) esperado do token de acesso (aud claim). Normalmente, este é o servidor de recursos (API) para o qual o token se destina. Se não for fornecido, a verificação do público será ignorada.

Nota: Se seu servidor de autorização não suporta Indicadores de Recurso (Resource Indicators) (RFC 8707), você pode omitir este campo, pois o público pode não ser relevante.

Veja também​

https://datatracker.ietf.org/doc/html/rfc8707

issuer​

issuer: string;

O emissor (Issuer) esperado do token de acesso (iss claim). Deve ser a URL do servidor de autorização que emitiu o token.

requiredScopes?​

optional requiredScopes: string[];

Um array de escopos (Scopes) obrigatórios que o token de acesso deve possuir. Se o token não contiver todos esses escopos, um erro será lançado.

Nota: O handler verificará a reivindicação scope no token, que pode ser uma string separada por espaços ou um array de strings, dependendo da implementação do servidor de autorização. Se a reivindicação scope não estiver presente, o handler verificará a reivindicação scopes se disponível.

showErrorDetails?​

optional showErrorDetails: boolean;

Indica se deve mostrar informações detalhadas de erro na resposta. Isso é útil para depuração durante o desenvolvimento, mas deve ser desativado em produção para evitar vazamento de informações sensíveis.

Padrão​

false

verifyAccessToken​

verifyAccessToken: VerifyAccessTokenFunction;

Tipo de função para verificar um token de acesso (Access token).

Esta função deve lançar um MCPAuthTokenVerificationError se o token for inválido, ou retornar um objeto AuthInfo se o token for válido.

Veja também​

VerifyAccessTokenFunction para mais detalhes.