Interface TenantsAPI

interface TenantsAPI {
    clearCache: () => void;
    createTenant: (
        body: TenantCreationRequest,
        options?: ApiCallOptions,
    ) => Promise<CreateTenantHttpResponse>;
    deactivateTenant: (
        tenantId: string,
        body: TenantDeactivateRequest,
        options?: ApiCallOptions,
    ) => Promise<DeactivateTenantHttpResponse>;
    getMyTenant: (options?: ApiCallOptions) => Promise<GetMyTenantHttpResponse>;
    getTenant: (
        tenantId: string,
        options?: ApiCallOptions,
    ) => Promise<GetTenantHttpResponse>;
    patchTenant: (
        tenantId: string,
        body: TenantPatchSchema,
        options?: ApiCallOptions,
    ) => Promise<PatchTenantHttpResponse>;
    reactivateTenant: (
        tenantId: string,
        body: unknown,
        options?: ApiCallOptions,
    ) => Promise<ReactivateTenantHttpResponse>;
}
Index

Properties

clearCache createTenant deactivateTenant getMyTenant getTenant patchTenant reactivateTenant

Properties

clearCache: () => void

Clears the cache for tenants api requests.

Type Declaration

    • (): void

    • Clears the cache for tenants api requests.

      Returns void

createTenant: (
    body: TenantCreationRequest,
    options?: ApiCallOptions,
) => Promise<CreateTenantHttpResponse>

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.

Type Declaration

    • (
          body: TenantCreationRequest,
          options?: ApiCallOptions,
      ): Promise<CreateTenantHttpResponse>

    • 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.

      Parameters

      Returns Promise<CreateTenantHttpResponse>

      CreateTenantHttpError

Param: body

an object with the body content

CreateTenantHttpError

deactivateTenant: (
    tenantId: string,
    body: TenantDeactivateRequest,
    options?: ApiCallOptions,
) => Promise<DeactivateTenantHttpResponse>

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.

Type Declaration

    • (
          tenantId: string,
          body: TenantDeactivateRequest,
          options?: ApiCallOptions,
      ): Promise<DeactivateTenantHttpResponse>

    • 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.

      Parameters

      Returns Promise<DeactivateTenantHttpResponse>

      DeactivateTenantHttpError

The id of the tenant to deactivate

Param: body

an object with the body content

DeactivateTenantHttpError

getMyTenant: (options?: ApiCallOptions) => Promise<GetMyTenantHttpResponse>

Redirects to current tenant.

Type Declaration

GetMyTenantHttpError

getTenant: (
    tenantId: string,
    options?: ApiCallOptions,
) => Promise<GetTenantHttpResponse>

Retrieves a specific tenant by ID.

Type Declaration

The ID of the tenant to retrieve

GetTenantHttpError

patchTenant: (
    tenantId: string,
    body: TenantPatchSchema,
    options?: ApiCallOptions,
) => Promise<PatchTenantHttpResponse>

Updates properties of a specific tenant by ID.

Type Declaration

The ID of the tenant to update

Param: body

an object with the body content

PatchTenantHttpError

reactivateTenant: (
    tenantId: string,
    body: unknown,
    options?: ApiCallOptions,
) => Promise<ReactivateTenantHttpResponse>

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.

Type Declaration

    • (
          tenantId: string,
          body: unknown,
          options?: ApiCallOptions,
      ): Promise<ReactivateTenantHttpResponse>

    • 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.

      Parameters

      • tenantId: string

        The id of the tenant to reactivate

      • body: unknown

        an object with the body content

      • Optionaloptions: ApiCallOptions

      Returns Promise<ReactivateTenantHttpResponse>

      ReactivateTenantHttpError

The id of the tenant to reactivate

Param: body

an object with the body content

ReactivateTenantHttpError

Settings

Member Visibility

On This Page

Properties