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

Interact with Qlik Sense SaaS REST API

import { QlikSaaSClient } from "qlik-rest-api";
import { IKeyProvider, KeyProvider } from "./KeyProvider";
import { KeepRequired } from "../types/types";
export interface IMigrationInformation {
    /**
     * Migration operation ID
     */
    id: string;
    /**
     * Migration operation state
     */
    state: "New" | "InProgress" | "Completed";
    /**
     * Progress in percentage
     */
    progress: number;
    tenantId: string;
    completedAt: string;
    initiatedAt: string;
    /**
     * The nre key ARN that keys should be migrated to
     */
    migratingTo: string;
    /**
     * The key ARN bing migrated from (in case of QlikVault, could be a short name only)
     */
    migratingFrom: string;
    /**
     * The nre key prefix (to help services know which prefix should NOT be migrated)
     */
    migratingToPrefix: string;
    /**
     * The nre ARN fingerprint
     */
    migratingToFingerprint: string;
}
export declare class Encryptions {
    #private;
    constructor(saasClient: QlikSaaSClient);
    get(arg: {
        id: string;
    }): Promise<KeyProvider>;
    /**
     * Lists keyproviders registered for the tenant
     */
    getAll(): Promise<any>;
    /**
     * Lists keyproviders registered for the tenant [Qlik, AWS-KMS]
     */
    list(): Promise<any>;
    /**
     * Gets ongoing migration details
     */
    migrationDetails(): Promise<any>;
    /**
     * Registers an AWS-KMS key for the specific tenant
     */
    create(arg: KeepRequired<IKeyProvider, "arn" | "name">): Promise<KeyProvider>;
    /**
     * Resets tenant key provider to Qlik managed provider
     */
    resetToDefaultProvider(): Promise<any>;
}