MCP TypeScript SDK (V2)
    Preparing search index...

    Interface PrivateKeyJwtProviderOptions

    Options for creating a PrivateKeyJwtProvider.

    interface PrivateKeyJwtProviderOptions {
        algorithm: string;
        claims?: Record<string, unknown>;
        clientId: string;
        clientName?: string;
        jwtLifetimeSeconds?: number;
        privateKey: string | Record<string, unknown> | Uint8Array<ArrayBufferLike>;
        scope?: string;
    }
    Index

    Properties

    algorithm claims? clientId clientName? jwtLifetimeSeconds? privateKey scope?

    Properties

    algorithm: string

    The algorithm to use for signing (e.g., 'RS256', 'ES256').

    claims?: Record<string, unknown>

    Optional custom claims to include in the JWT assertion. These are merged with the standard claims (iss, sub, aud, exp, iat, jti), with custom claims taking precedence for any overlapping keys.

    Useful for including additional claims that help scope the access token with finer granularity than what scopes alone allow.

    clientId: string

    The client_id for this OAuth client.

    clientName?: string

    Optional client name for metadata.

    jwtLifetimeSeconds?: number

    Optional JWT lifetime in seconds (default: 300).

    privateKey: string | Record<string, unknown> | Uint8Array<ArrayBufferLike>

    The private key for signing JWT assertions. Can be a PEM string, Uint8Array, or JWK object.

    scope?: string

    Space-separated scopes values requested by the client.

    Settings

    Member Visibility

    On This Page

    Properties