Type Alias TenantSettingsAPI

type TenantSettingsAPI = {
    clearCache: typeof clearCache;
    createTenantSettings: typeof createTenantSettings;
    deleteTenantSettings: typeof deleteTenantSettings;
    getStartPages: typeof getStartPages;
    getTenantSettings: typeof getTenantSettings;
    toggleCrossRegionDataProcessingTenantSettings: typeof toggleCrossRegionDataProcessingTenantSettings;
    updateTenantSettings: typeof updateTenantSettings;
}
Index

Properties

clearCache createTenantSettings deleteTenantSettings getStartPages getTenantSettings toggleCrossRegionDataProcessingTenantSettings updateTenantSettings

Properties

clearCache: typeof clearCache

Clears the cache for tenant-settings api requests.

createTenantSettings: typeof createTenantSettings

Creates a new tenant settings entry for the tenant ID specified in the JWT. This is access controlled by the permission admin.tenant-settings:create.

Param: body

an object with the body content

CreateTenantSettingsHttpError

deleteTenantSettings: typeof deleteTenantSettings

Deletes the tenant settings associated with the tenant ID specified in JWT. This is access controlled by the permission admin.tenant-settings:delete.

DeleteTenantSettingsHttpError

getStartPages: typeof getStartPages

Retrieves start pages for the tenant settings.

GetStartPagesHttpError

getTenantSettings: typeof getTenantSettings

Retrieves tenant settings associated with the tenant ID specified in JWT. This is access controlled by the permission admin.tenant-settings:read.

GetTenantSettingsHttpError

toggleCrossRegionDataProcessingTenantSettings: typeof toggleCrossRegionDataProcessingTenantSettings

Sets the cross region inference setting for the tenant. Creates tenant settings if none exist, or updates existing settings. This is access controlled by the permission admin.tenant-settings:update. When cross-region processing is required, you must include an additional header x-qlik-consent-verified: true in your API requests to confirm that you have the authority to enable this feature and accept the associated terms.

Param: body

an object with the body content

ToggleCrossRegionDataProcessingTenantSettingsHttpError

updateTenantSettings: typeof updateTenantSettings

Updates existing tenant settings. This is access controlled by the permission admin.tenant-settings:update.

Param: body

an object with the body content

UpdateTenantSettingsHttpError

Settings

Member Visibility

On This Page

Properties