Type alias UserSchema

UserSchema: {
    created_by?: string;
    created_date: string;
    custom_attributes: {
        [key: string]: string;
    };
    email: string;
    first_name?: string;
    group_ids?: string[];
    has_temporary_password?: boolean;
    id: string;
    is_delete_protected?: boolean;
    is_group_admin?: boolean;
    is_org_admin?: boolean;
    is_project_admin?: boolean;
    last_name?: string;
    last_seen?: string;
    last_updated_by?: string;
    last_updated_date?: string;
    locale: string;
    mfa_enabled: boolean;
    middle_name?: string;
    new_password_required?: boolean;
    nickname?: string;
    org_permissions?: OrgAccessPermissions;
    password_last_changed?: string;
    phone_number?: string;
    phone_number_verified?: boolean;
    picture?: string;
    picture_base64?: string;
    picture_content_type?: string;
    preferred_mfa?: string;
    project_ids?: string[];
    project_permissions?: ProjectAccessPermissions;
    restricted_custom_attributes: {
        [key: string]: string;
    };
    role_ids?: string[];
    sms_mfa_enabled: boolean;
    software_mfa_enabled: boolean;
    tags: string[];
    username: string;
    zoneinfo: string;
}

Type declaration

  • Optional created_by?: string

    ID of the user who created this account

  • created_date: string

    UTC datetime the account was created

  • custom_attributes: {
        [key: string]: string;
    }

    Custom attributes for this user

    • [key: string]: string
  • email: string
  • Optional first_name?: string
  • Optional group_ids?: string[]

    Groups they belong to, individual users only

  • Optional has_temporary_password?: boolean
  • id: string

    ID of the account

  • Optional is_delete_protected?: boolean
  • Optional is_group_admin?: boolean

    Whether this user is a group admin, only visible when filtered by group

  • Optional is_org_admin?: boolean
  • Optional is_project_admin?: boolean

    Whether this user is a project admin, only visible when filtered by project

  • Optional last_name?: string
  • Optional last_seen?: string

    UTC datetime the user was last seen

  • Optional last_updated_by?: string

    ID of the user who last updated this account

  • Optional last_updated_date?: string

    UTC datetime the account was last updated

  • locale: string
  • mfa_enabled: boolean

    Whether MFA is enabled for this user

  • Optional middle_name?: string
  • Optional new_password_required?: boolean
  • Optional nickname?: string
  • Optional org_permissions?: OrgAccessPermissions

    Organization permissions, only included for individual users

  • Optional password_last_changed?: string
  • Optional phone_number?: string
  • Optional phone_number_verified?: boolean
  • Optional picture?: string
  • Optional picture_base64?: string
  • Optional picture_content_type?: string
  • Optional preferred_mfa?: string

    Preferred MFA method for this user

  • Optional project_ids?: string[]

    Projects they belong to, individual users only

  • Optional project_permissions?: ProjectAccessPermissions

    Project permissions, only included for individual users in project scope

  • restricted_custom_attributes: {
        [key: string]: string;
    }

    Custom attributes only admins can update

    • [key: string]: string
  • Optional role_ids?: string[]

    Roles they belong to, individual users only

  • sms_mfa_enabled: boolean

    Whether SMS MFA is enabled for this user

  • software_mfa_enabled: boolean

    Whether software MFA is enabled for this user

  • tags: string[]

    Tags for this user

  • username: string
  • zoneinfo: string

Settings

Member Visibility

Theme