型エイリアス: BearerAuthConfig

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

プロパティ

audience?

optional audience: string;

アクセストークン (アクセストークン) の期待されるオーディエンス (aud クレーム)。これは通常、トークンが意図されているリソースサーバー（API）です。指定しない場合、オーディエンスのチェックはスキップされます。

注意: 認可サーバーがリソースインジケーター (RFC 8707) をサポートしていない場合、このフィールドは省略できます。なぜなら、オーディエンスが関連しない場合があるためです。

参照

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

issuer

issuer: string;

アクセストークン (アクセストークン) の期待される発行者 (iss クレーム)。これはトークンを発行した認可サーバーの URL である必要があります。

requiredScopes?

optional requiredScopes: string[];

アクセストークン (アクセストークン) に必要なスコープ (スコープ) の配列。トークンにこれらすべてのスコープが含まれていない場合、エラーがスローされます。

注意: ハンドラーはトークン内の scope クレームをチェックします。これは認可サーバーの実装によって、スペース区切りの文字列または文字列の配列である場合があります。scope クレームが存在しない場合、ハンドラーは scopes クレームがあればそれをチェックします。

showErrorDetails?

optional showErrorDetails: boolean;

レスポンスに詳細なエラー情報を表示するかどうか。これは開発中のデバッグに便利ですが、本番環境では機密情報漏洩を防ぐため無効にするべきです。

デフォルト

false

verifyAccessToken

verifyAccessToken: VerifyAccessTokenFunction;

アクセストークン (アクセストークン) を検証するための関数型。

この関数は、トークンが無効な場合は MCPAuthTokenVerificationError をスローし、有効な場合は AuthInfo オブジェクトを返す必要があります。

参照

VerifyAccessTokenFunction を参照してください。

プロパティ​

audience?​

参照​

issuer​

requiredScopes?​

showErrorDetails?​

デフォルト​

verifyAccessToken​

参照​