@qlik/api 1.42.0 → 1.44.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 +2 -2
- package/api-keys.js +3 -3
- package/apps.d.ts +2 -2
- package/apps.js +3 -3
- package/assistants.d.ts +2 -2
- package/assistants.js +3 -3
- package/audits.d.ts +3 -3
- package/audits.js +17 -4
- package/auth-types.d.ts +1 -1
- package/auth.d.ts +2 -2
- package/auth.js +2 -2
- package/automation-connections.d.ts +2 -2
- package/automation-connections.js +3 -3
- package/automations.d.ts +3 -3
- package/automations.js +3 -3
- package/automl-deployments.d.ts +2 -2
- package/automl-deployments.js +5 -3
- package/automl-predictions.d.ts +2 -2
- package/automl-predictions.js +15 -3
- package/brands.d.ts +2 -2
- package/brands.js +3 -3
- package/chunks/{api-keys-CI44OuNR.d.ts → api-keys-C-ZqA-wl.d.ts} +1 -1
- package/chunks/{apps-BiGof9WJ.d.ts → apps-k7oY1h_6.d.ts} +2 -1
- package/chunks/{assistants-CDtI99Yr.d.ts → assistants-BsDbpzl4.d.ts} +7 -1
- package/chunks/{audits-C-UDFprK.d.ts → audits-5CBpwcdx.d.ts} +24 -2
- package/chunks/{auth-Cl-o3AnG.js → auth-CCj082fh.js} +3 -3
- package/chunks/{auth-B5Hx9GeQ.d.ts → auth-DFOXWfqh.d.ts} +3 -3
- package/chunks/{auth-DD2ENDUe.js → auth-DM5ilf4I.js} +2 -2
- package/chunks/{auth-functions-DHRxWU6t.js → auth-functions-CZbgZARw.js} +72 -24
- package/chunks/{auth-types-BlCWK0FP.d.ts → auth-types-B1c_1Nca.d.ts} +4 -1
- package/chunks/{automation-connections-keN9CuNO.d.ts → automation-connections-DRQDgw7Q.d.ts} +1 -1
- package/chunks/{automations-CFRnQ8sX.d.ts → automations-DQ-dYRFS.d.ts} +13 -4
- package/chunks/{automl-deployments-D05clUGa.d.ts → automl-deployments-B-WuR_zE.d.ts} +5 -1
- package/chunks/{automl-predictions-Ddp6PdpE.d.ts → automl-predictions-CewW0eZn.d.ts} +25 -1
- package/chunks/{brands-hEcnkdfg.d.ts → brands-C4eALPrs.d.ts} +1 -1
- package/chunks/{collections-CuX8Cp8Z.d.ts → collections-Djmd9gof.d.ts} +1 -1
- package/chunks/{conditions-DUmPB4Ej.d.ts → conditions-BRDxUbgu.d.ts} +1 -1
- package/chunks/{consumption-CSptDhk9.d.ts → consumption-UNw8R7jN.d.ts} +1 -1
- package/chunks/{csp-origins-v_UyOSK9.d.ts → csp-origins-_4HBSdgU.d.ts} +1 -1
- package/chunks/{csrf-token-DZK6GX6Z.d.ts → csrf-token-CsvbqXyY.d.ts} +1 -1
- package/chunks/{data-alerts-DwPcCvHP.d.ts → data-alerts-DSV3VOnW.d.ts} +1 -1
- package/chunks/{data-assets-BPMOGSO7.d.ts → data-assets-C3U3T_lj.d.ts} +1 -1
- package/chunks/{data-connections-DK1AhSi4.d.ts → data-connections-BYNfX1Fl.d.ts} +1 -1
- package/chunks/{data-credentials-BDCHbRwM.d.ts → data-credentials-CgCjw_Cn.d.ts} +1 -1
- package/chunks/{data-files-D7mlQnrw.d.ts → data-files-DH19MfYE.d.ts} +1 -1
- package/chunks/{data-qualities-Z554f_p6.d.ts → data-qualities-BogHQw4I.d.ts} +1 -1
- package/chunks/{data-sets-AcCLu1zw.d.ts → data-sets-B27GmshO.d.ts} +1 -1
- package/chunks/{data-sources-hfHV7WaV.d.ts → data-sources-D_TRdWV-.d.ts} +1 -1
- package/chunks/{data-stores-Bofu7fl5.d.ts → data-stores-BjfzMp9W.d.ts} +1 -1
- package/chunks/{dcaas-DK4f7Rrs.d.ts → dcaas-A7hfpAI5.d.ts} +1 -1
- package/chunks/{di-projects-DYJgDVfh.d.ts → di-projects-mdshgyFv.d.ts} +69 -13
- package/chunks/{direct-access-agents-Pmhjq2z5.d.ts → direct-access-agents-CfUpbi73.d.ts} +1 -1
- package/chunks/dist-B_RLj4Dy.js +58 -0
- package/chunks/{encryption-CMJWtMcm.d.ts → encryption-CjBmNQDZ.d.ts} +1 -1
- package/chunks/{extensions-Ct2JAsbk.d.ts → extensions-D05y2FWk.d.ts} +1 -1
- package/chunks/{glossaries-Drx-EwiU.d.ts → glossaries-vYbykU3r.d.ts} +1 -1
- package/chunks/{groups-C-R5oUEa.d.ts → groups-BapgngJf.d.ts} +1 -1
- package/chunks/{identity-providers-Bj88evsO.d.ts → identity-providers-CAxsp9hP.d.ts} +1 -1
- package/chunks/{interceptors-e6hoYE8W.d.ts → interceptors-BF556LaK.d.ts} +1 -1
- package/chunks/{interceptors-DD0vKL8_.js → interceptors-DBoV6UkN.js} +1 -1
- package/chunks/{invoke-fetch-DbVuX5mE.js → invoke-fetch-DuiAX21K.js} +3 -3
- package/chunks/{invoke-fetch-BIh4VnG4.js → invoke-fetch-fXOUPARi.js} +3 -3
- package/chunks/{items-BnN6gI0J.d.ts → items-CjVrNg57.d.ts} +1 -1
- package/chunks/{knowledgebases-tmPZVD6i.d.ts → knowledgebases-BFiV7Fwh.d.ts} +1 -1
- package/chunks/{licenses-DAPVQuFJ.d.ts → licenses-yZKgQ2k6.d.ts} +1 -1
- package/chunks/{lineage-graphs-Q4LiGGtL.d.ts → lineage-graphs-Bkc04N-t.d.ts} +1 -1
- package/chunks/{ml-C80TkK1J.d.ts → ml-CABYvU_L.d.ts} +8 -14
- package/chunks/{notes-CHvadRai.d.ts → notes-C5HjmBeI.d.ts} +1 -1
- package/chunks/{notifications-BhS8s4Eo.d.ts → notifications-DfP7aWPH.d.ts} +1 -1
- package/chunks/{oauth-clients-D1f8xiFC.d.ts → oauth-clients-BmMEDuET.d.ts} +1 -1
- package/chunks/{oauth-tokens-DteoDifd.d.ts → oauth-tokens-Dimf19DE.d.ts} +1 -1
- package/chunks/{public-runtime-modules-CNGnt1rU.js → public-runtime-modules-BDwfbach.js} +3 -3
- package/chunks/{qix-3nXOY2qw.js → qix-Cb4-XF7V.js} +1 -1
- package/chunks/{qix-DbtKisCn.js → qix-Ds6X5svJ.js} +5 -5
- package/chunks/{qix-chunk-entrypoint-xeI9UjuJ.js → qix-chunk-entrypoint-CpkRq84_.js} +426 -89
- package/chunks/{qix-T3MHM_Lb.d.ts → qix-hgcIF2oL.d.ts} +2 -2
- package/chunks/{questions-BiR5-mZ4.d.ts → questions-CFN7BgWt.d.ts} +1 -1
- package/chunks/{quotas-GTQL9uPt.d.ts → quotas-BUH2e2K_.d.ts} +1 -1
- package/chunks/{reload-tasks-CmXJp5va.d.ts → reload-tasks-DN3X2-30.d.ts} +1 -1
- package/chunks/{reloads-3XgvVnbq.d.ts → reloads-ClLQO7Vt.d.ts} +1 -1
- package/chunks/{report-templates-BowaTti4.d.ts → report-templates-D5KOFkRi.d.ts} +1 -1
- package/chunks/{reports-D-sRL947.d.ts → reports-CRwCogRL.d.ts} +85 -2
- package/chunks/{roles-D93ENaRt.d.ts → roles-DCzyiLdU.d.ts} +1 -1
- package/chunks/{sharing-tasks-BMDAjWTj.d.ts → sharing-tasks-DsxFrADQ.d.ts} +1 -1
- package/chunks/{spaces-DFQCYg41.d.ts → spaces-B0cx23Nc.d.ts} +1 -1
- package/chunks/{tasks-BWmS6L8Y.d.ts → tasks-DWfE5JM_.d.ts} +1 -1
- package/chunks/{temp-contents-CZVb5P0V.d.ts → temp-contents-CU94UTZU.d.ts} +1 -1
- package/chunks/{tenants-BDH4DmcO.d.ts → tenants-DvtbiwAP.d.ts} +1 -1
- package/chunks/{themes-BkubWfOE.d.ts → themes-BPkyCLWS.d.ts} +1 -1
- package/chunks/{transports-CO9kRJg5.d.ts → transports-DlRmSWLj.d.ts} +1 -1
- package/chunks/{ui-config-DIOnLEV9.d.ts → ui-config-BqX-bPjf.d.ts} +1 -1
- package/chunks/{users-DM-ZfzQB.d.ts → users-CuQ0nboa.d.ts} +1 -1
- package/chunks/{utils-qEQ6sEXX.js → utils-CAGXTaqJ.js} +14 -1
- package/chunks/{web-integrations-BjVMC88M.d.ts → web-integrations-D54LCd0Z.d.ts} +1 -1
- package/chunks/{web-notifications-D-eA8h1I.d.ts → web-notifications-sUlHGnmy.d.ts} +1 -1
- package/chunks/{webhooks-Dytyr5nk.d.ts → webhooks-Dw0FIeFq.d.ts} +1 -1
- package/collections.d.ts +2 -2
- package/collections.js +3 -3
- package/conditions.d.ts +2 -2
- package/conditions.js +3 -3
- package/consumption.d.ts +2 -2
- package/consumption.js +3 -3
- package/csp-origins.d.ts +2 -2
- package/csp-origins.js +3 -3
- package/csrf-token.d.ts +2 -2
- package/csrf-token.js +3 -3
- package/data-alerts.d.ts +2 -2
- package/data-alerts.js +3 -3
- package/data-assets.d.ts +2 -2
- package/data-assets.js +3 -3
- package/data-connections.d.ts +2 -2
- package/data-connections.js +3 -3
- package/data-credentials.d.ts +2 -2
- package/data-credentials.js +3 -3
- package/data-files.d.ts +2 -2
- package/data-files.js +3 -3
- package/data-qualities.d.ts +2 -2
- package/data-qualities.js +3 -3
- package/data-sets.d.ts +2 -2
- package/data-sets.js +3 -3
- package/data-sources.d.ts +2 -2
- package/data-sources.js +3 -3
- package/data-stores.d.ts +2 -2
- package/data-stores.js +3 -3
- package/dcaas.d.ts +2 -2
- package/dcaas.js +3 -3
- package/di-projects.d.ts +3 -3
- package/di-projects.js +4 -4
- package/direct-access-agents.d.ts +2 -2
- package/direct-access-agents.js +3 -3
- package/docs/authentication.md +65 -1
- package/docs/rest.md +1 -1
- package/encryption.d.ts +2 -2
- package/encryption.js +3 -3
- package/extensions.d.ts +2 -2
- package/extensions.js +3 -3
- package/global-types.d.ts +1 -1
- package/glossaries.d.ts +2 -2
- package/glossaries.js +3 -3
- package/groups.d.ts +2 -2
- package/groups.js +3 -3
- package/identity-providers.d.ts +2 -2
- package/identity-providers.js +3 -3
- package/index.d.ts +63 -63
- package/index.js +73 -69
- package/interceptors.d.ts +2 -2
- package/interceptors.js +2 -2
- package/invoke-fetch-types.d.ts +1 -1
- package/items.d.ts +2 -2
- package/items.js +3 -3
- package/knowledgebases.d.ts +2 -2
- package/knowledgebases.js +3 -3
- package/licenses.d.ts +2 -2
- package/licenses.js +3 -3
- package/lineage-graphs.d.ts +2 -2
- package/lineage-graphs.js +3 -3
- package/ml.d.ts +3 -3
- package/ml.js +4 -4
- package/notes.d.ts +2 -2
- package/notes.js +3 -3
- package/notifications.d.ts +2 -2
- package/notifications.js +3 -3
- package/oauth-clients.d.ts +2 -2
- package/oauth-clients.js +3 -3
- package/oauth-tokens.d.ts +2 -2
- package/oauth-tokens.js +3 -3
- package/package.json +2 -2
- package/qix.d.ts +3 -3
- package/qix.js +2 -2
- package/questions.d.ts +2 -2
- package/questions.js +3 -3
- package/quotas.d.ts +2 -2
- package/quotas.js +3 -3
- package/reload-tasks.d.ts +2 -2
- package/reload-tasks.js +3 -3
- package/reloads.d.ts +2 -2
- package/reloads.js +3 -3
- package/report-templates.d.ts +2 -2
- package/report-templates.js +3 -3
- package/reports.d.ts +3 -3
- package/reports.js +22 -4
- package/roles.d.ts +2 -2
- package/roles.js +3 -3
- package/sharing-tasks.d.ts +2 -2
- package/sharing-tasks.js +3 -3
- package/spaces.d.ts +2 -2
- package/spaces.js +3 -3
- package/tasks.d.ts +2 -2
- package/tasks.js +3 -3
- package/temp-contents.d.ts +2 -2
- package/temp-contents.js +3 -3
- package/tenants.d.ts +2 -2
- package/tenants.js +3 -3
- package/themes.d.ts +2 -2
- package/themes.js +3 -3
- package/transports.d.ts +2 -2
- package/transports.js +3 -3
- package/ui-config.d.ts +2 -2
- package/ui-config.js +3 -3
- package/users.d.ts +2 -2
- package/users.js +3 -3
- package/web-integrations.d.ts +2 -2
- package/web-integrations.js +3 -3
- package/web-notifications.d.ts +2 -2
- package/web-notifications.js +3 -3
- package/webhooks.d.ts +2 -2
- package/webhooks.js +3 -3
- package/website/assets/navigation.js +1 -1
- package/website/assets/search.js +1 -1
- package/website/functions/audits.fetchConsumptionAppAudits.html +3 -0
- package/website/functions/auth.setDefaultHostConfig.html +1 -1
- package/website/functions/automations.getAutomationsUsageMetrics.html +5 -1
- package/website/functions/automations.updateAutomation.html +2 -2
- package/website/functions/automl-deployments.createAutomlDeploymentRealtimePrediction.html +3 -3
- package/website/functions/automl-predictions.createAutomlPredictionJob.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionCoordinateShap.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionNotPredictedReasons.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionPredictions.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionShap.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionSource.html +3 -3
- package/website/functions/di-projects.getDiProjectDiTaskRuntimeState.html +1 -1
- package/website/functions/ml.getMlDeploymentAliases.html +2 -1
- package/website/functions/reports.getReportOutputs.html +13 -0
- package/website/interfaces/api-keys.ApiKeysAPI.html +8 -8
- package/website/interfaces/apps.AppsAPI.html +45 -45
- package/website/interfaces/assistants.AssistantsAPI.html +29 -29
- package/website/interfaces/audits.AuditsAPI.html +27 -22
- package/website/interfaces/auth.AuthAPI.html +7 -7
- package/website/interfaces/automation-connections.AutomationConnectionsAPI.html +9 -9
- package/website/interfaces/automations.AutomationsAPI.html +29 -25
- package/website/interfaces/automl-deployments.AutomlDeploymentsAPI.html +7 -7
- package/website/interfaces/automl-predictions.AutomlPredictionsAPI.html +37 -37
- package/website/interfaces/brands.BrandsAPI.html +13 -13
- package/website/interfaces/collections.CollectionsAPI.html +12 -12
- package/website/interfaces/conditions.ConditionsAPI.html +12 -12
- package/website/interfaces/consumption.ConsumptionAPI.html +2 -2
- package/website/interfaces/csp-origins.CspOriginsAPI.html +7 -7
- package/website/interfaces/csrf-token.CsrfTokenAPI.html +2 -2
- package/website/interfaces/data-alerts.DataAlertsAPI.html +17 -17
- package/website/interfaces/data-assets.DataAssetsAPI.html +6 -6
- package/website/interfaces/data-connections.DataConnectionsAPI.html +10 -10
- package/website/interfaces/data-credentials.DataCredentialsAPI.html +6 -6
- package/website/interfaces/data-files.DataFilesAPI.html +13 -13
- package/website/interfaces/data-qualities.DataQualitiesAPI.html +4 -4
- package/website/interfaces/data-sets.DataSetsAPI.html +7 -7
- package/website/interfaces/data-sources.DataSourcesAPI.html +4 -4
- package/website/interfaces/data-stores.DataStoresAPI.html +11 -11
- package/website/interfaces/dcaas.DcaasAPI.html +4 -4
- package/website/interfaces/di-projects.DiProjectsAPI.html +18 -18
- package/website/interfaces/direct-access-agents.DirectAccessAgentsAPI.html +13 -13
- package/website/interfaces/encryption.EncryptionAPI.html +11 -11
- package/website/interfaces/extensions.ExtensionsAPI.html +8 -8
- package/website/interfaces/glossaries.GlossariesAPI.html +25 -25
- package/website/interfaces/groups.GroupsAPI.html +9 -9
- package/website/interfaces/identity-providers.IdentityProvidersAPI.html +9 -9
- package/website/interfaces/interceptors.InterceptorsAPI.html +3 -3
- package/website/interfaces/items.ItemsAPI.html +9 -9
- package/website/interfaces/knowledgebases.KnowledgebasesAPI.html +18 -18
- package/website/interfaces/licenses.LicensesAPI.html +10 -10
- package/website/interfaces/lineage-graphs.LineageGraphsAPI.html +9 -9
- package/website/interfaces/ml.MlAPI.html +48 -46
- package/website/interfaces/notes.NotesAPI.html +3 -3
- package/website/interfaces/notifications.NotificationsAPI.html +2 -2
- package/website/interfaces/oauth-clients.OauthClientsAPI.html +12 -12
- package/website/interfaces/oauth-tokens.OauthTokensAPI.html +3 -3
- package/website/interfaces/qix.GenericObject.html +1 -1
- package/website/interfaces/questions.QuestionsAPI.html +3 -3
- package/website/interfaces/quotas.QuotasAPI.html +3 -3
- package/website/interfaces/reload-tasks.ReloadTasksAPI.html +6 -6
- package/website/interfaces/reloads.ReloadsAPI.html +5 -5
- package/website/interfaces/report-templates.ReportTemplatesAPI.html +8 -8
- package/website/interfaces/reports.ReportsAPI.html +26 -8
- package/website/interfaces/roles.RolesAPI.html +6 -6
- package/website/interfaces/sharing-tasks.SharingTasksAPI.html +14 -14
- package/website/interfaces/spaces.SpacesAPI.html +18 -18
- package/website/interfaces/tasks.TasksAPI.html +11 -11
- package/website/interfaces/temp-contents.TempContentsAPI.html +4 -4
- package/website/interfaces/tenants.TenantsAPI.html +7 -7
- package/website/interfaces/themes.ThemesAPI.html +8 -8
- package/website/interfaces/transports.TransportsAPI.html +7 -7
- package/website/interfaces/ui-config.UiConfigAPI.html +8 -8
- package/website/interfaces/users.UsersAPI.html +10 -10
- package/website/interfaces/web-integrations.WebIntegrationsAPI.html +6 -6
- package/website/interfaces/web-notifications.WebNotificationsAPI.html +7 -7
- package/website/interfaces/webhooks.WebhooksAPI.html +11 -11
- package/website/modules/audits.html +1 -1
- package/website/modules/automations.html +1 -1
- package/website/modules/automl-deployments.html +1 -1
- package/website/modules/automl-predictions.html +1 -1
- package/website/modules/di-projects.html +1 -1
- package/website/modules/ml.html +1 -1
- package/website/modules/reports.html +1 -1
- package/website/types/api-keys.Error.html +1 -1
- package/website/types/apps.Error.html +1 -1
- package/website/types/apps.Evaluation.html +1 -1
- package/website/types/apps.RecommendItems.html +1 -1
- package/website/types/apps.RecommendedAnalysis.html +1 -1
- package/website/types/apps.ScriptMetaList.html +4 -3
- package/website/types/assistants.Assistant.html +4 -2
- package/website/types/assistants.CreateAssistant.html +4 -2
- package/website/types/assistants.CreateAssistantWithAvatar.html +4 -2
- package/website/types/assistants.PromptInput.html +1 -1
- package/website/types/audits.EventExtensions.html +1 -1
- package/website/types/audits.FetchConsumptionAppAuditsHttpError.html +4 -0
- package/website/types/audits.FetchConsumptionAppAuditsHttpResponse.html +4 -0
- package/website/types/audits.GetSettingsResult.html +1 -1
- package/website/types/automations.AutomationDetailUpdateRequestObject.html +6 -0
- package/website/types/automations.CopyAutomationHttpResponse.html +1 -1
- package/website/types/automations.RunDetailResponseObject.html +1 -1
- package/website/types/automl-deployments.Error.html +1 -1
- package/website/types/automl-predictions.Error.html +1 -1
- package/website/types/collections.CollectionByIdPatch.html +1 -1
- package/website/types/csp-origins.CSPEntry.html +1 -1
- package/website/types/data-alerts.AlertingExecutionListResponse.html +1 -1
- package/website/types/data-alerts.AlertingTaskListResponse.html +1 -1
- package/website/types/data-connections.ActionDeleteRequest.html +1 -1
- package/website/types/data-connections.ActionUpdateRequest.html +1 -1
- package/website/types/data-connections.BulkResponse.html +1 -1
- package/website/types/data-connections.Link.html +1 -1
- package/website/types/data-connections.PatchRequest.html +1 -1
- package/website/types/data-connections.TopLevelLink.html +3 -3
- package/website/types/data-credentials.Link.html +1 -1
- package/website/types/data-credentials.PatchRequest.html +1 -1
- package/website/types/data-qualities.DataQualityComputationRequest.html +1 -1
- package/website/types/data-sources.GetDataSourceGatewaysHttpResponse.html +1 -1
- package/website/types/data-sources.QriDefinition.html +2 -2
- package/website/types/di-projects.AsyncActionDetails.html +1 -1
- package/website/types/di-projects.DataTaskInstanceState.html +30 -0
- package/website/types/di-projects.DataTaskRuntimeState.html +6 -0
- package/website/types/di-projects.GetDiProjectDiTaskRuntimeStateHttpResponse.html +2 -2
- package/website/types/encryption.KeyProvider.html +1 -1
- package/website/types/global-types.PerformInteractiveLoginFn.html +1 -1
- package/website/types/groups.AssignedRoles.html +1 -1
- package/website/types/groups.AssignedRolesRefIDs.html +1 -1
- package/website/types/groups.AssignedRolesRefNames.html +1 -1
- package/website/types/groups.Error.html +1 -1
- package/website/types/identity-providers.CreateJWTAuthPayload.html +1 -1
- package/website/types/identity-providers.CreateOIDCPayload.html +2 -2
- package/website/types/identity-providers.CreateSAMLPayload.html +2 -2
- package/website/types/identity-providers.Error.html +1 -1
- package/website/types/identity-providers.IDPOIDC.html +1 -1
- package/website/types/identity-providers.IDPSAML.html +1 -1
- package/website/types/identity-providers.IDPsStatus.html +1 -1
- package/website/types/identity-providers.Links.html +3 -3
- package/website/types/identity-providers.PendingResult.html +1 -1
- package/website/types/interceptors.RestInterceptor.html +1 -1
- package/website/types/invoke-fetch-types.DownloadableBlob.html +1 -1
- package/website/types/items.ItemsSettingsPatch.html +1 -1
- package/website/types/licenses.AssignmentsActionsAddRequest.html +1 -1
- package/website/types/licenses.AssignmentsActionsAddResponse.html +1 -1
- package/website/types/licenses.AssignmentsActionsDeleteRequest.html +1 -1
- package/website/types/licenses.AssignmentsActionsDeleteResponse.html +1 -1
- package/website/types/licenses.AssignmentsActionsUpdateRequest.html +1 -1
- package/website/types/licenses.AssignmentsActionsUpdateResponse.html +1 -1
- package/website/types/licenses.AssignmentsResponse.html +1 -1
- package/website/types/licenses.ConsumptionEventsResponse.html +1 -1
- package/website/types/licenses.ErrorResponse.html +1 -1
- package/website/types/licenses.LicenseOverview.html +2 -2
- package/website/types/lineage-graphs.ErrorResponse500.html +1 -1
- package/website/types/lineage-graphs.Graph.html +1 -1
- package/website/types/lineage-graphs.Node.html +1 -1
- package/website/types/ml.APIError.html +1 -1
- package/website/types/ml.AliasFindResponse.html +1 -1
- package/website/types/ml.AliasGetResponse.html +1 -1
- package/website/types/ml.AliasPostResponse.html +1 -1
- package/website/types/ml.BatchPredictionActionResponse.html +1 -1
- package/website/types/ml.BatchPredictionFindResponse.html +1 -1
- package/website/types/ml.BatchPredictionGetResponse.html +1 -1
- package/website/types/ml.BatchPredictionPatch.html +1 -1
- package/website/types/ml.BatchPredictionPostResponse.html +1 -1
- package/website/types/ml.BatchPredictionScheduleGetResponse.html +1 -1
- package/website/types/ml.BatchPredictionScheduleInput.html +1 -1
- package/website/types/ml.BatchPredictionSchedulePatch.html +1 -1
- package/website/types/ml.BatchPredictionSchedulePutResponse.html +1 -1
- package/website/types/ml.DeploymentFindResponse.html +1 -1
- package/website/types/ml.DeploymentGetResponse.html +1 -1
- package/website/types/ml.DeploymentPatch.html +1 -1
- package/website/types/ml.DeploymentPostResponse.html +1 -1
- package/website/types/ml.ExperimentFindResponse.html +1 -1
- package/website/types/ml.ExperimentGetResponse.html +1 -1
- package/website/types/ml.ExperimentInput.html +1 -1
- package/website/types/ml.ExperimentModelRecommendationPostResponse.html +1 -1
- package/website/types/ml.ExperimentPostResponse.html +1 -1
- package/website/types/ml.ExperimentType.html +1 -1
- package/website/types/ml.ExperimentVersionFindResponse.html +1 -1
- package/website/types/ml.ExperimentVersionGetResponse.html +1 -1
- package/website/types/ml.ExperimentVersionPatch.html +1 -1
- package/website/types/ml.ExperimentVersionPostResponse.html +1 -1
- package/website/types/ml.Insights.html +1 -1
- package/website/types/ml.ModelAlgorithm.html +1 -1
- package/website/types/ml.ModelAlgorithmAbbreviation.html +1 -1
- package/website/types/ml.ModelFindResponse.html +1 -1
- package/website/types/ml.ModelGetResponse.html +1 -1
- package/website/types/ml.Pipeline.html +2 -3
- package/website/types/ml.ProfileInsights.html +1 -1
- package/website/types/ml.ProfileInsightsGetResponse.html +1 -1
- package/website/types/ml.ProfileInsightsInput.html +1 -1
- package/website/types/ml.ResponseLinks.html +5 -5
- package/website/types/notifications.NotificationItem.html +1 -1
- package/website/types/oauth-clients.ClientSecrets.html +1 -1
- package/website/types/oauth-clients.OAuthClientAdminListItem.html +1 -1
- package/website/types/oauth-clients.OAuthClientAdminReadResponse.html +1 -1
- package/website/types/oauth-clients.OAuthClientCreateRequest.html +1 -1
- package/website/types/oauth-clients.OAuthClientCreateResponse.html +1 -1
- package/website/types/oauth-clients.OAuthClientReadResponse.html +1 -1
- package/website/types/qix.DocAction.html +1 -1
- package/website/types/qix.NativeGenericObjectFunctions.html +1 -1
- package/website/types/qix.RpcObject.html +1 -1
- package/website/types/qix.UndoInfoObject.html +1 -1
- package/website/types/qix.UseAppHook.html +1 -1
- package/website/types/questions.Error.html +1 -1
- package/website/types/questions.NLMetricsResponse.html +1 -1
- package/website/types/quotas.Quota.html +1 -1
- package/website/types/reload-tasks.PostTaskBody.html +1 -1
- package/website/types/reload-tasks.PutTaskBody.html +1 -1
- package/website/types/reload-tasks.Task.html +1 -1
- package/website/types/reports.GetReportOutputsHttpError.html +4 -0
- package/website/types/reports.GetReportOutputsHttpResponse.html +6 -0
- package/website/types/reports.LinkResponse.html +2 -0
- package/website/types/reports.LinksResponse.html +7 -0
- package/website/types/reports.OutputList.html +4 -0
- package/website/types/reports.OutputListItem.html +13 -0
- package/website/types/reports.PdfOutput.html +1 -1
- package/website/types/roles.Error.html +1 -1
- package/website/types/sharing-tasks.SharingExecutionListResponse.html +1 -1
- package/website/types/sharing-tasks.SharingTaskRecurringListResponse.html +1 -1
- package/website/types/sharing-tasks.SharingTaskRecurringResponse.html +1 -1
- package/website/types/spaces.Assignments.html +1 -1
- package/website/types/spaces.Error.html +1 -1
- package/website/types/spaces.Errors.html +1 -1
- package/website/types/spaces.SharePatch.html +1 -1
- package/website/types/spaces.Shares.html +1 -1
- package/website/types/spaces.Space.html +1 -1
- package/website/types/spaces.SpacePatch.html +1 -1
- package/website/types/spaces.Spaces.html +1 -1
- package/website/types/tasks.Action.html +1 -1
- package/website/types/tasks.Crondef.html +1 -1
- package/website/types/tasks.Eventstate.html +1 -1
- package/website/types/tasks.Functionref.html +1 -1
- package/website/types/tasks.GetTaskRunLogHttpResponse.html +1 -1
- package/website/types/tasks.Schedule.html +1 -1
- package/website/types/temp-contents.Error.html +1 -1
- package/website/types/tenants.Error.html +1 -1
- package/website/types/tenants.Tenant.html +1 -1
- package/website/types/tenants.TenantPatchErrors.html +1 -1
- package/website/types/tenants.TenantPatchSchema.html +1 -1
- package/website/types/transports.DeleteConfigNotFoundError.html +1 -1
- package/website/types/transports.SendTestMailConfigNotFoundError.html +1 -1
- package/website/types/transports.TenantAdminError.html +1 -1
- package/website/types/transports.UpdateEmailConfigError.html +1 -1
- package/website/types/transports.VerifyConnectionConfigNotFoundError.html +1 -1
- package/website/types/ui-config.JSONPatchPinnedLinkPayload.html +1 -1
- package/website/types/users.AssignedGroups.html +1 -1
- package/website/types/users.AssignedGroupsRefNames.html +1 -1
- package/website/types/users.AssignedRoles.html +1 -1
- package/website/types/users.Error.html +1 -1
- package/website/types/users.InviteErrorItem.html +1 -1
- package/website/types/users.RefIDs.html +1 -1
- package/website/types/users.RefNames.html +1 -1
- package/website/types/users.User.html +1 -1
- package/website/types/users.Users.html +1 -1
- package/website/types/web-integrations.Error.html +1 -1
- package/website/types/web-integrations.WebIntegrationPost.html +1 -1
- package/website/types/web-integrations.WebIntegrations.html +1 -1
- package/website/types/webhooks.Delivery.html +2 -2
- package/website/types/webhooks.WebhookPost.html +1 -1
- package/website/types/webhooks.WebhookResponse.html +1 -1
- package/website/variables/index.auth.html +1 -1
- package/website/variables/index.createQlikApi.html +1 -1
- package/website/variables/qix.QIX_SCHEMA_VERSION.html +1 -1
- package/chunks/dist-CjqdvDf3.js +0 -52
- package/website/types/di-projects.DataTaskInstanceStateOld.html +0 -3
- package/website/types/ml.ConfigurationKey.html +0 -1
- package/website/types/ml.DataSchemaConfiguration.html +0 -3
|
@@ -8,21 +8,21 @@
|
|
|
8
8
|
<a href="#patchgroup" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>patch<wbr/>Group</span></a>
|
|
9
9
|
<a href="#patchgroupssettings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>patch<wbr/>Groups<wbr/>Settings</span></a>
|
|
10
10
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearcache"><span>clear<wbr/>Cache</span><a href="#clearcache" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">clearCache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Clears the cache for groups api requests.</p>
|
|
11
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
11
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears the cache for groups api requests.</p>
|
|
12
12
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="creategroup"><span>create<wbr/>Group</span><a href="#creategroup" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">createGroup</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/groups.GroupPostSchema.html" class="tsd-signature-type tsd-kind-type-alias">GroupPostSchema</a><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/groups.CreateGroupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateGroupHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates a new group. The maximum number of groups a tenant can have is 10,000. Group names are case-sensitive, and must be unique.</p>
|
|
13
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
13
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/groups.GroupPostSchema.html" class="tsd-signature-type tsd-kind-type-alias">GroupPostSchema</a><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/groups.CreateGroupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateGroupHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new group. The maximum number of groups a tenant can have is 10,000. Group names are case-sensitive, and must be unique.</p>
|
|
14
14
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/groups.GroupPostSchema.html" class="tsd-signature-type tsd-kind-type-alias">GroupPostSchema</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
15
15
|
</div><div class="tsd-comment tsd-typography"></div></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/groups.CreateGroupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateGroupHttpResponse</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>CreateGroupHttpError</p>
|
|
16
16
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body">Param: body<a href="#param-body" 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>an object with the body content</p>
|
|
17
17
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-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>CreateGroupHttpError</p>
|
|
18
18
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletegroup"><span>delete<wbr/>Group</span><a href="#deletegroup" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteGroup</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">groupId</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">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/groups.DeleteGroupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteGroupHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes the requested group.</p>
|
|
19
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
19
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <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><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/groups.DeleteGroupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteGroupHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes the requested group.</p>
|
|
20
20
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the group to delete.</p>
|
|
21
21
|
</div><div class="tsd-comment tsd-typography"></div></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/groups.DeleteGroupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteGroupHttpResponse</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-2">Throws<a href="#throws-2" 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>DeleteGroupHttpError</p>
|
|
22
22
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-groupid">Param: groupId<a href="#param-groupid" 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 ID of the group to delete.</p>
|
|
23
23
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-3">Throws<a href="#throws-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>DeleteGroupHttpError</p>
|
|
24
24
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="filtergroups"><span>filter<wbr/>Groups</span><a href="#filtergroups" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">filterGroups</span><span class="tsd-signature-symbol">:</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">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> <span class="tsd-signature-type">"name"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</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">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/groups.Filter.html" class="tsd-signature-type tsd-kind-type-alias">Filter</a><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/groups.FilterGroupsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">FilterGroupsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves a list of groups matching the filter using advanced query string.</p>
|
|
25
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
25
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><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">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> <span class="tsd-signature-type">"name"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</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">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/groups.Filter.html" class="tsd-signature-type tsd-kind-type-alias">Filter</a><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/groups.FilterGroupsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">FilterGroupsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a list of groups matching the filter using advanced query string.</p>
|
|
26
26
|
</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">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> <span class="tsd-signature-type">"name"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-name"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"+name"</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>
|
|
27
27
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><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>
|
|
28
28
|
</div><div class="tsd-comment tsd-typography"></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 with IDs that are higher than the target user ID. Cannot be used in conjunction with prev.</p>
|
|
@@ -34,13 +34,13 @@
|
|
|
34
34
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-1">Param: body<a href="#param-body-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>an object with the body content</p>
|
|
35
35
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-5">Throws<a href="#throws-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>FilterGroupsHttpError</p>
|
|
36
36
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getgroup"><span>get<wbr/>Group</span><a href="#getgroup" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">getGroup</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">groupId</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">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/groups.GetGroupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetGroupHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Returns the requested group.</p>
|
|
37
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
37
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <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><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/groups.GetGroupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetGroupHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the requested group.</p>
|
|
38
38
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The group's unique identifier</p>
|
|
39
39
|
</div><div class="tsd-comment tsd-typography"></div></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/groups.GetGroupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetGroupHttpResponse</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-6">Throws<a href="#throws-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>GetGroupHttpError</p>
|
|
40
40
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-groupid-1">Param: groupId<a href="#param-groupid-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>The group's unique identifier</p>
|
|
41
41
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-7">Throws<a href="#throws-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>GetGroupHttpError</p>
|
|
42
42
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getgroups"><span>get<wbr/>Groups</span><a href="#getgroups" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">getGroups</span><span class="tsd-signature-symbol">:</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">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> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">systemGroups</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">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/groups.GetGroupsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetGroupsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Returns a list of groups with cursor-based pagination.</p>
|
|
43
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
43
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><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">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> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">systemGroups</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">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/groups.GetGroupsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetGroupsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a list of groups with cursor-based pagination.</p>
|
|
44
44
|
</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">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> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">systemGroups</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">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>
|
|
45
45
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><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>
|
|
46
46
|
</div><div class="tsd-comment tsd-typography"></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 groups to retrieve.</p>
|
|
@@ -53,11 +53,11 @@
|
|
|
53
53
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-1">Param: query<a href="#param-query-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>an object with query parameters</p>
|
|
54
54
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-9">Throws<a href="#throws-9" 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>GetGroupsHttpError</p>
|
|
55
55
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getgroupssettings"><span>get<wbr/>Groups<wbr/>Settings</span><a href="#getgroupssettings" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">getGroupsSettings</span><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/groups.GetGroupsSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetGroupsSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Returns the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.</p>
|
|
56
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
56
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><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><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/groups.GetGroupsSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetGroupsSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.</p>
|
|
57
57
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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/groups.GetGroupsSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetGroupsSettingsHttpResponse</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-10">Throws<a href="#throws-10" 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>GetGroupsSettingsHttpError</p>
|
|
58
58
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-11">Throws<a href="#throws-11" 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>GetGroupsSettingsHttpError</p>
|
|
59
59
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchgroup"><span>patch<wbr/>Group</span><a href="#patchgroup" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">patchGroup</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">groupId</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">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/groups.GroupPatchSchema.html" class="tsd-signature-type tsd-kind-type-alias">GroupPatchSchema</a><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/groups.PatchGroupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchGroupHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates the requested group.</p>
|
|
60
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
60
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">groupId</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">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/groups.GroupPatchSchema.html" class="tsd-signature-type tsd-kind-type-alias">GroupPatchSchema</a><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/groups.PatchGroupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchGroupHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the requested group.</p>
|
|
61
61
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the group to update.</p>
|
|
62
62
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/groups.GroupPatchSchema.html" class="tsd-signature-type tsd-kind-type-alias">GroupPatchSchema</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
63
63
|
</div><div class="tsd-comment tsd-typography"></div></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/groups.PatchGroupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchGroupHttpResponse</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-12">Throws<a href="#throws-12" 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>PatchGroupHttpError</p>
|
|
@@ -65,7 +65,7 @@
|
|
|
65
65
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-2">Param: body<a href="#param-body-2" 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>an object with the body content</p>
|
|
66
66
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-13">Throws<a href="#throws-13" 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>PatchGroupHttpError</p>
|
|
67
67
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchgroupssettings"><span>patch<wbr/>Groups<wbr/>Settings</span><a href="#patchgroupssettings" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">patchGroupsSettings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/groups.SettingsPatchSchema.html" class="tsd-signature-type tsd-kind-type-alias">SettingsPatchSchema</a><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/groups.PatchGroupsSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchGroupsSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.</p>
|
|
68
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
68
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/groups.SettingsPatchSchema.html" class="tsd-signature-type tsd-kind-type-alias">SettingsPatchSchema</a><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/groups.PatchGroupsSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchGroupsSettingsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the tenant's group settings, such as whether automatic group creation and IdP group synchronization are enabled or disabled, and roles assigned to system groups.</p>
|
|
69
69
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/groups.SettingsPatchSchema.html" class="tsd-signature-type tsd-kind-type-alias">SettingsPatchSchema</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
70
70
|
</div><div class="tsd-comment tsd-typography"></div></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/groups.PatchGroupsSettingsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchGroupsSettingsHttpResponse</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-14">Throws<a href="#throws-14" 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>PatchGroupsSettingsHttpError</p>
|
|
71
71
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-3">Param: body<a href="#param-body-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>an object with the body content</p>
|
|
@@ -8,27 +8,27 @@
|
|
|
8
8
|
<a href="#getmyidpmeta" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>My<wbr/>Idp<wbr/>Meta</span></a>
|
|
9
9
|
<a href="#patchidp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>patch<wbr/>Idp</span></a>
|
|
10
10
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearcache"><span>clear<wbr/>Cache</span><a href="#clearcache" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">clearCache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Clears the cache for identity-providers api requests.</p>
|
|
11
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
11
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears the cache for identity-providers api requests.</p>
|
|
12
12
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createidp"><span>create<wbr/>Idp</span><a href="#createidp" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">createIdp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/identity-providers.IDPPostSchema.html" class="tsd-signature-type tsd-kind-type-alias">IDPPostSchema</a><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/identity-providers.CreateIdpHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateIdpHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates a new IdP on a tenant. Requesting user must be assigned the <code>TenantAdmin</code> role. For non-interactive IdPs (e.g. JWT), IdP must be created by sending <code>options</code> payload. For interactive IdPs (e.g. SAML or OIDC), send <code>pendingOptions</code> payload to require the interactive verification step; or send <code>options</code> payload with <code>skipVerify</code> set to <code>true</code> to skip validation step and make IdP immediately available.</p>
|
|
13
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
13
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/identity-providers.IDPPostSchema.html" class="tsd-signature-type tsd-kind-type-alias">IDPPostSchema</a><span class="tsd-signature-symbol">,</span> <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><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/identity-providers.CreateIdpHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateIdpHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new IdP on a tenant. Requesting user must be assigned the <code>TenantAdmin</code> role. For non-interactive IdPs (e.g. JWT), IdP must be created by sending <code>options</code> payload. For interactive IdPs (e.g. SAML or OIDC), send <code>pendingOptions</code> payload to require the interactive verification step; or send <code>options</code> payload with <code>skipVerify</code> set to <code>true</code> to skip validation step and make IdP immediately available.</p>
|
|
14
14
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/identity-providers.IDPPostSchema.html" class="tsd-signature-type tsd-kind-type-alias">IDPPostSchema</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
15
15
|
</div><div class="tsd-comment tsd-typography"></div></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/identity-providers.CreateIdpHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateIdpHttpResponse</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>CreateIdpHttpError</p>
|
|
16
16
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body">Param: body<a href="#param-body" 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>an object with the body content</p>
|
|
17
17
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-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>CreateIdpHttpError</p>
|
|
18
18
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteidp"><span>delete<wbr/>Idp</span><a href="#deleteidp" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteIdp</span><span class="tsd-signature-symbol">:</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">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/identity-providers.DeleteIdpHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteIdpHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes an identity provider. Requesting user must be assigned the <code>TenantAdmin</code> role.</p>
|
|
19
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
19
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><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> <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><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/identity-providers.DeleteIdpHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteIdpHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes an identity provider. Requesting user must be assigned the <code>TenantAdmin</code> role.</p>
|
|
20
20
|
</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 identity provider ID.</p>
|
|
21
21
|
</div><div class="tsd-comment tsd-typography"></div></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/identity-providers.DeleteIdpHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteIdpHttpResponse</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-2">Throws<a href="#throws-2" 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>DeleteIdpHttpError</p>
|
|
22
22
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id">Param: id<a href="#param-id" 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 identity provider ID.</p>
|
|
23
23
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-3">Throws<a href="#throws-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>DeleteIdpHttpError</p>
|
|
24
24
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getidp"><span>get<wbr/>Idp</span><a href="#getidp" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">getIdp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><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> <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> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/identity-providers.GetIdpHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetIdpHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves a specific IdP. Requesting user must be assigned the <code>TenantAdmin</code> role.</p>
|
|
25
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
25
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><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> <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><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/identity-providers.GetIdpHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetIdpHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a specific IdP. Requesting user must be assigned the <code>TenantAdmin</code> role.</p>
|
|
26
26
|
</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 identity provider ID.</p>
|
|
27
27
|
</div><div class="tsd-comment tsd-typography"></div></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/identity-providers.GetIdpHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetIdpHttpResponse</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-4">Throws<a href="#throws-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>GetIdpHttpError</p>
|
|
28
28
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-1">Param: id<a href="#param-id-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>The identity provider ID.</p>
|
|
29
29
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-5">Throws<a href="#throws-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>GetIdpHttpError</p>
|
|
30
30
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getidps"><span>get<wbr/>Idps</span><a href="#getidps" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">getIdps</span><span class="tsd-signature-symbol">:</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">active</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">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-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/identity-providers.GetIdpsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetIdpsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>This endpoint retrieves any IdPs registered on the tenant.</p>
|
|
31
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
31
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><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">active</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">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-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/identity-providers.GetIdpsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetIdpsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This endpoint retrieves any IdPs registered on the tenant.</p>
|
|
32
32
|
</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> <span class="tsd-kind-property">active</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <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> <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> <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></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
33
33
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">active</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If provided, filters the results by the active field.</p>
|
|
34
34
|
</div><div class="tsd-comment tsd-typography"></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 IdP entries to retrieve.</p>
|
|
@@ -38,19 +38,19 @@
|
|
|
38
38
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query">Param: query<a href="#param-query" 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>an object with query parameters</p>
|
|
39
39
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-7">Throws<a href="#throws-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>GetIdpsHttpError</p>
|
|
40
40
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getidpstatuses"><span>get<wbr/>Idp<wbr/>Statuses</span><a href="#getidpstatuses" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">getIdpStatuses</span><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/identity-providers.GetIdpStatusesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetIdpStatusesHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves the status of all IdP configurations. Requires <code>TenantAdmin</code> role.</p>
|
|
41
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
41
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><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><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/identity-providers.GetIdpStatusesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetIdpStatusesHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the status of all IdP configurations. Requires <code>TenantAdmin</code> role.</p>
|
|
42
42
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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/identity-providers.GetIdpStatusesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetIdpStatusesHttpResponse</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-8">Throws<a href="#throws-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>GetIdpStatusesHttpError</p>
|
|
43
43
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-9">Throws<a href="#throws-9" 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>GetIdpStatusesHttpError</p>
|
|
44
44
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getidpwellknownmetadata"><span>get<wbr/>Idp<wbr/>Well<wbr/>Known<wbr/>Meta<wbr/>Data</span><a href="#getidpwellknownmetadata" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">getIdpWellKnownMetaData</span><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/identity-providers.GetIdpWellKnownMetaDataHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetIdpWellKnownMetaDataHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Returns IdP configuration metadata supported on the tenant. Clients can use this information to programmatically configure their interactions with Qlik Cloud.</p>
|
|
45
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
45
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><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><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/identity-providers.GetIdpWellKnownMetaDataHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetIdpWellKnownMetaDataHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns IdP configuration metadata supported on the tenant. Clients can use this information to programmatically configure their interactions with Qlik Cloud.</p>
|
|
46
46
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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/identity-providers.GetIdpWellKnownMetaDataHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetIdpWellKnownMetaDataHttpResponse</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-10">Throws<a href="#throws-10" 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>GetIdpWellKnownMetaDataHttpError</p>
|
|
47
47
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-11">Throws<a href="#throws-11" 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>GetIdpWellKnownMetaDataHttpError</p>
|
|
48
48
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getmyidpmeta"><span>get<wbr/>My<wbr/>Idp<wbr/>Meta</span><a href="#getmyidpmeta" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">getMyIdpMeta</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><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> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/identity-providers.GetMyIdpMetaHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetMyIdpMetaHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves default IdP metadata when no interactive IdP is enabled.</p>
|
|
49
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
49
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><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><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/identity-providers.GetMyIdpMetaHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetMyIdpMetaHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves default IdP metadata when no interactive IdP is enabled.</p>
|
|
50
50
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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/identity-providers.GetMyIdpMetaHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetMyIdpMetaHttpResponse</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-12">Throws<a href="#throws-12" 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>GetMyIdpMetaHttpError</p>
|
|
51
51
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-13">Throws<a href="#throws-13" 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>GetMyIdpMetaHttpError</p>
|
|
52
52
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchidp"><span>patch<wbr/>Idp</span><a href="#patchidp" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">patchIdp</span><span class="tsd-signature-symbol">:</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">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/identity-providers.IDPPatchSchema.html" class="tsd-signature-type tsd-kind-type-alias">IDPPatchSchema</a><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/identity-providers.PatchIdpHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchIdpHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates the configuration of an IdP. Requesting user must be assigned the <code>TenantAdmin</code> role. Partial failure is treated as complete failure and returns an error.</p>
|
|
53
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
53
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><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">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/identity-providers.IDPPatchSchema.html" class="tsd-signature-type tsd-kind-type-alias">IDPPatchSchema</a><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/identity-providers.PatchIdpHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchIdpHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the configuration of an IdP. Requesting user must be assigned the <code>TenantAdmin</code> role. Partial failure is treated as complete failure and returns an error.</p>
|
|
54
54
|
</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 identity provider ID.</p>
|
|
55
55
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/identity-providers.IDPPatchSchema.html" class="tsd-signature-type tsd-kind-type-alias">IDPPatchSchema</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
56
56
|
</div><div class="tsd-comment tsd-typography"></div></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/identity-providers.PatchIdpHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchIdpHttpResponse</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-14">Throws<a href="#throws-14" 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>PatchIdpHttpError</p>
|
|
@@ -3,16 +3,16 @@
|
|
|
3
3
|
<a href="#removeinterceptor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remove<wbr/>Interceptor</span></a>
|
|
4
4
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="addinterceptor"><span>add<wbr/>Interceptor</span><a href="#addinterceptor" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">addInterceptor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">interceptor</span><span class="tsd-signature-symbol">:</span> <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a></div><div class="tsd-comment tsd-typography"><p>Adds an interceptor to the global interceptor stack
|
|
5
5
|
Returns the newly added interceptor</p>
|
|
6
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
6
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">interceptor</span><span class="tsd-signature-symbol">:</span> <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds an interceptor to the global interceptor stack
|
|
7
7
|
Returns the newly added interceptor</p>
|
|
8
8
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">interceptor</span>: <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a></span><div class="tsd-comment tsd-typography"><p>the interceptor to add</p>
|
|
9
9
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a></h4><p>the newly added interceptor</p>
|
|
10
10
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-interceptor">Param: interceptor<a href="#param-interceptor" 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 interceptor to add</p>
|
|
11
11
|
</div><div class="tsd-tag-returns"><h4 class="tsd-anchor-link" id="returns">Returns<a href="#returns" 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 newly added interceptor</p>
|
|
12
12
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getinterceptors"><span>get<wbr/>Interceptors</span><a href="#getinterceptors" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">getInterceptors</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Gets all registered interceptors</p>
|
|
13
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
13
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets all registered interceptors</p>
|
|
14
14
|
</div><h4 class="tsd-returns-title">Returns <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="removeinterceptor"><span>remove<wbr/>Interceptor</span><a href="#removeinterceptor" 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></h3><div class="tsd-signature"><span class="tsd-kind-property">removeInterceptor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">interceptor</span><span class="tsd-signature-symbol">:</span> <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a></div><div class="tsd-comment tsd-typography"><p>Removes an interceptor from the global interceptor stack</p>
|
|
15
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
15
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">interceptor</span><span class="tsd-signature-symbol">:</span> <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes an interceptor from the global interceptor stack</p>
|
|
16
16
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">interceptor</span>: <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a></span><div class="tsd-comment tsd-typography"><p>the interceptor remove</p>
|
|
17
17
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../types/interceptors.RestInterceptor.html" class="tsd-signature-type tsd-kind-type-alias">RestInterceptor</a></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-interceptor-1">Param: interceptor<a href="#param-interceptor-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>the interceptor remove</p>
|
|
18
18
|
</div></div></section></section></details></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><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#addinterceptor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Interceptor</span></a><a href="#getinterceptors"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Interceptors</span></a><a href="#removeinterceptor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>remove<wbr/>Interceptor</span></a></div></details></div></details></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>
|