@qlik/api 1.50.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api-keys.d.ts +3 -3
- package/api-keys.js +3 -3
- package/apps.d.ts +4 -4
- package/apps.js +20 -4
- package/assistants.d.ts +4 -4
- package/assistants.js +26 -8
- package/audits.d.ts +3 -3
- package/audits.js +3 -3
- package/auth-types.d.ts +1 -1
- package/auth-types.js +2 -2
- package/auth.d.ts +2 -2
- package/auth.js +3 -3
- package/automation-connections.d.ts +3 -3
- package/automation-connections.js +3 -3
- package/automation-connectors.d.ts +3 -3
- package/automation-connectors.js +3 -3
- package/automations.d.ts +3 -3
- package/automations.js +3 -3
- package/automl-deployments.d.ts +3 -3
- package/automl-deployments.js +3 -3
- package/automl-predictions.d.ts +3 -3
- package/automl-predictions.js +3 -3
- package/banners.d.ts +4 -0
- package/banners.js +50 -0
- package/brands.d.ts +3 -3
- package/brands.js +3 -3
- package/chunks/{api-keys-DbT9Z1_I.d.ts → api-keys-DS7LkwI8.d.ts} +1 -1
- package/chunks/{apps-C43wozsM.d.ts → apps-BR3gTz4F.d.ts} +45 -2
- package/chunks/{assistants-HRTG4mrK.d.ts → assistants-C_a4uNnT.d.ts} +75 -10
- package/chunks/{audits-CA-bllcf.d.ts → audits-BC_9Nsc3.d.ts} +1 -1
- package/chunks/{auth-BDcdoAcK.d.ts → auth-BYyDvXka.d.ts} +2 -2
- package/chunks/{auth-Dn3pvK1N.js → auth-DVfvT8TD.js} +2 -2
- package/chunks/{auth-functions-BZN9dCw1.js → auth-functions-C27LB1gE.js} +377 -225
- package/chunks/{auth-FQsMkh58.js → auth-sNi1A67-.js} +5 -5
- package/chunks/{auth-types-BK8AvfyD.d.ts → auth-types-CHOUViJI.d.ts} +38 -4
- package/chunks/{automation-connections-BRSXAkab.d.ts → automation-connections-Cyhb0FaN.d.ts} +1 -1
- package/chunks/{automation-connectors-Bx48-M4g.d.ts → automation-connectors-LrawaoDq.d.ts} +1 -1
- package/chunks/{automations-Dugu45RA.d.ts → automations-BYujmPxM.d.ts} +1 -1
- package/chunks/{automl-deployments-Boip7E0T.d.ts → automl-deployments-Bz4hIBQD.d.ts} +1 -1
- package/chunks/{automl-predictions-DdkRNsA7.d.ts → automl-predictions-DnnHn5n_.d.ts} +1 -1
- package/chunks/banners-C8iUbLA2.d.ts +184 -0
- package/chunks/{brands-jxEjeVGK.d.ts → brands-C_VLS_bl.d.ts} +1 -1
- package/chunks/{collections-DFvDeYCC.d.ts → collections-tmWJxgrt.d.ts} +1 -1
- package/chunks/{conditions-DpjEG64S.d.ts → conditions-XN35BSPh.d.ts} +1 -1
- package/chunks/{consumption-CGna485O.d.ts → consumption-DX2Ei4od.d.ts} +1 -1
- package/chunks/{csp-origins-Dm1bcm6D.d.ts → csp-origins-fyrVQMkf.d.ts} +1 -1
- package/chunks/{csrf-token-Dl422Xl8.d.ts → csrf-token-VrKslIAO.d.ts} +1 -1
- package/chunks/{data-alerts-Dsdht3R_.d.ts → data-alerts-Db2z8nxG.d.ts} +1 -1
- package/chunks/{data-assets-BvAuaPP1.d.ts → data-assets-COFtmbYv.d.ts} +1 -1
- package/chunks/{data-connections-DKs7Dj0l.d.ts → data-connections-CZmEfGNG.d.ts} +1 -1
- package/chunks/{data-credentials-Dz7QHnsV.d.ts → data-credentials-BJteSNF-.d.ts} +1 -1
- package/chunks/{data-files-DwaxubSK.d.ts → data-files-E3LDdwu9.d.ts} +1 -1
- package/chunks/{data-qualities-D_epSJNj.d.ts → data-qualities-CDgLWYzn.d.ts} +1 -1
- package/chunks/{data-sets-BCB4zxdl.d.ts → data-sets-DS9oCHyh.d.ts} +1 -1
- package/chunks/{data-sources-C6bpRD99.d.ts → data-sources-CsARydcs.d.ts} +1 -1
- package/chunks/{data-stores-NpZrP7K-.d.ts → data-stores-BrMPbFTB.d.ts} +1 -1
- package/chunks/{dcaas-BjVAcAO6.d.ts → dcaas-BOgO88is.d.ts} +1 -1
- package/chunks/{di-projects-CERxkUMp.d.ts → di-projects-6CTj-fZS.d.ts} +1 -1
- package/chunks/{direct-access-agents-C2TyK9Om.d.ts → direct-access-agents-DqkZJgCw.d.ts} +122 -141
- package/chunks/{dist-BrtkK7jD.js → dist-CdktrY2F.js} +1 -1
- package/chunks/{encryption-Dt4C0z0P.d.ts → encryption-38eI7xaM.d.ts} +1 -1
- package/chunks/{extensions-Pk0ruRJq.d.ts → extensions-BY1bBIwI.d.ts} +1 -1
- package/chunks/{glossaries-D2HtaKNg.d.ts → glossaries-DOGETgAy.d.ts} +13 -1
- package/chunks/{groups-D-PlPew1.d.ts → groups-B5ZSHoU7.d.ts} +1 -1
- package/chunks/{identity-providers-Ok9gc5iT.d.ts → identity-providers-B95UphQ7.d.ts} +1 -1
- package/chunks/{interceptors-rFmTB6_g.d.ts → interceptors-BoGH3CGy.d.ts} +1 -1
- package/chunks/{interceptors-CT9deBo6.js → interceptors-DoQ44M-n.js} +1 -1
- package/chunks/{invoke-fetch-DtTuA_q4.js → invoke-fetch-CSpyWLUQ.js} +5 -5
- package/chunks/{invoke-fetch-Cn50MiSD.js → invoke-fetch-CoW3QRhJ.js} +3 -3
- package/chunks/{items-CkrahlyK.d.ts → items-prd2PJHL.d.ts} +1 -1
- package/chunks/{knowledgebases-pIPPYuHk.d.ts → knowledgebases-nV7L0G3L.d.ts} +101 -19
- package/chunks/{licenses-BDGenUQ0.d.ts → licenses-CVBtRLsB.d.ts} +3 -2
- package/chunks/{lineage-graphs-COYOm9O0.d.ts → lineage-graphs-DH3iZ45F.d.ts} +1 -1
- package/chunks/{ml-D2FKGXFm.d.ts → ml-C4ZfC5E0.d.ts} +24 -2
- package/chunks/{notes-CFJqzuUp.d.ts → notes-BmZ3kWFF.d.ts} +1 -1
- package/chunks/{notifications-BWMWcQ8e.d.ts → notifications-DpmHo21D.d.ts} +1 -1
- package/chunks/{oauth-clients-DM8IIacl.d.ts → oauth-clients-lKvXqnlf.d.ts} +1 -1
- package/chunks/{oauth-tokens-oGIAStpb.d.ts → oauth-tokens-I1GXV-Pm.d.ts} +1 -1
- package/chunks/{public-runtime-modules-DNHVdCZ6.js → public-runtime-modules-DiFgGaqr.js} +5 -5
- package/chunks/{qix-DhKyOvuL.d.ts → qix-BJgISmMN.d.ts} +2 -2
- package/chunks/{qix-Dcn0HIU3.js → qix-BpdRtXWA.js} +22 -23
- package/chunks/{qix-6XcsO79b.js → qix-DCY6Rh2X.js} +1 -1
- package/chunks/{qix-chunk-entrypoint-DJIP0GL8.js → qix-chunk-entrypoint-C_zIcxOU.js} +24 -29
- package/chunks/{questions-D3rmb5fT.d.ts → questions-DPgcX6l6.d.ts} +1 -1
- package/chunks/{quotas-nRoaBvEh.d.ts → quotas-ja_K_-Na.d.ts} +1 -1
- package/chunks/{reload-tasks-B_fM3dm3.d.ts → reload-tasks-BiMX4_zH.d.ts} +1 -1
- package/chunks/{reloads-BghgP4x5.d.ts → reloads-BhEQHvZ_.d.ts} +1 -1
- package/chunks/{report-templates-BysNWNES.d.ts → report-templates-CC5GHDZP.d.ts} +1 -1
- package/chunks/{reports-HcNch5zc.d.ts → reports-gdDevE7G.d.ts} +1 -1
- package/chunks/{roles-8LE3mqCV.d.ts → roles-CI51tqVy.d.ts} +1 -1
- package/chunks/{sharing-tasks-C9fFGIeY.d.ts → sharing-tasks-OVGdU-Zj.d.ts} +12 -2
- package/chunks/{spaces-ByIVxNlR.d.ts → spaces-mALfyUk6.d.ts} +1 -1
- package/chunks/{tasks-BwYCg-5D.d.ts → tasks-C5LAAjFh.d.ts} +1 -1
- package/chunks/{temp-contents-Ceko2teM.d.ts → temp-contents-BetQz-oE.d.ts} +1 -1
- package/chunks/{tenants-BLvD3HVW.d.ts → tenants-BxH2KOTB.d.ts} +1 -1
- package/chunks/{themes-85kaWWsU.d.ts → themes-39I0zONl.d.ts} +1 -1
- package/chunks/{transports-BAGpIam_.d.ts → transports-Dw6UqnWY.d.ts} +5 -1
- package/chunks/{ui-config-dinJFzBx.d.ts → ui-config-Dn289HpY.d.ts} +1 -1
- package/chunks/{users-BrgjDU7L.d.ts → users-dL3ip5Hd.d.ts} +25 -46
- package/chunks/{web-integrations-Gy6aaK2p.d.ts → web-integrations-Cl2WklQh.d.ts} +1 -1
- package/chunks/{web-notifications-DoOenzCC.d.ts → web-notifications-B5An9uEB.d.ts} +1 -1
- package/chunks/{webhooks-CfRb9HB1.d.ts → webhooks-CrKlLCv7.d.ts} +82 -76
- package/collections.d.ts +3 -3
- package/collections.js +3 -3
- package/conditions.d.ts +3 -3
- package/conditions.js +3 -3
- package/consumption.d.ts +3 -3
- package/consumption.js +3 -3
- package/csp-origins.d.ts +3 -3
- package/csp-origins.js +3 -3
- package/csrf-token.d.ts +3 -3
- package/csrf-token.js +3 -3
- package/data-alerts.d.ts +3 -3
- package/data-alerts.js +3 -3
- package/data-assets.d.ts +3 -3
- package/data-assets.js +3 -3
- package/data-connections.d.ts +3 -3
- package/data-connections.js +3 -3
- package/data-credentials.d.ts +3 -3
- package/data-credentials.js +3 -3
- package/data-files.d.ts +3 -3
- package/data-files.js +3 -3
- package/data-qualities.d.ts +3 -3
- package/data-qualities.js +3 -3
- package/data-sets.d.ts +3 -3
- package/data-sets.js +3 -3
- package/data-sources.d.ts +3 -3
- package/data-sources.js +3 -3
- package/data-stores.d.ts +3 -3
- package/data-stores.js +3 -3
- package/dcaas.d.ts +3 -3
- package/dcaas.js +3 -3
- package/di-projects.d.ts +3 -3
- package/di-projects.js +3 -3
- package/direct-access-agents.d.ts +4 -4
- package/direct-access-agents.js +54 -81
- package/encryption.d.ts +3 -3
- package/encryption.js +3 -3
- package/extensions.d.ts +3 -3
- package/extensions.js +3 -3
- package/global-types.d.ts +1 -1
- package/global-types.js +1 -1
- package/glossaries.d.ts +3 -3
- package/glossaries.js +3 -3
- package/groups.d.ts +3 -3
- package/groups.js +3 -3
- package/identity-providers.d.ts +3 -3
- package/identity-providers.js +3 -3
- package/index.d.ts +70 -66
- package/index.js +25 -10
- package/interceptors.d.ts +3 -3
- package/interceptors.js +2 -2
- package/invoke-fetch-types.d.ts +1 -1
- package/items.d.ts +3 -3
- package/items.js +3 -3
- package/knowledgebases.d.ts +4 -4
- package/knowledgebases.js +22 -4
- package/licenses.d.ts +3 -3
- package/licenses.js +3 -3
- package/lineage-graphs.d.ts +3 -3
- package/lineage-graphs.js +3 -3
- package/ml.d.ts +3 -3
- package/ml.js +3 -3
- package/notes.d.ts +3 -3
- package/notes.js +3 -3
- package/notifications.d.ts +3 -3
- package/notifications.js +3 -3
- package/oauth-clients.d.ts +3 -3
- package/oauth-clients.js +3 -3
- package/oauth-tokens.d.ts +3 -3
- package/oauth-tokens.js +3 -3
- package/package.json +3 -2
- package/qix.d.ts +3 -3
- package/qix.js +3 -3
- package/questions.d.ts +3 -3
- package/questions.js +3 -3
- package/quotas.d.ts +3 -3
- package/quotas.js +3 -3
- package/reload-tasks.d.ts +3 -3
- package/reload-tasks.js +3 -3
- package/reloads.d.ts +3 -3
- package/reloads.js +3 -3
- package/report-templates.d.ts +3 -3
- package/report-templates.js +3 -3
- package/reports.d.ts +3 -3
- package/reports.js +3 -3
- package/roles.d.ts +3 -3
- package/roles.js +3 -3
- package/sharing-tasks.d.ts +4 -4
- package/sharing-tasks.js +3 -3
- package/spaces.d.ts +3 -3
- package/spaces.js +3 -3
- package/tasks.d.ts +3 -3
- package/tasks.js +3 -3
- package/temp-contents.d.ts +3 -3
- package/temp-contents.js +3 -3
- package/tenants.d.ts +3 -3
- package/tenants.js +3 -3
- package/themes.d.ts +3 -3
- package/themes.js +3 -3
- package/transports.d.ts +3 -3
- package/transports.js +5 -3
- package/ui-config.d.ts +3 -3
- package/ui-config.js +3 -3
- package/users.d.ts +4 -4
- package/users.js +17 -4
- package/web-integrations.d.ts +3 -3
- package/web-integrations.js +3 -3
- package/web-notifications.d.ts +3 -3
- package/web-notifications.js +3 -3
- package/webhooks.d.ts +3 -3
- package/webhooks.js +3 -3
- package/website/assets/navigation.js +1 -1
- package/website/assets/search.js +1 -1
- package/website/functions/apps.validateScript.html +4 -0
- package/website/functions/assistants.invokeAssistantThread.html +2 -2
- package/website/functions/{direct-access-agents.getDirectAccessAgentConnectorCustomDataTypeMappings.html → assistants.searchAssistant.html} +4 -4
- package/website/functions/assistants.streamAssistantThread.html +2 -2
- package/website/functions/auth.setDefaultHostConfig.html +1 -1
- package/website/functions/banners.clearCache.html +2 -0
- package/website/functions/banners.getBanners.html +3 -0
- package/website/functions/banners.upsertBanners.html +4 -0
- package/website/functions/direct-access-agents.createDirectAccessAgentBenchmark.html +7 -0
- package/website/functions/direct-access-agents.createDirectAccessAgentBenchmarkCancel.html +5 -0
- package/website/functions/{direct-access-agents.getDirectAccessAgentConnectorFilesAllowedPaths.html → direct-access-agents.getDirectAccessAgentBenchmark.html} +3 -3
- package/website/functions/knowledgebases.searchKnowledgebase.html +5 -0
- package/website/functions/ml.getMlProfileInsightWithQuery.html +6 -2
- package/website/functions/transports.patchEmailConfig.html +3 -3
- package/website/functions/users.countUsers.html +3 -4
- package/website/functions/users.countUsersWithoutQuery.html +3 -0
- package/website/functions/users.getUsers.html +5 -14
- package/website/functions/webhooks.getWebhookDeliveries.html +6 -6
- package/website/functions/webhooks.getWebhooks.html +13 -13
- package/website/index.html +1 -1
- package/website/interfaces/auth.AuthAPI.html +1 -1
- package/website/interfaces/index.QlikAPI.html +4 -2
- package/website/interfaces/qix.GenericObject.html +1 -1
- package/website/modules/apps.html +1 -1
- package/website/modules/assistants.html +1 -1
- package/website/modules/banners.html +1 -0
- package/website/modules/direct-access-agents.html +1 -1
- package/website/modules/index.html +1 -1
- package/website/modules/knowledgebases.html +1 -1
- package/website/modules/sharing-tasks.html +1 -1
- package/website/modules/transports.html +1 -1
- package/website/modules/users.html +1 -1
- package/website/types/apps.AppsAPI.html +6 -2
- package/website/types/apps.Script.html +2 -0
- package/website/types/apps.ScriptIssue.html +11 -0
- package/website/types/apps.ScriptIssues.html +3 -0
- package/website/types/{direct-access-agents.PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse.html → apps.ValidateScriptHttpError.html} +2 -2
- package/website/types/apps.ValidateScriptHttpResponse.html +4 -0
- package/website/types/assistants.AssistantsAPI.html +19 -14
- package/website/types/assistants.Chunk.html +11 -0
- package/website/types/assistants.KbChunkMeta.html +12 -0
- package/website/types/assistants.SearchAssistantHttpError.html +4 -0
- package/website/types/assistants.SearchAssistantHttpResponse.html +4 -0
- package/website/types/assistants.SearchRequest.html +7 -0
- package/website/types/assistants.SearchResponse.html +3 -0
- package/website/types/auth-types.WebSocketAuthParams.html +4 -2
- package/website/types/banners.BannerResponse.html +19 -0
- package/website/types/banners.BannerUpsertDefinition.html +11 -0
- package/website/types/banners.BannersAPI.html +10 -0
- package/website/types/banners.ErrorResponse400.html +3 -0
- package/website/types/banners.ErrorResponse401.html +3 -0
- package/website/types/banners.ErrorResponse403.html +3 -0
- package/website/types/banners.ErrorResponse404.html +3 -0
- package/website/types/banners.ErrorResponse500.html +3 -0
- package/website/types/banners.GetBanners400HttpError.html +4 -0
- package/website/types/banners.GetBanners401HttpError.html +4 -0
- package/website/types/banners.GetBanners403HttpError.html +4 -0
- package/website/types/banners.GetBanners404HttpError.html +4 -0
- package/website/types/banners.GetBanners500HttpError.html +4 -0
- package/website/types/banners.GetBannersHttpError.html +1 -0
- package/website/types/banners.GetBannersHttpResponse.html +4 -0
- package/website/types/banners.UpsertBanners400HttpError.html +4 -0
- package/website/types/banners.UpsertBanners401HttpError.html +4 -0
- package/website/types/banners.UpsertBanners403HttpError.html +4 -0
- package/website/types/banners.UpsertBanners404HttpError.html +4 -0
- package/website/types/banners.UpsertBanners500HttpError.html +4 -0
- package/website/types/banners.UpsertBannersHttpError.html +1 -0
- package/website/types/banners.UpsertBannersHttpResponse.html +4 -0
- package/website/types/direct-access-agents.CancelBenchmarkResponse.html +3 -0
- package/website/types/direct-access-agents.CreateDirectAccessAgentBenchmarkCancelHttpError.html +4 -0
- package/website/types/direct-access-agents.CreateDirectAccessAgentBenchmarkCancelHttpResponse.html +4 -0
- package/website/types/direct-access-agents.CreateDirectAccessAgentBenchmarkHttpError.html +4 -0
- package/website/types/direct-access-agents.CreateDirectAccessAgentBenchmarkHttpResponse.html +4 -0
- package/website/types/direct-access-agents.DirectAccessAgentsAPI.html +41 -48
- package/website/types/direct-access-agents.GetBenchmarkStatusResponse.html +14 -0
- package/website/types/direct-access-agents.GetBenchmarkStatusResults.html +11 -0
- package/website/types/direct-access-agents.GetDirectAccessAgentBenchmarkHttpError.html +4 -0
- package/website/types/{direct-access-agents.GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpResponse.html → direct-access-agents.GetDirectAccessAgentBenchmarkHttpResponse.html} +2 -2
- package/website/types/direct-access-agents.LinkResponseObject.html +3 -0
- package/website/types/direct-access-agents.RunBenchmarkResponse.html +2 -0
- package/website/types/glossaries.TermCreateLinksTo.html +14 -1
- package/website/types/knowledgebases.CancelKnowledgebaseDatasourceHttpError.html +2 -2
- package/website/types/knowledgebases.Chunk.html +11 -0
- package/website/types/knowledgebases.CreateKnowledgebaseDatasourceHttpError.html +2 -2
- package/website/types/knowledgebases.CreateKnowledgebaseDatasourceScheduleHttpError.html +2 -2
- package/website/types/knowledgebases.CreateKnowledgebaseHttpError.html +2 -2
- package/website/types/knowledgebases.DeleteKnowledgebaseDatasourceHttpError.html +2 -2
- package/website/types/knowledgebases.DeleteKnowledgebaseDatasourceScheduleHttpError.html +2 -2
- package/website/types/knowledgebases.DeleteKnowledgebaseHttpError.html +2 -2
- package/website/types/knowledgebases.DownloadKnowledgebaseDatasourceHttpError.html +2 -2
- package/website/types/knowledgebases.ErrorResponseCode.html +11 -1
- package/website/types/knowledgebases.ErrorResponseCodeCopy.html +4 -0
- package/website/types/knowledgebases.ErrorResponseCopy.html +3 -0
- package/website/types/knowledgebases.GetKnowledgebaseDatasourceHistoriesHttpError.html +2 -2
- package/website/types/knowledgebases.GetKnowledgebaseDatasourceHistoryHttpError.html +2 -2
- package/website/types/knowledgebases.GetKnowledgebaseDatasourceScheduleHttpError.html +2 -2
- package/website/types/knowledgebases.GetKnowledgebaseHistoriesHttpError.html +2 -2
- package/website/types/knowledgebases.GetKnowledgebaseHttpError.html +2 -2
- package/website/types/knowledgebases.GetKnowledgebasesHttpError.html +2 -2
- package/website/types/knowledgebases.KbChunkMeta.html +12 -0
- package/website/types/knowledgebases.KnowledgebasesAPI.html +12 -7
- package/website/types/knowledgebases.PatchKnowledgebaseHttpError.html +2 -2
- package/website/types/knowledgebases.SearchKnowledgebaseHttpError.html +4 -0
- package/website/types/knowledgebases.SearchKnowledgebaseHttpResponse.html +4 -0
- package/website/types/knowledgebases.SearchRequest.html +7 -0
- package/website/types/knowledgebases.SearchResponse.html +3 -0
- package/website/types/knowledgebases.SyncKnowledgebaseDatasourceHttpError.html +2 -2
- package/website/types/knowledgebases.UpdateKnowledgebaseDatasourceHttpError.html +2 -2
- package/website/types/licenses.AssignmentsActionsAddRequest.html +3 -3
- package/website/types/ml.PreprocessedInsightColumn.html +2 -2
- package/website/types/ml.ProfileInsights.html +18 -3
- package/website/types/qix.NativeGenericObjectFunctions.html +1 -1
- package/website/types/qix.RpcObject.html +1 -1
- package/website/types/sharing-tasks.ChartTemplate.html +4 -2
- package/website/types/sharing-tasks.CleanupStrategy.html +2 -0
- package/website/types/sharing-tasks.MultiSheetTemplate.html +5 -3
- package/website/types/sharing-tasks.SharingTaskRecurringCreateRequest.html +5 -3
- package/website/types/transports.TransportsAPI.html +3 -3
- package/website/types/users.CountUsersWithoutQueryHttpError.html +4 -0
- package/website/types/users.CountUsersWithoutQueryHttpResponse.html +4 -0
- package/website/types/users.User.html +5 -11
- package/website/types/users.UserPostSchema.html +3 -5
- package/website/types/users.UsersAPI.html +13 -10
- package/website/types/webhooks.Delivery.html +14 -12
- package/website/types/webhooks.Error.html +3 -3
- package/website/types/webhooks.EventType.html +4 -4
- package/website/types/webhooks.Link.html +1 -1
- package/website/types/webhooks.WebhookBase.html +18 -16
- package/website/types/webhooks.WebhookPatch.html +3 -3
- package/website/types/webhooks.WebhookPost.html +1 -1
- package/website/types/webhooks.WebhookResponse.html +1 -1
- package/website/types/webhooks.WebhookResponseBase.html +21 -19
- package/website/variables/index.banners.html +1 -0
- package/website/variables/qix.QIX_SCHEMA_VERSION.html +1 -1
- package/website/functions/direct-access-agents.putDirectAccessAgentConnectorCustomDataTypeMappings.html +0 -6
- package/website/functions/direct-access-agents.putDirectAccessAgentConnectorFilesAllowedPaths.html +0 -6
- package/website/types/direct-access-agents.FileConnectorAllowedPath.html +0 -5
- package/website/types/direct-access-agents.FileConnectorAllowedPathsResponse.html +0 -3
- package/website/types/direct-access-agents.GetDirectAccessAgentConnectorCustomDataTypeMappingsHttpError.html +0 -4
- package/website/types/direct-access-agents.GetDirectAccessAgentConnectorFilesAllowedPathsHttpError.html +0 -4
- package/website/types/direct-access-agents.GetDirectAccessAgentConnectorFilesAllowedPathsHttpResponse.html +0 -4
- package/website/types/direct-access-agents.OdbcCustomDataType.html +0 -11
- package/website/types/direct-access-agents.OdbcCustomDataTypeResponse.html +0 -3
- package/website/types/direct-access-agents.PutDirectAccessAgentConnectorCustomDataTypeMappingsHttpError.html +0 -4
- package/website/types/direct-access-agents.PutDirectAccessAgentConnectorFilesAllowedPathsHttpError.html +0 -4
- package/website/types/direct-access-agents.PutDirectAccessAgentConnectorFilesAllowedPathsHttpResponse.html +0 -4
- package/website/types/direct-access-agents.UpdateFileConnectorAllowedPathsRequest.html +0 -2
- package/website/types/direct-access-agents.UpdateOdbcCustomTypeMappingsRequest.html +0 -2
- /package/chunks/{auth-types-BuIzsuoh.js → auth-types-BEj8JjOA.js} +0 -0
- /package/chunks/{global-types-BGMD2sDY.js → global-types-DW_kb7P7.js} +0 -0
- /package/chunks/{invoke-fetch-X0Vi-lbv.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
- /package/chunks/{utils-DI6bFnHB.js → utils-UaAiVTcc.js} +0 -0
- /package/chunks/{websocket-errors-BX-whwFJ.js → websocket-errors-CRTDTtBL.js} +0 -0
|
@@ -1,8 +1,6 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>getUsers | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/users.html">users</a></li><li><a href="" aria-current="page">getUsers</a></li></ul><h1>Function getUsers</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getusers"><span class="tsd-kind-call-signature">getUsers</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">email</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">endingBefore</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">fields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">role</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"inviteExpiry"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+inviteExpiry"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-inviteExpiry"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sortBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"name"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sortOrder</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"asc"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"desc"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">startingAfter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"active"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"disabled"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"deleted"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"invited"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"provisioned"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">subject</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">tenantId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">totalResults</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/users.GetUsersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetUsersHttpResponse</a><span class="tsd-signature-symbol">></span><a href="#getusers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a list of users using cursor-based pagination.</p>
|
|
2
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">
|
|
3
|
-
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">
|
|
4
|
-
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">endingBefore</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-1">Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Get users with IDs that are lower than the target user ID. Cannot be used in conjunction with startingAfter. Deprecated. Use <code>prev</code> instead.</p>
|
|
5
|
-
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">fields</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted.</p>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>getUsers | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/users.html">users</a></li><li><a href="" aria-current="page">getUsers</a></li></ul><h1>Function getUsers</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getusers"><span class="tsd-kind-call-signature">getUsers</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">fields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"inviteExpiry"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+inviteExpiry"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-inviteExpiry"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">totalResults</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/users.GetUsersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetUsersHttpResponse</a><span class="tsd-signature-symbol">></span><a href="#getusers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a list of users using cursor-based pagination.</p>
|
|
2
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">fields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"inviteExpiry"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+inviteExpiry"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-inviteExpiry"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">totalResults</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
3
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">fields</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>A comma-delimited string of the requested fields per entity. If the 'links' value is omitted, then the entity HATEOAS link will also be omitted.</p>
|
|
6
4
|
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The advanced filtering to use for the query. Refer to <a href="https://datatracker.ietf.org/doc/rfc7644/">RFC 7644</a> for the syntax. Cannot be combined with any of the fields marked as deprecated. All conditional statements within this query parameter are case insensitive.</p>
|
|
7
5
|
<p>The following fields support the <code>eq</code> operator: <code>id</code>, <code>subject</code>, <code>name</code>, <code>email</code>, <code>status</code>, <code>clientId</code>, <code>assignedRoles.id</code> <code>assignedRoles.name</code>, <code>assignedGroups.id</code>, <code>assignedGroupsAssignedRoles.name</code></p>
|
|
8
6
|
<p>Additionally, the following fields support the <code>co</code> operator: <code>name</code>, <code>email</code>, <code>subject</code></p>
|
|
@@ -25,14 +23,7 @@
|
|
|
25
23
|
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The number of user entries to retrieve.</p>
|
|
26
24
|
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Get users that come after this cursor value when sorted. Cannot be used in conjunction with <code>prev</code>.</p>
|
|
27
25
|
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Get users that come before this cursor value when sorted. Cannot be used in conjunction with <code>next</code>.</p>
|
|
28
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">
|
|
29
|
-
</div></
|
|
30
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">sortBy</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"name"</span></h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-3">Deprecated<a href="#deprecated-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The user parameter to sort by. Deprecated. Use <code>sort</code> instead.</p>
|
|
31
|
-
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">sortOrder</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"asc"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"desc"</span></h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-4">Deprecated<a href="#deprecated-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The sort order, either ascending or descending. Deprecated. Use <code>sort</code> instead.</p>
|
|
32
|
-
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">startingAfter</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-5">Deprecated<a href="#deprecated-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Get users with IDs that are higher than the target user ID. Cannot be used in conjunction with endingBefore. Deprecated. Use <code>next</code> instead.</p>
|
|
33
|
-
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"active"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"disabled"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"deleted"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"invited"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"provisioned"</span></h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-6">Deprecated<a href="#deprecated-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The status to filter by. Supports multiple values delimited by commas. Deprecated. Use the new <code>filter</code> parameter to provide an advanced query filter.</p>
|
|
34
|
-
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">subject</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-7">Deprecated<a href="#deprecated-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The subject to filter by. Deprecated. Use the new <code>filter</code> parameter to provide an advanced query filter.</p>
|
|
35
|
-
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">tenantId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-8">Deprecated<a href="#deprecated-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The tenant ID to filter by. Deprecated.</p>
|
|
36
|
-
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">totalResults</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to return a total match count in the result. Defaults to false. It will trigger an extra DB query to count, reducing the efficiency of the endpoint.</p>
|
|
26
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?: </span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-_id"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-tenantId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-clientId"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-subject"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-email"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"inviteExpiry"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+inviteExpiry"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-inviteExpiry"</span></h5><div class="tsd-comment tsd-typography"><p>The field to sort by, with +/- prefix indicating sort order</p>
|
|
27
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">totalResults</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to return a total match count in the result. Defaults to false. It will trigger an extra DB query to count, reducing the efficiency of the endpoint.</p>
|
|
37
28
|
</div></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/users.GetUsersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetUsersHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetUsersHttpError</p>
|
|
38
29
|
</div></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://qlik.dev/embed/" class="tsd-nav-link">Embed</a><a href="https://qlik.dev/extend/" class="tsd-nav-link">Extend</a><a href="https://qlik.dev/manage/" class="tsd-nav-link">Manage</a><a href="https://qlik.dev/apis/" class="tsd-nav-link">APIs</a><a href="https://qlik.dev/toolkits/" class="tsd-nav-link">Toolkits</a></nav><nav class="tsd-navigation"><a href="../index.html">@qlik/api reference</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><div class="wrapper"><div><img alt="Qlik logo" src="../assets/logo-footer.svg"/></div><div class="social"><a class="text" href="https://community.qlik.com/">Qlik Community</a><div class="icons"><a href="https://qlikdeveloper.slack.com/join/shared_invite/zt-1t4vc1qee-3P6R0ERUNfNeE7O6DPnN_Q#/shared-invite/email" aria-label="Qlik developer on slack"><svg viewBox="0 0 54 54" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M19.712.133a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386h5.376V5.52A5.381 5.381 0 0 0 19.712.133m0 14.365H5.376A5.381 5.381 0 0 0 0 19.884a5.381 5.381 0 0 0 5.376 5.387h14.336a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386"></path><path d="M53.76 19.884a5.381 5.381 0 0 0-5.376-5.386 5.381 5.381 0 0 0-5.376 5.386v5.387h5.376a5.381 5.381 0 0 0 5.376-5.387m-14.336 0V5.52A5.381 5.381 0 0 0 34.048.133a5.381 5.381 0 0 0-5.376 5.387v14.364a5.381 5.381 0 0 0 5.376 5.387 5.381 5.381 0 0 0 5.376-5.387"></path><path d="M34.048 54a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386h-5.376v5.386A5.381 5.381 0 0 0 34.048 54m0-14.365h14.336a5.381 5.381 0 0 0 5.376-5.386 5.381 5.381 0 0 0-5.376-5.387H34.048a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386"></path><path d="M0 34.249a5.381 5.381 0 0 0 5.376 5.386 5.381 5.381 0 0 0 5.376-5.386v-5.387H5.376A5.381 5.381 0 0 0 0 34.25m14.336-.001v14.364A5.381 5.381 0 0 0 19.712 54a5.381 5.381 0 0 0 5.376-5.387V34.25a5.381 5.381 0 0 0-5.376-5.387 5.381 5.381 0 0 0-5.376 5.387"></path></svg></a><a href="https://www.facebook.com/qlik" aria-label="Qlik on Facebook"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M20.05 10.345C20.05 4.812 15.56.32 10.025.32 4.491.32 0 4.812 0 10.345c0 4.852 3.449 8.893 8.02 9.825v-6.817H6.015v-3.008H8.02V7.84A3.513 3.513 0 0 1 11.53 4.33h2.506v3.008H12.03c-.551 0-1.002.451-1.002 1.002v2.005h3.007v3.008h-3.007v6.967c5.062-.5 9.022-4.772 9.022-9.975Z"/></svg></a><a href="https://www.linkedin.com/company/qlik" aria-label="Qlik on LinkedIn"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M17.286.32H3.952A3.334 3.334 0 0 0 .62 3.654v13.333a3.334 3.334 0 0 0 3.333 3.333h13.334a3.334 3.334 0 0 0 3.333-3.333V3.654A3.334 3.334 0 0 0 17.286.32Zm-10 16.25H5.202V8.237h2.084v8.333Zm.013-9.995c-.271.273-.623.412-1.055.412-.427 0-.777-.141-1.05-.425a1.46 1.46 0 0 1-.408-1.046c0-.426.137-.773.408-1.042.273-.27.623-.404 1.05-.404.432 0 .784.135 1.055.404.269.27.403.616.403 1.042 0 .43-.134.783-.403 1.059Zm9.57 9.995h-2.083v-4.63c0-1.292-.745-2.036-1.667-2.036-.445 0-.948.269-1.235.612-.288.342-.431.777-.431 1.302v4.752H9.369V8.237h2.084v1.317h.032c.614-1.013 1.506-1.517 2.678-1.521 1.665-.004 2.706 1.246 2.706 3.435v5.102Z"/></svg></a><a href="https://x.com/qlikdeveloper" aria-label="Qlik on X.com"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M11.698 8.789 18.983.32h-1.727l-6.325 7.354L5.878.32H.051l7.64 11.12-7.64 8.88h1.726l6.68-7.765 5.336 7.765h5.828L11.697 8.79Zm-2.365 2.749-.774-1.108-6.16-8.81h2.652l4.97 7.11.775 1.107 6.461 9.243h-2.652l-5.272-7.542Z"/></svg></a></div></div><div class="legal"><div class="links"><a href="https://www.qlik.com/us/legal/legal-agreements">Legal Agreements</a> /<a href="https://www.qlik.com/us/legal/legal-policies">Legal Policies</a> /<a href="https://www.qlik.com/us/legal/privacy-and-cookie-notice">Privacy & Cookie Notice</a> /<a href="https://qlik.dev/qlik-developer-portal-terms-of-use.pdf">Terms of Use</a></div><div class="copyright">Copyright © 1993-2025 QlikTech International AB. All rights reserved.</div></div></div></footer><div class="overlay"></div></body></html>
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>getWebhookDeliveries | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/webhooks.html">webhooks</a></li><li><a href="" aria-current="page">getWebhookDeliveries</a></li></ul><h1>Function getWebhookDeliveries</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getwebhookdeliveries"><span class="tsd-kind-call-signature">getWebhookDeliveries</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">eventType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"triggeredAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+triggeredAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-triggeredAt"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"success"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"fail"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/webhooks.GetWebhookDeliveriesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetWebhookDeliveriesHttpResponse</a><span class="tsd-signature-symbol">></span><a href="#getwebhookdeliveries" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns deliveries for a specific webhook. Delivery history is stored for 1 week.</p>
|
|
2
2
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The webhook's unique identifier.</p>
|
|
3
3
|
</div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">eventType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"triggeredAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+triggeredAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-triggeredAt"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"success"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"fail"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
4
|
-
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">eventType</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by event-type
|
|
5
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>Maximum number of deliveries to retrieve
|
|
6
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Cursor to the next page
|
|
7
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Cursor to previous
|
|
8
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?: </span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"triggeredAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+triggeredAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-triggeredAt"</span></h5><div class="tsd-comment tsd-typography"><p>Field to sort by, prefix with -/+ to indicate order
|
|
9
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"success"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"fail"</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by status (success or fail)
|
|
4
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">eventType</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by event-type.</p>
|
|
5
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>Maximum number of deliveries to retrieve.</p>
|
|
6
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Cursor to the next page.</p>
|
|
7
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Cursor to the previous page.</p>
|
|
8
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?: </span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-status"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"triggeredAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+triggeredAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-triggeredAt"</span></h5><div class="tsd-comment tsd-typography"><p>Field to sort by, prefix with -/+ to indicate order.</p>
|
|
9
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"success"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"fail"</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by status (success or fail).</p>
|
|
10
10
|
</div></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/webhooks.GetWebhookDeliveriesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetWebhookDeliveriesHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetWebhookDeliveriesHttpError</p>
|
|
11
11
|
</div></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://qlik.dev/embed/" class="tsd-nav-link">Embed</a><a href="https://qlik.dev/extend/" class="tsd-nav-link">Extend</a><a href="https://qlik.dev/manage/" class="tsd-nav-link">Manage</a><a href="https://qlik.dev/apis/" class="tsd-nav-link">APIs</a><a href="https://qlik.dev/toolkits/" class="tsd-nav-link">Toolkits</a></nav><nav class="tsd-navigation"><a href="../index.html">@qlik/api reference</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><div class="wrapper"><div><img alt="Qlik logo" src="../assets/logo-footer.svg"/></div><div class="social"><a class="text" href="https://community.qlik.com/">Qlik Community</a><div class="icons"><a href="https://qlikdeveloper.slack.com/join/shared_invite/zt-1t4vc1qee-3P6R0ERUNfNeE7O6DPnN_Q#/shared-invite/email" aria-label="Qlik developer on slack"><svg viewBox="0 0 54 54" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M19.712.133a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386h5.376V5.52A5.381 5.381 0 0 0 19.712.133m0 14.365H5.376A5.381 5.381 0 0 0 0 19.884a5.381 5.381 0 0 0 5.376 5.387h14.336a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386"></path><path d="M53.76 19.884a5.381 5.381 0 0 0-5.376-5.386 5.381 5.381 0 0 0-5.376 5.386v5.387h5.376a5.381 5.381 0 0 0 5.376-5.387m-14.336 0V5.52A5.381 5.381 0 0 0 34.048.133a5.381 5.381 0 0 0-5.376 5.387v14.364a5.381 5.381 0 0 0 5.376 5.387 5.381 5.381 0 0 0 5.376-5.387"></path><path d="M34.048 54a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386h-5.376v5.386A5.381 5.381 0 0 0 34.048 54m0-14.365h14.336a5.381 5.381 0 0 0 5.376-5.386 5.381 5.381 0 0 0-5.376-5.387H34.048a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386"></path><path d="M0 34.249a5.381 5.381 0 0 0 5.376 5.386 5.381 5.381 0 0 0 5.376-5.386v-5.387H5.376A5.381 5.381 0 0 0 0 34.25m14.336-.001v14.364A5.381 5.381 0 0 0 19.712 54a5.381 5.381 0 0 0 5.376-5.387V34.25a5.381 5.381 0 0 0-5.376-5.387 5.381 5.381 0 0 0-5.376 5.387"></path></svg></a><a href="https://www.facebook.com/qlik" aria-label="Qlik on Facebook"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M20.05 10.345C20.05 4.812 15.56.32 10.025.32 4.491.32 0 4.812 0 10.345c0 4.852 3.449 8.893 8.02 9.825v-6.817H6.015v-3.008H8.02V7.84A3.513 3.513 0 0 1 11.53 4.33h2.506v3.008H12.03c-.551 0-1.002.451-1.002 1.002v2.005h3.007v3.008h-3.007v6.967c5.062-.5 9.022-4.772 9.022-9.975Z"/></svg></a><a href="https://www.linkedin.com/company/qlik" aria-label="Qlik on LinkedIn"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M17.286.32H3.952A3.334 3.334 0 0 0 .62 3.654v13.333a3.334 3.334 0 0 0 3.333 3.333h13.334a3.334 3.334 0 0 0 3.333-3.333V3.654A3.334 3.334 0 0 0 17.286.32Zm-10 16.25H5.202V8.237h2.084v8.333Zm.013-9.995c-.271.273-.623.412-1.055.412-.427 0-.777-.141-1.05-.425a1.46 1.46 0 0 1-.408-1.046c0-.426.137-.773.408-1.042.273-.27.623-.404 1.05-.404.432 0 .784.135 1.055.404.269.27.403.616.403 1.042 0 .43-.134.783-.403 1.059Zm9.57 9.995h-2.083v-4.63c0-1.292-.745-2.036-1.667-2.036-.445 0-.948.269-1.235.612-.288.342-.431.777-.431 1.302v4.752H9.369V8.237h2.084v1.317h.032c.614-1.013 1.506-1.517 2.678-1.521 1.665-.004 2.706 1.246 2.706 3.435v5.102Z"/></svg></a><a href="https://x.com/qlikdeveloper" aria-label="Qlik on X.com"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M11.698 8.789 18.983.32h-1.727l-6.325 7.354L5.878.32H.051l7.64 11.12-7.64 8.88h1.726l6.68-7.765 5.336 7.765h5.828L11.697 8.79Zm-2.365 2.749-.774-1.108-6.16-8.81h2.652l4.97 7.11.775 1.107 6.461 9.243h-2.652l-5.272-7.542Z"/></svg></a></div></div><div class="legal"><div class="links"><a href="https://www.qlik.com/us/legal/legal-agreements">Legal Agreements</a> /<a href="https://www.qlik.com/us/legal/legal-policies">Legal Policies</a> /<a href="https://www.qlik.com/us/legal/privacy-and-cookie-notice">Privacy & Cookie Notice</a> /<a href="https://qlik.dev/qlik-developer-portal-terms-of-use.pdf">Terms of Use</a></div><div class="copyright">Copyright © 1993-2025 QlikTech International AB. All rights reserved.</div></div></div></footer><div class="overlay"></div></body></html>
|
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>getWebhooks | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/webhooks.html">webhooks</a></li><li><a href="" aria-current="page">getWebhooks</a></li></ul><h1>Function getWebhooks</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getwebhooks"><span class="tsd-kind-call-signature">getWebhooks</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">createdByUserId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">eventTypes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">level</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">origins</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"api"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"automations"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"management-console"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownerId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"url"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+url"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-url"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">updatedByUserId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/webhooks.GetWebhooksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetWebhooksHttpResponse</a><span class="tsd-signature-symbol">></span><a href="#getwebhooks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves all webhooks entries for a tenant that the user has access to. Users assigned the <code>TenantAdmin</code> role can retrieve all webhooks. A user can have up to 150 webhooks at one time.</p>
|
|
2
2
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">createdByUserId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">eventTypes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">level</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">origins</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"api"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"automations"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"management-console"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownerId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"url"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+url"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-url"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">updatedByUserId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
3
|
-
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">createdByUserId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by user that created it
|
|
4
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by enabled true/false
|
|
5
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">eventTypes</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by event-type/types, a single webhook item can have multiple event-types
|
|
6
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">level</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by level that user has access to (either user or level)
|
|
7
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>Maximum number of webhooks to retrieve
|
|
8
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by name (wildcard and case insensitive)
|
|
9
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Cursor to the next page
|
|
10
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">origins</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"api"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"automations"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"management-console"</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by origins, supports multiorigin
|
|
11
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">ownerId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by user that owns it, only applicable for user level webhooks
|
|
12
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Cursor to previous
|
|
13
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?: </span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"url"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+url"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-url"</span></h5><div class="tsd-comment tsd-typography"><p>Field to sort by, prefix with -/+ to indicate order
|
|
14
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">updatedByUserId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by user that last updated the webhook
|
|
15
|
-
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by
|
|
3
|
+
</div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">createdByUserId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by user that created it.</p>
|
|
4
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">enabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by enabled true/false.</p>
|
|
5
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">eventTypes</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by event-type/types, a single webhook item can have multiple event-types.</p>
|
|
6
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">level</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by level that user has access to (either user or level).</p>
|
|
7
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>Maximum number of webhooks to retrieve.</p>
|
|
8
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by name (wildcard and case insensitive).</p>
|
|
9
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Cursor to the next page.</p>
|
|
10
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">origins</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"api"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"automations"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"management-console"</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by origins, supports multiorigin.</p>
|
|
11
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">ownerId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by user that owns it, only applicable for user level webhooks.</p>
|
|
12
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Cursor to the previous page.</p>
|
|
13
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?: </span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"url"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"createdAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"updatedAt"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+url"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-url"</span></h5><div class="tsd-comment tsd-typography"><p>Field to sort by, prefix with -/+ to indicate order.</p>
|
|
14
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">updatedByUserId</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by user that last updated the webhook.</p>
|
|
15
|
+
</div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Filter resources by URL (wildcard and case insensitive).</p>
|
|
16
16
|
</div></li></ul></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/webhooks.GetWebhooksHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetWebhooksHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetWebhooksHttpError</p>
|
|
17
17
|
</div></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://qlik.dev/embed/" class="tsd-nav-link">Embed</a><a href="https://qlik.dev/extend/" class="tsd-nav-link">Extend</a><a href="https://qlik.dev/manage/" class="tsd-nav-link">Manage</a><a href="https://qlik.dev/apis/" class="tsd-nav-link">APIs</a><a href="https://qlik.dev/toolkits/" class="tsd-nav-link">Toolkits</a></nav><nav class="tsd-navigation"><a href="../index.html">@qlik/api reference</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><div class="wrapper"><div><img alt="Qlik logo" src="../assets/logo-footer.svg"/></div><div class="social"><a class="text" href="https://community.qlik.com/">Qlik Community</a><div class="icons"><a href="https://qlikdeveloper.slack.com/join/shared_invite/zt-1t4vc1qee-3P6R0ERUNfNeE7O6DPnN_Q#/shared-invite/email" aria-label="Qlik developer on slack"><svg viewBox="0 0 54 54" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M19.712.133a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386h5.376V5.52A5.381 5.381 0 0 0 19.712.133m0 14.365H5.376A5.381 5.381 0 0 0 0 19.884a5.381 5.381 0 0 0 5.376 5.387h14.336a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386"></path><path d="M53.76 19.884a5.381 5.381 0 0 0-5.376-5.386 5.381 5.381 0 0 0-5.376 5.386v5.387h5.376a5.381 5.381 0 0 0 5.376-5.387m-14.336 0V5.52A5.381 5.381 0 0 0 34.048.133a5.381 5.381 0 0 0-5.376 5.387v14.364a5.381 5.381 0 0 0 5.376 5.387 5.381 5.381 0 0 0 5.376-5.387"></path><path d="M34.048 54a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386h-5.376v5.386A5.381 5.381 0 0 0 34.048 54m0-14.365h14.336a5.381 5.381 0 0 0 5.376-5.386 5.381 5.381 0 0 0-5.376-5.387H34.048a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386"></path><path d="M0 34.249a5.381 5.381 0 0 0 5.376 5.386 5.381 5.381 0 0 0 5.376-5.386v-5.387H5.376A5.381 5.381 0 0 0 0 34.25m14.336-.001v14.364A5.381 5.381 0 0 0 19.712 54a5.381 5.381 0 0 0 5.376-5.387V34.25a5.381 5.381 0 0 0-5.376-5.387 5.381 5.381 0 0 0-5.376 5.387"></path></svg></a><a href="https://www.facebook.com/qlik" aria-label="Qlik on Facebook"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M20.05 10.345C20.05 4.812 15.56.32 10.025.32 4.491.32 0 4.812 0 10.345c0 4.852 3.449 8.893 8.02 9.825v-6.817H6.015v-3.008H8.02V7.84A3.513 3.513 0 0 1 11.53 4.33h2.506v3.008H12.03c-.551 0-1.002.451-1.002 1.002v2.005h3.007v3.008h-3.007v6.967c5.062-.5 9.022-4.772 9.022-9.975Z"/></svg></a><a href="https://www.linkedin.com/company/qlik" aria-label="Qlik on LinkedIn"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M17.286.32H3.952A3.334 3.334 0 0 0 .62 3.654v13.333a3.334 3.334 0 0 0 3.333 3.333h13.334a3.334 3.334 0 0 0 3.333-3.333V3.654A3.334 3.334 0 0 0 17.286.32Zm-10 16.25H5.202V8.237h2.084v8.333Zm.013-9.995c-.271.273-.623.412-1.055.412-.427 0-.777-.141-1.05-.425a1.46 1.46 0 0 1-.408-1.046c0-.426.137-.773.408-1.042.273-.27.623-.404 1.05-.404.432 0 .784.135 1.055.404.269.27.403.616.403 1.042 0 .43-.134.783-.403 1.059Zm9.57 9.995h-2.083v-4.63c0-1.292-.745-2.036-1.667-2.036-.445 0-.948.269-1.235.612-.288.342-.431.777-.431 1.302v4.752H9.369V8.237h2.084v1.317h.032c.614-1.013 1.506-1.517 2.678-1.521 1.665-.004 2.706 1.246 2.706 3.435v5.102Z"/></svg></a><a href="https://x.com/qlikdeveloper" aria-label="Qlik on X.com"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M11.698 8.789 18.983.32h-1.727l-6.325 7.354L5.878.32H.051l7.64 11.12-7.64 8.88h1.726l6.68-7.765 5.336 7.765h5.828L11.697 8.79Zm-2.365 2.749-.774-1.108-6.16-8.81h2.652l4.97 7.11.775 1.107 6.461 9.243h-2.652l-5.272-7.542Z"/></svg></a></div></div><div class="legal"><div class="links"><a href="https://www.qlik.com/us/legal/legal-agreements">Legal Agreements</a> /<a href="https://www.qlik.com/us/legal/legal-policies">Legal Policies</a> /<a href="https://www.qlik.com/us/legal/privacy-and-cookie-notice">Privacy & Cookie Notice</a> /<a href="https://qlik.dev/qlik-developer-portal-terms-of-use.pdf">Terms of Use</a></div><div class="copyright">Copyright © 1993-2025 QlikTech International AB. All rights reserved.</div></div></div></footer><div class="overlay"></div></body></html>
|