Type Alias TenantsAPI

type TenantsAPI = {
    clearCache: typeof clearCache;
    createTenant: typeof createTenant;
    deactivateTenant: typeof deactivateTenant;
    getMyTenant: typeof getMyTenant;
    getTenant: typeof getTenant;
    patchTenant: typeof patchTenant;
    reactivateTenant: typeof reactivateTenant;
}
Index

Properties

clearCache: typeof clearCache

Clears the cache for tenants api requests.

createTenant: typeof createTenant

Creates a tenant in the requested region, linked to the provided license key. You must use a regional OAuth client generated via the My Qlik portal to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. https://register.us.qlikcloud.com/api/v1/tenants if interacting with tenants in the us region.

an object with the body content

CreateTenantHttpError

deactivateTenant: typeof deactivateTenant

Deactivates a specific tenant. Once deactivated, tenant will be deleted on or after estimatedPurgeDate. Tenant can be reactivated using /v1/tenants/{tenantId}/actions/reactivate until this date. You must use a regional OAuth client generated via the My Qlik portal to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/deactivate if interacting with tenants in the us region.

The id of the tenant to deactivate

an object with the body content

DeactivateTenantHttpError

getMyTenant: typeof getMyTenant

Redirects to current tenant.

GetMyTenantHttpError

getTenant: typeof getTenant

Retrieves a specific tenant by ID.

The ID of the tenant to retrieve

GetTenantHttpError

patchTenant: typeof patchTenant

Updates properties of a specific tenant by ID.

The ID of the tenant to update

an object with the body content

PatchTenantHttpError

reactivateTenant: typeof reactivateTenant

Reactivates a deactivated tenant. Tenants can be reactivated until the estimatedPurgeDate provided at time of deactivation. You must use a regional OAuth client generated via the My Qlik portal to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/reactivate if interacting with tenants in the us region.

The id of the tenant to reactivate

an object with the body content

ReactivateTenantHttpError