mcp-use TypeScript API
    Preparing search index...

    Interface WorkOSOAuthUser

    Verified WorkOS user and organization claims exposed to authenticated MCP callbacks.

    interface WorkOSOAuthUser {
        email?: string;
        emailVerified?: boolean;
        firstName?: string;
        id: string;
        lastName?: string;
        name?: string;
        organizationId?: string;
        picture?: string;
        preferredUsername?: string;
        roles: string[];
        sessionId?: string;
    }
    Index
    email? emailVerified? firstName? id lastName? name? organizationId? picture? preferredUsername? roles sessionId?
    email?: string

    Primary email address, when included in the access token.

    emailVerified?: boolean

    Whether WorkOS has verified WorkOSOAuthUser.email.

    firstName?: string

    Given name, when included in the access token.

    id: string

    WorkOS subject identifier.

    lastName?: string

    Family name, when included in the access token.

    name?: string

    Display name, when included in the access token.

    organizationId?: string

    Active WorkOS organization identifier.

    picture?: string

    Profile image URL, when included in the access token.

    preferredUsername?: string

    Preferred username, when included in the access token.

    roles: string[]

    Roles from the access token's roles claim.

    sessionId?: string

    WorkOS session identifier.

    Settings
    Member Visibility

    On This Page
    Properties