@archastro/sdk
    Preparing search index...

    Interface User

    A platform user account. Represents a human or system actor that can own threads, belong to an organization, and interact with the API.

    interface User {
        alias?: string;
        app?: string;
        app_name?: string;
        email?: string;
        id: string;
        is_system_user?: boolean;
        metadata?: Record<string, unknown>;
        name?: string;
        org?: string;
        org_name?: string;
        org_role?: string;
        sandbox?: string;
        sandbox_name?: string;
    }
    Index

    Properties

    alias? app? app_name? email? id is_system_user? metadata? name? org? org_name? org_role? sandbox? sandbox_name?

    Properties

    alias?: string

    Short handle or alias for the user. null if not set.

    app?: string

    ID of the app this user (and their access token) is scoped to (dap_...). null if the user is not scoped to an app.

    app_name?: string

    Display name of the user's app. null when the app association was not preloaded by the caller.

    email?: string

    Email address of the user.

    id: string

    User ID (usr_...).

    is_system_user?: boolean

    true if this account is an internal system user rather than a human. System users are created automatically by the platform.

    metadata?: Record<string, unknown>

    Arbitrary key-value metadata attached to the user. Defaults to an empty object.

    name?: string

    Full display name of the user. null if the user has not set a name.

    org?: string

    ID of the organization this user belongs to (org_...). null if the user is not a member of any organization.

    org_name?: string

    Display name of the user's organization. null when the user is not in an org, or when the org association was not preloaded by the caller.

    org_role?: string

    Role of the user within their organization. One of "admin", "member", or "viewer". null when the user is not a member of any organization.

    sandbox?: string

    ID of the sandbox environment this user is scoped to (sbx_...). null for production users.

    sandbox_name?: string

    Display name of the user's sandbox environment. null for production users, or when the sandbox association was not preloaded by the caller.

    Settings

    Member Visibility

    On This Page

    Properties