qlik-saas-api/dist/modules/User.d.ts

Interact with Qlik Sense SaaS REST API

import { QlikSaaSClient } from "qlik-rest-api";
export interface IUser {
    id: string;
    tenantId: string;
    subject: string;
    status: "active" | "invited" | "disabled" | "deleted";
    inviteExpiry: number;
    name: string;
    createdAt?: string;
    lastUpdatedAt?: string;
    picture: string;
    email: string;
    assignedRoles: IAssignedRole[];
    groups?: string[];
    assignedGroups?: IAssignedGroup[];
    zoneinfo: string;
    locale: string;
    preferredZoneinfo: string;
    preferredLocale: string;
    links: {
        self: {
            href: string;
        };
    };
}
export interface IAssignedGroup {
    id: string;
    name: string;
    assignedRoles?: IAssignedRole[];
}
export interface IAssignedRole {
    id: string;
    name: string;
    type: string;
    level: string;
    permissions: string[];
}
export interface IUserUpdate {
    path: "name" | "assignedRoles" | "inviteExpiry" | "zoneinfo" | "locale" | "preferredZoneinfo" | "preferredLocale" | "status" | string;
    value: string | {
        name: string;
    }[];
    op: "replace" | "add" | "renew";
}
export declare class User {
    #private;
    details: IUser;
    constructor(saasClient: QlikSaaSClient, id: string, details?: IUser);
    init(arg?: {
        force: boolean;
    }): Promise<void>;
    remove(): Promise<number>;
    update(arg: IUserUpdate[]): Promise<number>;
}