Interface EncryptionAPI

interface EncryptionAPI {
    clearCache: () => void;
    createEncryptionKeyprovider: (
        body: KeyProvider,
        options?: ApiCallOptions,
    ) => Promise<CreateEncryptionKeyproviderHttpResponse>;
    deleteEncryptionKeyprovider: (
        arnFingerPrint: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteEncryptionKeyproviderHttpResponse>;
    getEncryptionKeyprovider: (
        arnFingerPrint: string,
        options?: ApiCallOptions,
    ) => Promise<GetEncryptionKeyproviderHttpResponse>;
    getEncryptionKeyproviders: (
        options?: ApiCallOptions,
    ) => Promise<GetEncryptionKeyprovidersHttpResponse>;
    getEncryptionKeyprovidersMigrationDetails: (
        options?: ApiCallOptions,
    ) => Promise<GetEncryptionKeyprovidersMigrationDetailsHttpResponse>;
    listEncryptionKeyproviders: (
        options?: ApiCallOptions,
    ) => Promise<ListEncryptionKeyprovidersHttpResponse>;
    migrateEncryptionKeyprovider: (
        arnFingerPrint: string,
        options?: ApiCallOptions,
    ) => Promise<MigrateEncryptionKeyproviderHttpResponse>;
    patchEncryptionKeyprovider: (
        arnFingerPrint: string,
        body: KeyProviderPatchSchema,
        options?: ApiCallOptions,
    ) => Promise<PatchEncryptionKeyproviderHttpResponse>;
    resetEncryptionKeyproviders: (
        options?: ApiCallOptions,
    ) => Promise<ResetEncryptionKeyprovidersHttpResponse>;
    testEncryptionKeyprovider: (
        arnFingerPrint: string,
        options?: ApiCallOptions,
    ) => Promise<TestEncryptionKeyproviderHttpResponse>;
}
Index

Properties

clearCache createEncryptionKeyprovider deleteEncryptionKeyprovider getEncryptionKeyprovider getEncryptionKeyproviders getEncryptionKeyprovidersMigrationDetails listEncryptionKeyproviders migrateEncryptionKeyprovider patchEncryptionKeyprovider resetEncryptionKeyproviders testEncryptionKeyprovider

Properties

clearCache: () => void

Clears the cache for encryption api requests.

Type declaration

    • (): void

    • Clears the cache for encryption api requests.

      Returns void

createEncryptionKeyprovider: (
    body: KeyProvider,
    options?: ApiCallOptions,
) => Promise<CreateEncryptionKeyproviderHttpResponse>

The AWS-KMS key configuration must match the Qlik Cloud region configuration requirements. Most regions should have a key deployed to the same AWS region as the Qlik Cloud tenant, with a replica key in the relevant Qlik Cloud DR region. Consult the documentation for DR region mappings.

Type declaration

Param: body

an object with the body content

CreateEncryptionKeyproviderHttpError

deleteEncryptionKeyprovider: (
    arnFingerPrint: string,
    options?: ApiCallOptions,
) => Promise<DeleteEncryptionKeyproviderHttpResponse>

Delete a key configuration from the tenant. Not supported for the default Qlik managed key provider. Key must not be in use.

Type declaration

The fingerprint of the key provider you wish to delete.

DeleteEncryptionKeyproviderHttpError

getEncryptionKeyprovider: (
    arnFingerPrint: string,
    options?: ApiCallOptions,
) => Promise<GetEncryptionKeyproviderHttpResponse>

Retrieve key provider detail by passing the ARN fingerprint as parameter.

Type declaration

The fingerprint of the requested provider key.

GetEncryptionKeyproviderHttpError

getEncryptionKeyproviders: (
    options?: ApiCallOptions,
) => Promise<GetEncryptionKeyprovidersHttpResponse>

Returns a list of AWS key providers in the tenant. Use /actions/list to return all key providers.

Type declaration

GetEncryptionKeyprovidersHttpError

getEncryptionKeyprovidersMigrationDetails: (
    options?: ApiCallOptions,
) => Promise<GetEncryptionKeyprovidersMigrationDetailsHttpResponse>

Retrieve details for the ongoing or last completed migration for the tenant.

Type declaration

GetEncryptionKeyprovidersMigrationDetailsHttpError

listEncryptionKeyproviders: (
    options?: ApiCallOptions,
) => Promise<ListEncryptionKeyprovidersHttpResponse>

Returns a list of all key providers in the tenant, including the default Qlik key provider.

Type declaration

ListEncryptionKeyprovidersHttpError

migrateEncryptionKeyprovider: (
    arnFingerPrint: string,
    options?: ApiCallOptions,
) => Promise<MigrateEncryptionKeyproviderHttpResponse>

Migrate the active key from one provider to another. The migration process may take some time to complete, however this process will not impact users, and the tenant will continue to function normally during the migration. Use the migration details endpoint to monitor migration progress.

Type declaration

    • (
          arnFingerPrint: string,
          options?: ApiCallOptions,
      ): Promise<MigrateEncryptionKeyproviderHttpResponse>

    • Migrate the active key from one provider to another. The migration process may take some time to complete, however this process will not impact users, and the tenant will continue to function normally during the migration. Use the migration details endpoint to monitor migration progress.

      Parameters

      • arnFingerPrint: string

        The fingerprint of an existing key provider key.

      • Optionaloptions: ApiCallOptions

      Returns Promise<MigrateEncryptionKeyproviderHttpResponse>

      MigrateEncryptionKeyproviderHttpError

The fingerprint of an existing key provider key.

MigrateEncryptionKeyproviderHttpError

patchEncryptionKeyprovider: (
    arnFingerPrint: string,
    body: KeyProviderPatchSchema,
    options?: ApiCallOptions,
) => Promise<PatchEncryptionKeyproviderHttpResponse>

Update the name and/or description of a key provider.

Type declaration

The ARN fingerprint of an existing key provider key.

Param: body

an object with the body content

PatchEncryptionKeyproviderHttpError

resetEncryptionKeyproviders: (
    options?: ApiCallOptions,
) => Promise<ResetEncryptionKeyprovidersHttpResponse>

Reset the encryption key back to the default Qlik managed provider. No action will be taken if tenant is already using the Qlik provider.

Type declaration

ResetEncryptionKeyprovidersHttpError

testEncryptionKeyprovider: (
    arnFingerPrint: string,
    options?: ApiCallOptions,
) => Promise<TestEncryptionKeyproviderHttpResponse>

Validate a key to check if Qlik Cloud has required access to your AWS account and key policy, and the key configuration. If the key policy or configuration are changed from the required configuration, this may impact your ability to access your tenant.

Type declaration

    • (
          arnFingerPrint: string,
          options?: ApiCallOptions,
      ): Promise<TestEncryptionKeyproviderHttpResponse>

    • Validate a key to check if Qlik Cloud has required access to your AWS account and key policy, and the key configuration. If the key policy or configuration are changed from the required configuration, this may impact your ability to access your tenant.

      Parameters

      • arnFingerPrint: string

        The fingerprint of an existing key provider key.

      • Optionaloptions: ApiCallOptions

      Returns Promise<TestEncryptionKeyproviderHttpResponse>

      TestEncryptionKeyproviderHttpError

The fingerprint of an existing key provider key.

TestEncryptionKeyproviderHttpError

Settings

Member Visibility

On This Page

Properties