mcp-use TypeScript API
    Preparing search index...

    Interface WorkOSOAuthProviderOptions

    Configures WorkOS JWT verification and protected-resource metadata.

    interface WorkOSOAuthProviderOptions {
        requiredScopes?: readonly string[];
        resource?: string | URL;
        resourceName?: string;
        scopesSupported?: readonly string[];
        serviceDocumentationUrl?: URL;
        subdomain?: string;
    }

    Hierarchy (View Summary)

    Index
    requiredScopes? resource? resourceName? scopesSupported? serviceDocumentationUrl? subdomain?
    requiredScopes?: readonly string[]

    Endpoint-wide scopes enforced by the SDK bearer gate.

    resource?: string | URL

    Full canonical public MCP endpoint URL.

    resourceName?: string

    Human-readable name advertised by protected-resource metadata.

    scopesSupported?: readonly string[]

    Scopes advertised by protected-resource metadata.

    serviceDocumentationUrl?: URL

    Documentation URL advertised by protected-resource metadata.

    subdomain?: string

    AuthKit subdomain, with or without the https:// scheme.

    MCP_USE_OAUTH_WORKOS_SUBDOMAIN

    Settings
    Member Visibility

    On This Page
    Properties