Class KeyProvider

constructor

• new KeyProvider(saasClient, id, details?): KeyProvider

• Parameters

  • saasClient: QlikSaaSClient

  • id: string

  • Optional details: IKeyProvider

  Returns KeyProvider

details

init

• init(arg?): Promise<void>

• Parameters

  • Optional arg: {
        force: boolean;
    }

    • force: boolean

  Returns Promise<void>

migrate

• migrate(): Promise<IMigrationInformation>

• Migrates existing cipher keys from current key provider to requested key provider

  Returns Promise<IMigrationInformation>

patch

• patch(arg): Promise<number>

• Patches Name & Description of keyprovider information

  Parameters

  • arg: {
        op: string;
        path: string;
        value: string;
    }[]

  Returns Promise<number>

remove

• remove(): Promise<number>

• Returns Promise<number>

test

• test(): Promise<IKeyProvider>

• Validates AWS-KMS key access and usage

  Returns Promise<IKeyProvider>