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

Interact with Qlik Sense SaaS REST API

import { QlikSaaSClient } from "qlik-rest-api";
import { User } from "./User";
import { UsersActions } from "./UsersActions";
export interface IUserCreate {
    tenantId: string;
    subject: string;
    name: string;
    picture?: string;
    email?: string;
    assignedRoles?: {
        name: string;
    }[];
    status?: string;
}
export declare class Users {
    #private;
    _actions: UsersActions;
    constructor(saasClient: QlikSaaSClient);
    /**
     * Info about the tenant accessing the endpoint
     */
    get(arg: {
        id: string;
    }): Promise<any>;
    /**
     * Retrieves a list of users matching the filter using an advanced query string
     * @param filter example:
     *     (id eq \"626949b9017b657805080bbd\" or id eq \"626949bf017b657805080bbe\") and (status eq \"active\" or status eq \"deleted\")
     * @param [sort] OPTIONAL name; +name; -name
     */
    getFilterNative(arg: {
        filter: string;
        sort?: string;
    }): Promise<any>;
    getFilter(arg: {
        filter: string;
    }): Promise<User[]>;
    removeFilter(arg: {
        filter: string;
    }): Promise<{
        id: string;
        status: number;
    }[]>;
    /**
     * Returns a list of users. Each element of the list is an instance of the User class
     */
    getAll(): Promise<any>;
    /**
     * Redirects to retrieve the user resource associated with the JWT claims
     */
    me(): Promise<User>;
    /**
     * @deprecated
     *
     * Returns the metadata with regard to the user configuration.
     *
     * Use GET /v1/roles instead
     *
     * It will no longer be available after 01/11/2022.
     * The role names can now be retrieved from the list roles endpoint.
     */
    metadata(): Promise<any>;
    /**
     * Creates an invited user
     */
    create(arg: IUserCreate): Promise<User>;
}