Hiyve Components - v1.0.0
    Preparing search index...

    Interface UserProfile

    User profile from the platform database.

    Profiles are auto-created during registration and login. Admin endpoints return this shape with sensitive fields (apiKey, secret) excluded.

    interface UserProfile {
        active: boolean;
        brandOrgId: string;
        created?: string;
        createdAt?: string;
        email: string;
        id: string;
        metadata?: Record<string, unknown>;
        name: string;
        onboardingCompleted?: boolean;
        organization?: string;
        phone?: string;
        picture?: string;
        roles?: string[];
        updatedAt?: string;
    }
    Index

    Properties

    active brandOrgId created? createdAt? email id metadata? name onboardingCompleted? organization? phone? picture? roles? updatedAt?

    Properties

    active: boolean

    Whether the profile is active

    brandOrgId: string

    Organization ID this profile belongs to

    created?: string

    When the profile was created

    createdAt?: string
    email: string

    Email address

    id: string

    Profile ID (UUID string)

    metadata?: Record<string, unknown>

    Custom metadata

    name: string

    Display name

    onboardingCompleted?: boolean

    Whether onboarding is completed

    organization?: string

    Organization name

    phone?: string

    Phone number

    picture?: string

    Profile picture URL

    roles?: string[]

    Assigned roles

    updatedAt?: string

    Settings

    Member Visibility

    On This Page

    Properties