mcp-use TypeScript API
    Preparing search index...

    Interface KeycloakOAuthUser

    Verified Keycloak user and role claims exposed to authenticated MCP callbacks.

    interface KeycloakOAuthUser {
        email?: string;
        emailVerified?: boolean;
        familyName?: string;
        givenName?: string;
        id: string;
        name?: string;
        preferredUsername?: string;
        realmAccess?: Record<string, unknown>;
        resourceAccess?: Record<string, unknown>;
        roles: string[];
    }
    Index
    email? emailVerified? familyName? givenName? id name? preferredUsername? realmAccess? resourceAccess? roles
    email?: string

    Primary email address, when included in the access token.

    emailVerified?: boolean

    Whether Keycloak has verified KeycloakOAuthUser.email.

    familyName?: string

    Family name, when included in the access token.

    givenName?: string

    Given name, when included in the access token.

    id: string

    Keycloak subject identifier.

    name?: string

    Display name, when included in the access token.

    preferredUsername?: string

    Preferred username, when included in the access token.

    realmAccess?: Record<string, unknown>

    Unmodified realm_access claim, when present.

    resourceAccess?: Record<string, unknown>

    Unmodified resource_access claim, when present.

    roles: string[]

    Realm roles from realm_access.roles.

    Settings
    Member Visibility

    On This Page
    Properties