@qlik/api 0.1.0 → 0.1.1
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.js +2 -2
- package/apps.d.ts +9 -1
- package/apps.js +2 -2
- package/audits.js +2 -2
- package/auth.js +2 -2
- package/automations.js +2 -2
- package/brands.js +2 -2
- package/chunks/{RNLZBOJU.js → CHNBNLXY.js} +1 -1
- package/chunks/{LHCJKIEO.js → FFGE2RP7.js} +1 -1
- package/chunks/{VK2CODYY.js → JEGN7XQV.js} +1 -1
- package/chunks/{D62LI5YU.js → RHF624NQ.js} +1 -1
- package/chunks/{4V5AAWUI.js → TT66UJZY.js} +1 -1
- package/chunks/{TFSRDRRS.js → XZQNE4HH.js} +1 -1
- package/collections.js +2 -2
- package/csp-origins.js +2 -2
- package/data-assets.js +2 -2
- package/data-connections.js +2 -2
- package/data-credentials.js +2 -2
- package/data-files.js +2 -2
- package/extensions.js +2 -2
- package/glossaries.js +2 -2
- package/groups.js +2 -2
- package/identity-providers.d.ts +144 -10
- package/identity-providers.js +2 -2
- package/index.js +4 -4
- package/items.js +2 -2
- package/licenses.js +2 -2
- package/package.json +1 -1
- package/qix.d.ts +1 -1
- package/qix.js +2 -2
- package/quotas.js +2 -2
- package/reload-tasks.js +2 -2
- package/reloads.js +2 -2
- package/roles.js +2 -2
- package/spaces.js +2 -2
- package/temp-contents.js +2 -2
- package/tenants.js +2 -2
- package/themes.js +2 -2
- package/transports.js +2 -2
- package/users.js +2 -2
- package/web-integrations.js +2 -2
- package/web-notifications.js +2 -2
- package/webhooks.js +2 -2
package/api-keys.js
CHANGED
package/apps.d.ts
CHANGED
|
@@ -796,6 +796,12 @@ type RecommendedAnalysisCore = {
|
|
|
796
796
|
/** percentage of selected items in the analysis to the overall items passed to the endpoint */
|
|
797
797
|
relevance?: number;
|
|
798
798
|
};
|
|
799
|
+
type ReloadIncludeFile = {
|
|
800
|
+
/** The connection name. */
|
|
801
|
+
connection?: string;
|
|
802
|
+
/** File location within the connection. */
|
|
803
|
+
path?: string;
|
|
804
|
+
};
|
|
799
805
|
type ReloadListMetadata = {
|
|
800
806
|
/** Array of ReloadMeta. */
|
|
801
807
|
data?: ReloadMeta[];
|
|
@@ -809,6 +815,8 @@ type ReloadMeta = {
|
|
|
809
815
|
duration?: number;
|
|
810
816
|
/** Time when reload ended. */
|
|
811
817
|
endTime?: string;
|
|
818
|
+
/** Files brought into the script via include/mustInclude macros. */
|
|
819
|
+
includeFiles?: ReloadIncludeFile[];
|
|
812
820
|
/** True if the reload is a partial reload. */
|
|
813
821
|
isPartialReload?: boolean;
|
|
814
822
|
loadDataFilesBytes?: number;
|
|
@@ -2428,4 +2436,4 @@ interface AppsAPI {
|
|
|
2428
2436
|
*/
|
|
2429
2437
|
declare const appsExport: AppsAPI;
|
|
2430
2438
|
|
|
2431
|
-
export { type Analysis, type AnalysisComposition, type AnalysisDescriptor, type AnalysisDescriptorResponse, type AnalysisDetails, type AnalysisGroup, type AnalysisModelItemField, type AnalysisModelItemMasterItem, type AnalysisModelResponse, type AnalysisModelResponseDetail, type AnalysisRecommendRequest, type AnalysisRecommendationResponse, type AnalysisRecommendationResponseDetail, type AppAttributes, type AppContentList, type AppContentListItem, type AppObjectGenericType, type AppUpdateAttributes, type AppsAPI, type ChartType, type Classification, type Classifications, type Cmpbool, type Cmpfloat, type CmpfloatWithTimeout, type Cmpint, type Comparison, type Comparisonfields, type ComparisonobjMemoryLimit, type Comparisonobjresponsetime, type Comparisonoobjheavy, type Comparisontables, type CompositionMinMax, type CopyAppHttpError, type CopyAppHttpResponse, type CountAppReportFiltersHttpError, type CountAppReportFiltersHttpResponse, type CreateApp, type CreateAppHttpError, type CreateAppHttpResponse, type CreateAppReportFilterHttpError, type CreateAppReportFilterHttpResponse, type DataModelMetadata, type DeleteAppHttpError, type DeleteAppHttpResponse, type DeleteAppMediaHttpError, type DeleteAppMediaHttpResponse, type DeleteAppReportFilterHttpError, type DeleteAppReportFilterHttpResponse, type DeleteAppScriptHttpError, type DeleteAppScriptHttpResponse, type Error, type Errors, type Evaluation, type Evaluations, type EvaluatorError, type Event, type ExportAppHttpError, type ExportAppHttpResponse, type FieldAttrType, type FieldAttributes, type FieldInTableProfilingData, type FieldMetadata, type FieldOverride, type FileData, type Filter, type FilterError, type FilterErrors, type FilterField, type FilterFieldValue, type FilterList, type FilterListItem, type FilterRequest, type FilterType, type FilterV10, type FilterVariable, type FiltersCount, type Float64, type FrequencyDistributionData, type GetAppDataLineageHttpError, type GetAppDataLineageHttpResponse, type GetAppDataMetadataHttpError, type GetAppDataMetadataHttpResponse, type GetAppEvaluationComparisonHttpError, type GetAppEvaluationComparisonHttpResponse, type GetAppEvaluationComparisonXmlHttpError, type GetAppEvaluationComparisonXmlHttpResponse, type GetAppEvaluationHttpError, type GetAppEvaluationHttpResponse, type GetAppEvaluationXmlHttpError, type GetAppEvaluationXmlHttpResponse, type GetAppEvaluationsHttpError, type GetAppEvaluationsHttpResponse, type GetAppInfoHttpError, type GetAppInfoHttpResponse, type GetAppInsightAnalysesHttpError, type GetAppInsightAnalysesHttpResponse, type GetAppInsightAnalysisModelHttpError, type GetAppInsightAnalysisModelHttpResponse, type GetAppInsightAnalysisRecommendationsHttpError, type GetAppInsightAnalysisRecommendationsHttpResponse, type GetAppMediaHttpError, type GetAppMediaHttpResponse, type GetAppMediaListHttpError, type GetAppMediaListHttpResponse, type GetAppReloadLogHttpError, type GetAppReloadLogHttpResponse, type GetAppReloadLogsHttpError, type GetAppReloadLogsHttpResponse, type GetAppReloadMetadataHttpError, type GetAppReloadMetadataHttpResponse, type GetAppReportFilterHttpError, type GetAppReportFilterHttpResponse, type GetAppReportFiltersHttpError, type GetAppReportFiltersHttpResponse, type GetAppScriptHistoryHttpError, type GetAppScriptHistoryHttpResponse, type GetAppScriptHttpError, type GetAppScriptHttpResponse, type GetAppThumbnailHttpError, type GetAppThumbnailHttpResponse, type GetAppsPrivilegesHttpError, type GetAppsPrivilegesHttpResponse, type HardwareMeta, type Href, type ImportAppHttpError, type ImportAppHttpResponse, type JsonObject, type LastReloadMetadata, type LineageInfoRest, type LinkResponse, type Links, type LinksResponse, type Log, type Metadata, type MoveAppToSpaceHttpError, type MoveAppToSpaceHttpResponse, type NavigationLink, type NavigationLinks, type NumberFormat, type NxApp, type NxAppCreatePrivileges, type NxAppObject, type NxAttributes, type NxObjectAttributes, type NxPatch, type NxPatchOperationType, type Objectmetrics, type Objectspec, type Objecttopspec, type PartialNluInfo, type PatchAppScriptHttpError, type PatchAppScriptHttpResponse, type PublishApp, type PublishAppHttpError, type PublishAppHttpResponse, type PublishData, type QueueAppEvaluationHttpError, type QueueAppEvaluationHttpResponse, type RecommendFieldItem, type RecommendItems, type RecommendMasterItem, type RecommendNaturalLangQuery, type RecommendedAnalysis, type RecommendedAnalysisCore, type ReloadListMetadata, type ReloadMeta, type ReloadStatements, type RemoveAppFromSpaceHttpError, type RemoveAppFromSpaceHttpResponse, type RepublishApp, type RepublishAppHttpError, type RepublishAppHttpResponse, type Result, type Resultentry, type Resultmetadatatopfields, type Resultmetadatatoptables, type ResultobjMemoryLimit, type Resultobjresponsetime, type Resultobjsheet, type Resultsingle, type ScriptLogList, type ScriptLogMeta, type ScriptMeta, type ScriptMetaList, type ScriptVersion, type SimplifiedClassifications, type Sortedcomparisonfields, type Sortedcomparisonobjresponsetime, type Sortedcomparisonoobjheavy, type Sortedcomparisontables, type SymbolFrequency, type SymbolValue, type TableMetadata, type TableProfilingData, type UpdateApp, type UpdateAppInfoHttpError, type UpdateAppInfoHttpResponse, type UpdateAppObjectOwnerHttpError, type UpdateAppObjectOwnerHttpResponse, type UpdateAppOwnerHttpError, type UpdateAppOwnerHttpResponse, type UpdateAppScriptHttpError, type UpdateAppScriptHttpResponse, type UpdateOwner, type UpdateSpace, type UploadAppMediaHttpError, type UploadAppMediaHttpResponse, type UsageEnum, type UserPrivileges, clearCache, copyApp, countAppReportFilters, createApp, createAppReportFilter, appsExport as default, deleteApp, deleteAppMedia, deleteAppReportFilter, deleteAppScript, exportApp, getAppDataLineage, getAppDataMetadata, getAppEvaluation, getAppEvaluationComparison, getAppEvaluationComparisonXml, getAppEvaluationXml, getAppEvaluations, getAppInfo, getAppInsightAnalyses, getAppInsightAnalysisModel, getAppInsightAnalysisRecommendations, getAppMedia, getAppMediaList, getAppReloadLog, getAppReloadLogs, getAppReloadMetadata, getAppReportFilter, getAppReportFilters, getAppScript, getAppScriptHistory, getAppThumbnail, getAppsPrivileges, importApp, moveAppToSpace, patchAppScript, publishApp, queueAppEvaluation, removeAppFromSpace, republishApp, updateAppInfo, updateAppObjectOwner, updateAppOwner, updateAppScript, uploadAppMedia };
|
|
2439
|
+
export { type Analysis, type AnalysisComposition, type AnalysisDescriptor, type AnalysisDescriptorResponse, type AnalysisDetails, type AnalysisGroup, type AnalysisModelItemField, type AnalysisModelItemMasterItem, type AnalysisModelResponse, type AnalysisModelResponseDetail, type AnalysisRecommendRequest, type AnalysisRecommendationResponse, type AnalysisRecommendationResponseDetail, type AppAttributes, type AppContentList, type AppContentListItem, type AppObjectGenericType, type AppUpdateAttributes, type AppsAPI, type ChartType, type Classification, type Classifications, type Cmpbool, type Cmpfloat, type CmpfloatWithTimeout, type Cmpint, type Comparison, type Comparisonfields, type ComparisonobjMemoryLimit, type Comparisonobjresponsetime, type Comparisonoobjheavy, type Comparisontables, type CompositionMinMax, type CopyAppHttpError, type CopyAppHttpResponse, type CountAppReportFiltersHttpError, type CountAppReportFiltersHttpResponse, type CreateApp, type CreateAppHttpError, type CreateAppHttpResponse, type CreateAppReportFilterHttpError, type CreateAppReportFilterHttpResponse, type DataModelMetadata, type DeleteAppHttpError, type DeleteAppHttpResponse, type DeleteAppMediaHttpError, type DeleteAppMediaHttpResponse, type DeleteAppReportFilterHttpError, type DeleteAppReportFilterHttpResponse, type DeleteAppScriptHttpError, type DeleteAppScriptHttpResponse, type Error, type Errors, type Evaluation, type Evaluations, type EvaluatorError, type Event, type ExportAppHttpError, type ExportAppHttpResponse, type FieldAttrType, type FieldAttributes, type FieldInTableProfilingData, type FieldMetadata, type FieldOverride, type FileData, type Filter, type FilterError, type FilterErrors, type FilterField, type FilterFieldValue, type FilterList, type FilterListItem, type FilterRequest, type FilterType, type FilterV10, type FilterVariable, type FiltersCount, type Float64, type FrequencyDistributionData, type GetAppDataLineageHttpError, type GetAppDataLineageHttpResponse, type GetAppDataMetadataHttpError, type GetAppDataMetadataHttpResponse, type GetAppEvaluationComparisonHttpError, type GetAppEvaluationComparisonHttpResponse, type GetAppEvaluationComparisonXmlHttpError, type GetAppEvaluationComparisonXmlHttpResponse, type GetAppEvaluationHttpError, type GetAppEvaluationHttpResponse, type GetAppEvaluationXmlHttpError, type GetAppEvaluationXmlHttpResponse, type GetAppEvaluationsHttpError, type GetAppEvaluationsHttpResponse, type GetAppInfoHttpError, type GetAppInfoHttpResponse, type GetAppInsightAnalysesHttpError, type GetAppInsightAnalysesHttpResponse, type GetAppInsightAnalysisModelHttpError, type GetAppInsightAnalysisModelHttpResponse, type GetAppInsightAnalysisRecommendationsHttpError, type GetAppInsightAnalysisRecommendationsHttpResponse, type GetAppMediaHttpError, type GetAppMediaHttpResponse, type GetAppMediaListHttpError, type GetAppMediaListHttpResponse, type GetAppReloadLogHttpError, type GetAppReloadLogHttpResponse, type GetAppReloadLogsHttpError, type GetAppReloadLogsHttpResponse, type GetAppReloadMetadataHttpError, type GetAppReloadMetadataHttpResponse, type GetAppReportFilterHttpError, type GetAppReportFilterHttpResponse, type GetAppReportFiltersHttpError, type GetAppReportFiltersHttpResponse, type GetAppScriptHistoryHttpError, type GetAppScriptHistoryHttpResponse, type GetAppScriptHttpError, type GetAppScriptHttpResponse, type GetAppThumbnailHttpError, type GetAppThumbnailHttpResponse, type GetAppsPrivilegesHttpError, type GetAppsPrivilegesHttpResponse, type HardwareMeta, type Href, type ImportAppHttpError, type ImportAppHttpResponse, type JsonObject, type LastReloadMetadata, type LineageInfoRest, type LinkResponse, type Links, type LinksResponse, type Log, type Metadata, type MoveAppToSpaceHttpError, type MoveAppToSpaceHttpResponse, type NavigationLink, type NavigationLinks, type NumberFormat, type NxApp, type NxAppCreatePrivileges, type NxAppObject, type NxAttributes, type NxObjectAttributes, type NxPatch, type NxPatchOperationType, type Objectmetrics, type Objectspec, type Objecttopspec, type PartialNluInfo, type PatchAppScriptHttpError, type PatchAppScriptHttpResponse, type PublishApp, type PublishAppHttpError, type PublishAppHttpResponse, type PublishData, type QueueAppEvaluationHttpError, type QueueAppEvaluationHttpResponse, type RecommendFieldItem, type RecommendItems, type RecommendMasterItem, type RecommendNaturalLangQuery, type RecommendedAnalysis, type RecommendedAnalysisCore, type ReloadIncludeFile, type ReloadListMetadata, type ReloadMeta, type ReloadStatements, type RemoveAppFromSpaceHttpError, type RemoveAppFromSpaceHttpResponse, type RepublishApp, type RepublishAppHttpError, type RepublishAppHttpResponse, type Result, type Resultentry, type Resultmetadatatopfields, type Resultmetadatatoptables, type ResultobjMemoryLimit, type Resultobjresponsetime, type Resultobjsheet, type Resultsingle, type ScriptLogList, type ScriptLogMeta, type ScriptMeta, type ScriptMetaList, type ScriptVersion, type SimplifiedClassifications, type Sortedcomparisonfields, type Sortedcomparisonobjresponsetime, type Sortedcomparisonoobjheavy, type Sortedcomparisontables, type SymbolFrequency, type SymbolValue, type TableMetadata, type TableProfilingData, type UpdateApp, type UpdateAppInfoHttpError, type UpdateAppInfoHttpResponse, type UpdateAppObjectOwnerHttpError, type UpdateAppObjectOwnerHttpResponse, type UpdateAppOwnerHttpError, type UpdateAppOwnerHttpResponse, type UpdateAppScriptHttpError, type UpdateAppScriptHttpResponse, type UpdateOwner, type UpdateSpace, type UploadAppMediaHttpError, type UploadAppMediaHttpResponse, type UsageEnum, type UserPrivileges, clearCache, copyApp, countAppReportFilters, createApp, createAppReportFilter, appsExport as default, deleteApp, deleteAppMedia, deleteAppReportFilter, deleteAppScript, exportApp, getAppDataLineage, getAppDataMetadata, getAppEvaluation, getAppEvaluationComparison, getAppEvaluationComparisonXml, getAppEvaluationXml, getAppEvaluations, getAppInfo, getAppInsightAnalyses, getAppInsightAnalysisModel, getAppInsightAnalysisRecommendations, getAppMedia, getAppMediaList, getAppReloadLog, getAppReloadLogs, getAppReloadMetadata, getAppReportFilter, getAppReportFilters, getAppScript, getAppScriptHistory, getAppThumbnail, getAppsPrivileges, importApp, moveAppToSpace, patchAppScript, publishApp, queueAppEvaluation, removeAppFromSpace, republishApp, updateAppInfo, updateAppObjectOwner, updateAppOwner, updateAppScript, uploadAppMedia };
|
package/apps.js
CHANGED
package/audits.js
CHANGED
package/auth.js
CHANGED
|
@@ -3,8 +3,8 @@ import {
|
|
|
3
3
|
logout,
|
|
4
4
|
registerAuthModule,
|
|
5
5
|
setDefaultHostConfig
|
|
6
|
-
} from "./chunks/
|
|
7
|
-
import "./chunks/
|
|
6
|
+
} from "./chunks/XZQNE4HH.js";
|
|
7
|
+
import "./chunks/TT66UJZY.js";
|
|
8
8
|
import "./chunks/4HB3TAEO.js";
|
|
9
9
|
export {
|
|
10
10
|
auth_default as default,
|
package/automations.js
CHANGED
package/brands.js
CHANGED
|
@@ -83,7 +83,7 @@ function listenForWindowsAuthenticationInformation(session) {
|
|
|
83
83
|
return authSuggestedInWebsocket;
|
|
84
84
|
}
|
|
85
85
|
async function createAndSetupEnigmaSession(props, canRetry) {
|
|
86
|
-
const { createEnigmaSession } = await import("./
|
|
86
|
+
const { createEnigmaSession } = await import("./JEGN7XQV.js");
|
|
87
87
|
const session = await createEnigmaSession(props);
|
|
88
88
|
setupSessionListeners(session, props);
|
|
89
89
|
let global;
|
|
@@ -9093,7 +9093,7 @@ var CREATABLE_RESOURCES = [
|
|
|
9093
9093
|
{ resource: "masterobject", canCreate: true },
|
|
9094
9094
|
{ resource: "snapshot", canCreate: true }
|
|
9095
9095
|
];
|
|
9096
|
-
var forceReadOnly =
|
|
9096
|
+
var forceReadOnly = false;
|
|
9097
9097
|
function parse(privileges, mapToObj) {
|
|
9098
9098
|
if (!privileges.length) {
|
|
9099
9099
|
privileges = ["update", "publish", "export", "exportdata", "changeowner", "delete"];
|
|
@@ -6,7 +6,7 @@ function getAuthRuntimeModule(hostConfig) {
|
|
|
6
6
|
async function getQixRuntimeModule(hostConfig) {
|
|
7
7
|
await getAuthRuntimeModule(hostConfig);
|
|
8
8
|
const isNode = !!globalThis.process?.argv;
|
|
9
|
-
return isNode ? import("./
|
|
9
|
+
return isNode ? import("./CHNBNLXY.js") : import("./OPRGGO4C.js").then((mod) => mod.importRuntimeModule("qix@v1", hostConfig));
|
|
10
10
|
}
|
|
11
11
|
async function getInvokeFetchRuntimeModule(hostConfig) {
|
|
12
12
|
await getAuthRuntimeModule(hostConfig);
|
package/collections.js
CHANGED
package/csp-origins.js
CHANGED
package/data-assets.js
CHANGED
package/data-connections.js
CHANGED
package/data-credentials.js
CHANGED
package/data-files.js
CHANGED
package/extensions.js
CHANGED
package/glossaries.js
CHANGED
package/groups.js
CHANGED
package/identity-providers.d.ts
CHANGED
|
@@ -19,13 +19,23 @@ type BaseIDP = {
|
|
|
19
19
|
meta?: unknown;
|
|
20
20
|
/** Direct the user on logout to a specific URI. */
|
|
21
21
|
postLogoutRedirectUri?: string;
|
|
22
|
-
/** The protocol to be used for communicating with the identity provider. Valid values are `OIDC`, `jwtAuth`, and `qsefw-local-bearer-token`. */
|
|
22
|
+
/** The protocol to be used for communicating with the identity provider. Valid values are `OIDC`, `SAML`, `jwtAuth`, and `qsefw-local-bearer-token`. */
|
|
23
23
|
protocol?: IDPProtocol;
|
|
24
24
|
/** The identity provider to be used. If protocol is `OIDC`, the valid values are `auth0`, `okta`, `generic`, `salesforce`, `keycloak`, `adfs`, and `azureAD`. If protocol is `jwtAuth`, the valid value is `external`. */
|
|
25
25
|
provider?: IDPProvider;
|
|
26
26
|
/** The tenant identifiers associated with the given IdP. */
|
|
27
27
|
tenantIds?: string[];
|
|
28
28
|
};
|
|
29
|
+
type CertificateInfo = {
|
|
30
|
+
/** The X.509 certificate for validating signed SAML responses. */
|
|
31
|
+
certificate: string;
|
|
32
|
+
/** Indicates whether the certificate is used for encryption. */
|
|
33
|
+
encryption?: boolean;
|
|
34
|
+
/** Given name for this certificate. */
|
|
35
|
+
name?: string;
|
|
36
|
+
/** Indicates whether the certificate is used for the signature. */
|
|
37
|
+
signature?: boolean;
|
|
38
|
+
};
|
|
29
39
|
/**
|
|
30
40
|
* Payload for creating an identity provider using JWT authentication.
|
|
31
41
|
*/
|
|
@@ -112,6 +122,68 @@ type CreateOIDCPayload = {
|
|
|
112
122
|
/** The tenant identifiers that map to the given IdP. */
|
|
113
123
|
tenantIds?: string[];
|
|
114
124
|
};
|
|
125
|
+
/**
|
|
126
|
+
* Payload for creating a SAML compatible identity provider.
|
|
127
|
+
*/
|
|
128
|
+
type CreateSAMLPayload = {
|
|
129
|
+
/** There can be clock skew between the IdP and Qlik's login server. In these cases, a tolerance can be set, decimals will be rounded off. */
|
|
130
|
+
clockToleranceSec?: number;
|
|
131
|
+
/** Tells the consumer of the IdP that new users should be created on login if they don't exist. */
|
|
132
|
+
createNewUsersOnLogin?: boolean;
|
|
133
|
+
description?: string;
|
|
134
|
+
/** Indicates whether the IdP is meant for interactive login. Must be true for SAML IdPs. */
|
|
135
|
+
interactive: boolean;
|
|
136
|
+
/** Required SAML configurations for IdPs with `skipVerify` flag enabled. */
|
|
137
|
+
options?: {
|
|
138
|
+
/** Toggle to allow IdP initated login by the SAML IdP. */
|
|
139
|
+
allowIdpInitiatedLogin?: boolean;
|
|
140
|
+
/** The certificates used for validating signed responses. Required if metadata is not provided. */
|
|
141
|
+
certificates?: CertificateInfo[];
|
|
142
|
+
/** Mappings from claim name to an array of SAML attribute names that point to locations in the claims from the IdP to retrieve the value from. */
|
|
143
|
+
claimsMapping: ClaimsMappingSAML;
|
|
144
|
+
/** The entity ID for the SAML IdP. Required if metadata is not provided. */
|
|
145
|
+
entityId?: string;
|
|
146
|
+
/** Metadata for the SAML IdP. Required if individual SAML parameters are not provided. */
|
|
147
|
+
metadata?: {
|
|
148
|
+
/** The IDP metadata XML in base64-encoded format. */
|
|
149
|
+
raw: string;
|
|
150
|
+
};
|
|
151
|
+
/** The name identifier format that will be requested from the identity provider. */
|
|
152
|
+
nameIdFormat?: "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress" | "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" | "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified";
|
|
153
|
+
/** The sign on URL for the SAML IdP. Required if metadata is not provided. */
|
|
154
|
+
signOnUrl?: string;
|
|
155
|
+
};
|
|
156
|
+
/** Required configurations for SAML IdPs that require verification. */
|
|
157
|
+
pendingOptions?: {
|
|
158
|
+
/** Toggle to allow IdP initated login by the SAML IdP. */
|
|
159
|
+
allowIdpInitiatedLogin?: boolean;
|
|
160
|
+
/** The certificates used for validating signed responses. Required if metadata is not provided. */
|
|
161
|
+
certificates?: CertificateInfo[];
|
|
162
|
+
/** Mappings from claim name to an array of SAML attribute names that point to locations in the claims from the IdP to retrieve the value from. */
|
|
163
|
+
claimsMapping: ClaimsMappingSAML;
|
|
164
|
+
/** The entity ID for the SAML IdP. Required if metadata is not provided. */
|
|
165
|
+
entityId?: string;
|
|
166
|
+
/** Metadata for the SAML IdP. Required if individual SAML parameters are not provided. */
|
|
167
|
+
metadata?: {
|
|
168
|
+
/** The IDP metadata XML in base64-encoded format. */
|
|
169
|
+
raw: string;
|
|
170
|
+
};
|
|
171
|
+
/** The name identifier format that will be requested from the identity provider. */
|
|
172
|
+
nameIdFormat?: "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress" | "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" | "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified";
|
|
173
|
+
/** The sign on URL for the SAML IdP. Required if metadata is not provided. */
|
|
174
|
+
signOnUrl?: string;
|
|
175
|
+
};
|
|
176
|
+
/** Direct the user on logout to a specific URI. */
|
|
177
|
+
postLogoutRedirectUri?: string;
|
|
178
|
+
/** The protocol to be used for communicating with the identity provider. */
|
|
179
|
+
protocol: "SAML";
|
|
180
|
+
/** The identity provider to be used. */
|
|
181
|
+
provider: "okta" | "generic" | "adfs" | "azureAD";
|
|
182
|
+
/** If set to `true`, skips IdP verification process and assumes the IdP is verified. */
|
|
183
|
+
skipVerify?: boolean;
|
|
184
|
+
/** The tenant identifiers that map to the given IdP. */
|
|
185
|
+
tenantIds?: string[];
|
|
186
|
+
};
|
|
115
187
|
/**
|
|
116
188
|
* An error object.
|
|
117
189
|
*/
|
|
@@ -140,7 +212,7 @@ type Error = {
|
|
|
140
212
|
type Errors = {
|
|
141
213
|
errors?: Error[];
|
|
142
214
|
};
|
|
143
|
-
type IDP = IDPOIDC | IDPJWTAuth;
|
|
215
|
+
type IDP = IDPOIDC | IDPSAML | IDPJWTAuth;
|
|
144
216
|
type IDPArray = {
|
|
145
217
|
/** An array of IdPs. */
|
|
146
218
|
data?: IDP[];
|
|
@@ -172,13 +244,13 @@ type IDPMeta = {
|
|
|
172
244
|
* An OIDC-compliant identity provider.
|
|
173
245
|
*/
|
|
174
246
|
type IDPOIDC = BaseIDP & {
|
|
175
|
-
options?:
|
|
176
|
-
pendingOptions?:
|
|
247
|
+
options?: IDPOIDCOptions;
|
|
248
|
+
pendingOptions?: IDPOIDCOptions;
|
|
177
249
|
pendingResult?: PendingResult;
|
|
178
250
|
/** The state of pendingOptions. This represents the latest IdP test result. */
|
|
179
251
|
pendingState?: "verified" | "pending" | "error";
|
|
180
252
|
};
|
|
181
|
-
type
|
|
253
|
+
type IDPOIDCOptions = {
|
|
182
254
|
/** If true, the `offline_access` scope will not be requested from the IdP, where applicable. */
|
|
183
255
|
blockOfflineAccessScope?: boolean;
|
|
184
256
|
/** Mappings from claim name to an array of JSON pointers that point to locations in the claims from the IdP to retrieve the value from. */
|
|
@@ -200,16 +272,44 @@ type IDPOptions = {
|
|
|
200
272
|
/** Scope that will be sent along with token requests to the IdP. */
|
|
201
273
|
scope?: string;
|
|
202
274
|
};
|
|
203
|
-
type IDPPatchSchema = PatchOIDCPayload[] | PatchJWTAuthPayload[];
|
|
204
|
-
type IDPPostSchema = CreateOIDCPayload | CreateJWTAuthPayload;
|
|
275
|
+
type IDPPatchSchema = PatchOIDCPayload[] | PatchSAMLPayload[] | PatchJWTAuthPayload[];
|
|
276
|
+
type IDPPostSchema = CreateOIDCPayload | CreateJWTAuthPayload | CreateSAMLPayload;
|
|
205
277
|
/**
|
|
206
|
-
* The protocol to be used for communicating with the identity provider. Valid values are `OIDC`, `jwtAuth`, and `qsefw-local-bearer-token`.
|
|
278
|
+
* The protocol to be used for communicating with the identity provider. Valid values are `OIDC`, `SAML`, `jwtAuth`, and `qsefw-local-bearer-token`.
|
|
207
279
|
*/
|
|
208
|
-
type IDPProtocol = "OIDC" | "jwtAuth" | "qsefw-local-bearer-token";
|
|
280
|
+
type IDPProtocol = "OIDC" | "SAML" | "jwtAuth" | "qsefw-local-bearer-token";
|
|
209
281
|
/**
|
|
210
282
|
* The identity provider to be used. If protocol is `OIDC`, the valid values are `auth0`, `okta`, `generic`, `salesforce`, `keycloak`, `adfs`, and `azureAD`. If protocol is `jwtAuth`, the valid value is `external`.
|
|
211
283
|
*/
|
|
212
284
|
type IDPProvider = "auth0" | "okta" | "qlik" | "generic" | "salesforce" | "keycloak" | "adfs" | "external" | "azureAD";
|
|
285
|
+
/**
|
|
286
|
+
* A SAML-compliant identity provider.
|
|
287
|
+
*/
|
|
288
|
+
type IDPSAML = BaseIDP & {
|
|
289
|
+
options?: IDPSAMLOptions;
|
|
290
|
+
pendingOptions?: IDPSAMLOptions;
|
|
291
|
+
pendingResult?: PendingResult;
|
|
292
|
+
/** The state of pendingOptions. This represents the latest IdP test result. */
|
|
293
|
+
pendingState?: "verified" | "pending" | "error";
|
|
294
|
+
};
|
|
295
|
+
type IDPSAMLOptions = {
|
|
296
|
+
/** Toggle to allow IdP initated login by the SAML IdP. */
|
|
297
|
+
allowIdpInitiatedLogin?: boolean;
|
|
298
|
+
/** The certificates used for validating signed responses. */
|
|
299
|
+
certificates?: CertificateInfo[];
|
|
300
|
+
/** Mappings from claim name to an array of SAML attribute names that point to locations in the claims from the IdP to retrieve the value from. */
|
|
301
|
+
claimsMapping?: ClaimsMappingSAML;
|
|
302
|
+
/** The entity URL for the SAML IdP. */
|
|
303
|
+
entityId?: string;
|
|
304
|
+
/** The name identifier format that will be requested from the identity provider. */
|
|
305
|
+
nameIdFormat?: "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress" | "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent" | "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified";
|
|
306
|
+
/** The sign on URL for the SAML IdP. */
|
|
307
|
+
signOnUrl?: string;
|
|
308
|
+
/** The reference ID of the chosen signing key pair. */
|
|
309
|
+
signingKeySelectedRefId?: string;
|
|
310
|
+
/** Set of certificates used to sign SAMLRequest payloads. Not present in `pendingOptions`. */
|
|
311
|
+
signingKeys?: SigningKey[];
|
|
312
|
+
};
|
|
213
313
|
type IDPsStatus = {
|
|
214
314
|
/** The number of active interactive IdPs. */
|
|
215
315
|
active_interactive_idps_count?: number;
|
|
@@ -281,6 +381,17 @@ type PatchOIDCPayload = {
|
|
|
281
381
|
/** The "value" data type is dependent on the path value being used. */
|
|
282
382
|
value?: unknown;
|
|
283
383
|
};
|
|
384
|
+
/**
|
|
385
|
+
* A patch request for an identity provider using the `SAML` protocol. Supports a custom operation value called `promote-options` that allows the test configuration (`pendingOptions`) to be promoted to the live configuration (`options`) used for login.'
|
|
386
|
+
*/
|
|
387
|
+
type PatchSAMLPayload = {
|
|
388
|
+
/** The "operation" to be performed on a given IdP. */
|
|
389
|
+
op: "replace" | "promote-options";
|
|
390
|
+
/** The "path" to the part of the IdP document. */
|
|
391
|
+
path?: "/active" | "/description" | "/pendingOptions" | "/pendingOptions/nameIdFormat" | "/pendingOptions/allowIdpInitiatedLogin" | "/pendingOptions/entityId" | "/pendingOptions/signOnUrl" | "/pendingOptions/metadata" | "/pendingOptions/certificates" | "/pendingOptions/claimsMapping" | "/postLogoutRedirectUri" | "/clockToleranceSec";
|
|
392
|
+
/** The "value" data type is dependent on the path value being used. */
|
|
393
|
+
value?: unknown;
|
|
394
|
+
};
|
|
284
395
|
type PendingResult = {
|
|
285
396
|
/** A unique readable error message based on the error that has occurred. */
|
|
286
397
|
error?: string;
|
|
@@ -294,6 +405,8 @@ type PendingResult = {
|
|
|
294
405
|
/** An optional URI that includes additional information about the given error. */
|
|
295
406
|
errorURI?: string;
|
|
296
407
|
};
|
|
408
|
+
/** The protocol used to communicate with the IdP during the test flow. */
|
|
409
|
+
protocol?: "OIDC" | "SAML";
|
|
297
410
|
/** The resultant claims based on the claims received from the external IdP. */
|
|
298
411
|
resultantClaims?: unknown;
|
|
299
412
|
/** The timestamp for when the test was started for an IdP configuration. This field is only available during lifespan of the test. */
|
|
@@ -301,6 +414,12 @@ type PendingResult = {
|
|
|
301
414
|
/** The status of the IdP configuration being tested. */
|
|
302
415
|
status: "success" | "pending" | "error" | "claimsError" | "callbackError" | "tokenError" | "protocolError" | "networkError" | "configChangedDuringTestError";
|
|
303
416
|
};
|
|
417
|
+
type SigningKey = {
|
|
418
|
+
/** The certificate to be uploaded to the identity provider for verifying SAML requests. */
|
|
419
|
+
certificate?: string;
|
|
420
|
+
/** The reference ID for choosing this key pair. */
|
|
421
|
+
refId?: string;
|
|
422
|
+
};
|
|
304
423
|
/**
|
|
305
424
|
* Mappings from claim name to an array of JSON pointers that point to locations in the claims from the IdP to retrieve the value from.
|
|
306
425
|
*/
|
|
@@ -333,6 +452,21 @@ type ClaimsMappingNonInteractive = {
|
|
|
333
452
|
/** A list of JSON pointers used to map the user's subject. */
|
|
334
453
|
sub?: string[];
|
|
335
454
|
};
|
|
455
|
+
/**
|
|
456
|
+
* Mappings from claim name to an array of SAML attribute names that point to locations in the claims from the IdP to retrieve the value from.
|
|
457
|
+
*/
|
|
458
|
+
type ClaimsMappingSAML = {
|
|
459
|
+
/** A list of SAML attributes used to map the user's email. */
|
|
460
|
+
email: string[];
|
|
461
|
+
/** A list of SAML attributes used to map the user's groups. */
|
|
462
|
+
groups: string[];
|
|
463
|
+
/** A list of SAML attributes used to map the user's name. */
|
|
464
|
+
name: string[];
|
|
465
|
+
/** A list of SAML attributes used to map the user's picture. */
|
|
466
|
+
picture: string[];
|
|
467
|
+
/** A list of SAML attributes used to map the user's subject. */
|
|
468
|
+
sub: string[];
|
|
469
|
+
};
|
|
336
470
|
/**
|
|
337
471
|
* This endpoint retrieves one or more identity providers from the service. The tenantID in the JWT will be used to fetch the identity provider.
|
|
338
472
|
*
|
|
@@ -547,4 +681,4 @@ interface IdentityProvidersAPI {
|
|
|
547
681
|
*/
|
|
548
682
|
declare const identityProvidersExport: IdentityProvidersAPI;
|
|
549
683
|
|
|
550
|
-
export { type BaseIDP, type ClaimsMappingInteractive, type ClaimsMappingNonInteractive, type CreateIdpHttpError, type CreateIdpHttpResponse, type CreateJWTAuthPayload, type CreateOIDCPayload, type DeleteIdpHttpError, type DeleteIdpHttpResponse, type Error, type Errors, type GetIdpHttpError, type GetIdpHttpResponse, type GetIdpStatusesHttpError, type GetIdpStatusesHttpResponse, type GetIdpWellKnownMetaDataHttpError, type GetIdpWellKnownMetaDataHttpResponse, type GetIdpsHttpError, type GetIdpsHttpResponse, type GetMyIdpMetaHttpError, type GetMyIdpMetaHttpResponse, type IDP, type IDPArray, type IDPJWTAuth, type IDPMeta, type IDPOIDC, type
|
|
684
|
+
export { type BaseIDP, type CertificateInfo, type ClaimsMappingInteractive, type ClaimsMappingNonInteractive, type ClaimsMappingSAML, type CreateIdpHttpError, type CreateIdpHttpResponse, type CreateJWTAuthPayload, type CreateOIDCPayload, type CreateSAMLPayload, type DeleteIdpHttpError, type DeleteIdpHttpResponse, type Error, type Errors, type GetIdpHttpError, type GetIdpHttpResponse, type GetIdpStatusesHttpError, type GetIdpStatusesHttpResponse, type GetIdpWellKnownMetaDataHttpError, type GetIdpWellKnownMetaDataHttpResponse, type GetIdpsHttpError, type GetIdpsHttpResponse, type GetMyIdpMetaHttpError, type GetMyIdpMetaHttpResponse, type IDP, type IDPArray, type IDPJWTAuth, type IDPMeta, type IDPOIDC, type IDPOIDCOptions, type IDPPatchSchema, type IDPPostSchema, type IDPProtocol, type IDPProvider, type IDPSAML, type IDPSAMLOptions, type IDPsStatus, type IdentityProvidersAPI, type Links, type OpenIDConfiguration, type PatchIdpHttpError, type PatchIdpHttpResponse, type PatchJWTAuthPayload, type PatchOIDCPayload, type PatchSAMLPayload, type PendingResult, type SigningKey, clearCache, createIdp, identityProvidersExport as default, deleteIdp, getIdp, getIdpStatuses, getIdpWellKnownMetaData, getIdps, getMyIdpMeta, patchIdp };
|
package/identity-providers.js
CHANGED
package/index.js
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import {
|
|
2
2
|
auth_default
|
|
3
|
-
} from "./chunks/
|
|
3
|
+
} from "./chunks/XZQNE4HH.js";
|
|
4
4
|
import {
|
|
5
5
|
qix_default
|
|
6
|
-
} from "./chunks/
|
|
6
|
+
} from "./chunks/RHF624NQ.js";
|
|
7
7
|
import {
|
|
8
8
|
clearApiCache,
|
|
9
9
|
invokeFetch
|
|
10
|
-
} from "./chunks/
|
|
11
|
-
import "./chunks/
|
|
10
|
+
} from "./chunks/FFGE2RP7.js";
|
|
11
|
+
import "./chunks/TT66UJZY.js";
|
|
12
12
|
import "./chunks/4HB3TAEO.js";
|
|
13
13
|
|
|
14
14
|
// src/public/public-runtime-api-generator/public-runtime-api-generator.ts
|
package/items.js
CHANGED
package/licenses.js
CHANGED
package/package.json
CHANGED
package/qix.d.ts
CHANGED
package/qix.js
CHANGED
package/quotas.js
CHANGED
package/reload-tasks.js
CHANGED
package/reloads.js
CHANGED
package/roles.js
CHANGED
package/spaces.js
CHANGED
package/temp-contents.js
CHANGED
package/tenants.js
CHANGED
package/themes.js
CHANGED
package/transports.js
CHANGED
package/users.js
CHANGED
package/web-integrations.js
CHANGED
package/web-notifications.js
CHANGED
package/webhooks.js
CHANGED