@archastro/sdk
    Preparing search index...

    Interface CurrentUser

    The authenticated user's profile, live session context, and optional effective access.

    interface CurrentUser {
        alias?: string | null;
        app?: string | null;
        app_name?: string | null;
        effective_access?: EffectiveAccess;
        email?: string | null;
        id: string;
        is_system_user: boolean;
        metadata?: Record<string, unknown>;
        name?: string | null;
        notification_settings: Record<string, unknown>;
        org?: string | null;
        org_kind?: "personal" | "company" | null;
        org_name?: string | null;
        org_role?: string | null;
        org_slug?: string | null;
        profile_picture?: ImageSource | null;
        sandbox?: string | null;
        sandbox_name?: string | null;
        timezone?: string | null;
    }
    Index

    Properties

    alias? app? app_name? effective_access? email? id is_system_user metadata? name? notification_settings org? org_kind? org_name? org_role? org_slug? profile_picture? sandbox? sandbox_name? timezone?

    Properties

    alias?: string | null

    Short handle or alias of the user.

    app?: string | null

    ID of the token-scoped app (dap_...).

    app_name?: string | null

    Display name of the token-scoped app.

    effective_access?: EffectiveAccess

    Present only when the request supplies one or more entitlement[] values.

    email?: string | null

    Email address of the user.

    id: string

    User ID (usr_...).

    is_system_user: boolean

    Whether the authenticated account is an internal system user.

    metadata?: Record<string, unknown>

    Arbitrary user metadata.

    name?: string | null

    Full display name of the user.

    notification_settings: Record<string, unknown>

    The authenticated user's notification preferences.

    org?: string | null

    ID of the current organization (org_...).

    org_kind?: "personal" | "company" | null

    Whether the current organization is company-domain or person-owned.

    org_name?: string | null

    Display name of the current organization.

    org_role?: string | null

    The authenticated user's role in the current organization.

    org_slug?: string | null

    Stable slug of the current organization.

    profile_picture?: ImageSource | null

    Resolved profile picture metadata.

    sandbox?: string | null

    ID of the current sandbox (sbx_...).

    sandbox_name?: string | null

    Display name of the current sandbox.

    timezone?: string | null

    The user's IANA timezone.

    Settings

    Member Visibility

    On This Page

    Properties