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

Interact with Qlik Sense SaaS REST API

import { QlikSaaSClient } from "qlik-rest-api";
export interface IKeyProvider {
    /**
     * The provider resource notation for the key
     */
    arn: string;
    /**
     * Name of key provider entry
     */
    name: string;
    /**
     * Indicates whether the key is being used to encrypt/decrypt secrets
     */
    current: boolean;
    /**
     * Tenant ID
     */
    tenantId: string;
    /**
     * When key entry was created
     */
    createdAt: string;
    /**
     * Description of key provider entry
     */
    description: string;
    /**
     * Key Provider type.
     *
     * At the moment only "AWS-KMS" (12/2023)
     */
    keyProvider: string;
    /**
     * Indicated whether the key has multi-region configuration and has replica key in qcs secondary region
     */
    multiRegion: boolean;
    replicaKeys: {
        /**
         * Replica key keeps list of backup keys from the supported qcs secondary region
         */
        arn: string;
        /**
         * Region indicates the backup qcs-region link to the primary region
         */
        region: string;
    }[];
    /**
     * The ARN fingerprint
     */
    arnFingerPrint: string;
    /**
     * When the key was promoted to being current active one
     */
    promotedToCurrentAt: string;
    /**
     * When the ley was demoted from being current to non active
     */
    demotedFromCurrentAt: string;
}
export declare class KeyProvider {
    #private;
    details: IKeyProvider;
    constructor(saasClient: QlikSaaSClient, id: string, details?: IKeyProvider);
    init(arg?: {
        force: boolean;
    }): Promise<void>;
    remove(): Promise<number>;
    /**
     * Patches Name & Description of keyprovider information
     */
    patch(arg: {
        op: string;
        path: string;
        value: string;
    }[]): Promise<number>;
    /**
     * Migrates existing cipher keys from current key provider to requested key provider
     */
    migrate(): Promise<any>;
    /**
     * Validates AWS-KMS key access and usage
     */
    test(): Promise<any>;
}