型エイリアス: BearerAuthConfig

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

プロパティ

audience?

optional audience: string;

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

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

参照

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

issuer

issuer: 
  | string
  | ValidateIssuerFunction;

有効な発行者 (Issuer) を表す文字列、またはアクセストークンの発行者を検証するための関数。

文字列が指定された場合、それが期待される発行者 (Issuer) の値として直接比較に使用されます。

関数が指定された場合は、ValidateIssuerFunction のルールに従って発行者 (Issuer) を検証する必要があります。

参照

ValidateIssuerFunction で検証関数の詳細を確認できます。

requiredScopes?

optional requiredScopes: string[];

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

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

resource?

optional resource: string;

保護されたリソースの識別子。指定された場合、ハンドラーはこのリソース用に設定された認可サーバーを使用して受信したトークンを検証します。protectedResources 設定とともにハンドラーを使用する場合は必須です。

showErrorDetails?

optional showErrorDetails: boolean;

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

デフォルト

false

verifyAccessToken

verifyAccessToken: VerifyAccessTokenFunction;

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

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

参照

VerifyAccessTokenFunction で詳細を確認できます。

プロパティ​

audience?​

参照​

issuer​

参照​

requiredScopes?​

resource?​

showErrorDetails?​

デフォルト​

verifyAccessToken​

参照​