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

Interact with Qlik Sense SaaS REST API

import { QlikSaaSClient } from "qlik-rest-api";
export interface IUserActionsInvite {
    /**
     * Optional display name for this invitee. Example - "Elvis Presley"
     */
    name?: string;
    /**
     * Email address for this invitee. Example - "foo@qlik.com"
     */
    email: string;
    /**
     * Flag - when true invite message is sent to inactive or invited users.
     * Typically used to force email resend to users who are not yet active
     */
    resend?: boolean;
    /**
     * Optional ISO 639-1 2 letter code for invite language.
     * Defaults to 'en' when missing or not found.
     */
    language?: string;
}
export declare class UsersActions {
    #private;
    constructor(saasClient: QlikSaaSClient);
    /**
     * Returns the number of users in a given tenant
     * @returns {object} { total: number }
     *
     * Rate limit: Tier 1 (1000 requests per minute)
     */
    count(): Promise<any>;
    /**
     * Invite one or more users by email address
     *
     * Rate limit: Tier 2 (100 requests per minute)
     */
    invite(arg: IUserActionsInvite[]): Promise<any>;
}