@qlik/api 0.1.0 → 0.2.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.
Files changed (78) hide show
  1. package/api-keys.d.ts +2 -2
  2. package/api-keys.js +2 -2
  3. package/apps.d.ts +13 -3
  4. package/apps.js +2 -2
  5. package/audits.d.ts +2 -2
  6. package/audits.js +2 -2
  7. package/{auth-types-nnUcWhuU.d.ts → auth-types-1P4wuncR.d.ts} +5 -1
  8. package/auth.d.ts +7 -3
  9. package/auth.js +4 -2
  10. package/automations.d.ts +2 -2
  11. package/automations.js +2 -2
  12. package/brands.d.ts +2 -2
  13. package/brands.js +2 -2
  14. package/chunks/{VK2CODYY.js → AEXRZSVI.js} +4 -4
  15. package/chunks/{TFSRDRRS.js → F36DZZYS.js} +7 -2
  16. package/chunks/{L2BJNKLV.js → H46323PG.js} +3 -1
  17. package/chunks/{SIU6HO6B.js → LJNLYKW3.js} +160 -29
  18. package/chunks/{LHCJKIEO.js → QOUQIYWW.js} +1 -1
  19. package/chunks/{4V5AAWUI.js → TDKU6D4Z.js} +3 -3
  20. package/chunks/{RNLZBOJU.js → VVREBIN2.js} +2 -2
  21. package/chunks/{D62LI5YU.js → ZT55IZXB.js} +1 -1
  22. package/chunks/{XOVMZWDC.js → ZVNQOWQU.js} +1 -1
  23. package/collections.d.ts +2 -2
  24. package/collections.js +2 -2
  25. package/csp-origins.d.ts +2 -2
  26. package/csp-origins.js +2 -2
  27. package/data-assets.d.ts +2 -2
  28. package/data-assets.js +2 -2
  29. package/data-connections.d.ts +2 -2
  30. package/data-connections.js +2 -2
  31. package/data-credentials.d.ts +2 -2
  32. package/data-credentials.js +2 -2
  33. package/data-files.d.ts +2 -2
  34. package/data-files.js +2 -2
  35. package/extensions.d.ts +2 -2
  36. package/extensions.js +2 -2
  37. package/{global.types-TzVhFPid.d.ts → global.types-B14bb3X9.d.ts} +23 -1
  38. package/glossaries.d.ts +2 -2
  39. package/glossaries.js +2 -2
  40. package/groups.d.ts +2 -2
  41. package/groups.js +2 -2
  42. package/identity-providers.d.ts +146 -12
  43. package/identity-providers.js +2 -2
  44. package/index.d.ts +4 -3
  45. package/index.js +4 -4
  46. package/items.d.ts +2 -2
  47. package/items.js +2 -2
  48. package/licenses.d.ts +2 -2
  49. package/licenses.js +2 -2
  50. package/package.json +1 -1
  51. package/qix.d.ts +3 -3
  52. package/qix.js +2 -2
  53. package/quotas.d.ts +2 -2
  54. package/quotas.js +2 -2
  55. package/reload-tasks.d.ts +2 -2
  56. package/reload-tasks.js +2 -2
  57. package/reloads.d.ts +2 -2
  58. package/reloads.js +2 -2
  59. package/roles.d.ts +2 -2
  60. package/roles.js +2 -2
  61. package/spaces.d.ts +2 -2
  62. package/spaces.js +2 -2
  63. package/temp-contents.d.ts +2 -2
  64. package/temp-contents.js +2 -2
  65. package/tenants.d.ts +2 -2
  66. package/tenants.js +2 -2
  67. package/themes.d.ts +2 -2
  68. package/themes.js +2 -2
  69. package/transports.d.ts +2 -2
  70. package/transports.js +2 -2
  71. package/users.d.ts +2 -2
  72. package/users.js +2 -2
  73. package/web-integrations.d.ts +2 -2
  74. package/web-integrations.js +2 -2
  75. package/web-notifications.d.ts +2 -2
  76. package/web-notifications.js +2 -2
  77. package/webhooks.d.ts +2 -2
  78. package/webhooks.js +2 -2
@@ -4,7 +4,7 @@ import {
4
4
  invokeFetch,
5
5
  isWindows,
6
6
  toValidWebsocketLocationUrl
7
- } from "./SIU6HO6B.js";
7
+ } from "./LJNLYKW3.js";
8
8
  import "./4HB3TAEO.js";
9
9
 
10
10
  // src/qix/session/shared-sessions.ts
@@ -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("./VK2CODYY.js");
86
+ const { createEnigmaSession } = await import("./AEXRZSVI.js");
87
87
  const session = await createEnigmaSession(props);
88
88
  setupSessionListeners(session, props);
89
89
  let global;
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  getQixRuntimeModule
3
- } from "./4V5AAWUI.js";
3
+ } from "./TDKU6D4Z.js";
4
4
 
5
5
  // src/public/qix.ts
6
6
  function openAppSession(appSessionProps) {
@@ -5,7 +5,7 @@ import {
5
5
  invokeFetch,
6
6
  invoke_fetch_default,
7
7
  parseFetchResponse
8
- } from "./SIU6HO6B.js";
8
+ } from "./LJNLYKW3.js";
9
9
  import "./4HB3TAEO.js";
10
10
  export {
11
11
  EncodingError,
package/collections.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
- import './auth-types-nnUcWhuU.js';
1
+ import { A as ApiCallOptions } from './global.types-B14bb3X9.js';
2
+ import './auth-types-1P4wuncR.js';
3
3
 
4
4
  type CollectionByIdPatch = {
5
5
  /** The operation to be performed. */
package/collections.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/LHCJKIEO.js";
5
- import "./chunks/4V5AAWUI.js";
4
+ } from "./chunks/QOUQIYWW.js";
5
+ import "./chunks/TDKU6D4Z.js";
6
6
  import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/collections.ts
package/csp-origins.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
- import './auth-types-nnUcWhuU.js';
1
+ import { A as ApiCallOptions } from './global.types-B14bb3X9.js';
2
+ import './auth-types-1P4wuncR.js';
3
3
 
4
4
  type CSPEntry = {
5
5
  /** The CSP entry's unique identifier. */
package/csp-origins.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/LHCJKIEO.js";
5
- import "./chunks/4V5AAWUI.js";
4
+ } from "./chunks/QOUQIYWW.js";
5
+ import "./chunks/TDKU6D4Z.js";
6
6
  import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/csp-origins.ts
package/data-assets.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
- import './auth-types-nnUcWhuU.js';
1
+ import { A as ApiCallOptions } from './global.types-B14bb3X9.js';
2
+ import './auth-types-1P4wuncR.js';
3
3
 
4
4
  type BatchIdDto = {
5
5
  ids?: string[];
package/data-assets.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/LHCJKIEO.js";
5
- import "./chunks/4V5AAWUI.js";
4
+ } from "./chunks/QOUQIYWW.js";
5
+ import "./chunks/TDKU6D4Z.js";
6
6
  import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/data-assets.ts
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
- import './auth-types-nnUcWhuU.js';
1
+ import { A as ApiCallOptions } from './global.types-B14bb3X9.js';
2
+ import './auth-types-1P4wuncR.js';
3
3
 
4
4
  type ActionDeleteRequest = {
5
5
  connections: {
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/LHCJKIEO.js";
5
- import "./chunks/4V5AAWUI.js";
4
+ } from "./chunks/QOUQIYWW.js";
5
+ import "./chunks/TDKU6D4Z.js";
6
6
  import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/data-connections.ts
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
- import './auth-types-nnUcWhuU.js';
1
+ import { A as ApiCallOptions } from './global.types-B14bb3X9.js';
2
+ import './auth-types-1P4wuncR.js';
3
3
 
4
4
  type Credential = {
5
5
  /** ID datasource that the credential is created for */
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/LHCJKIEO.js";
5
- import "./chunks/4V5AAWUI.js";
4
+ } from "./chunks/QOUQIYWW.js";
5
+ import "./chunks/TDKU6D4Z.js";
6
6
  import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/data-credentials.ts
package/data-files.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
- import './auth-types-nnUcWhuU.js';
1
+ import { A as ApiCallOptions } from './global.types-B14bb3X9.js';
2
+ import './auth-types-1P4wuncR.js';
3
3
 
4
4
  type BatchChangeSpaceItem = {
5
5
  /** The ID of the data file whose space will be changed. */
package/data-files.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/LHCJKIEO.js";
5
- import "./chunks/4V5AAWUI.js";
4
+ } from "./chunks/QOUQIYWW.js";
5
+ import "./chunks/TDKU6D4Z.js";
6
6
  import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/data-files.ts
package/extensions.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
- import './auth-types-nnUcWhuU.js';
1
+ import { A as ApiCallOptions } from './global.types-B14bb3X9.js';
2
+ import './auth-types-1P4wuncR.js';
3
3
 
4
4
  /**
5
5
  * Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
package/extensions.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/LHCJKIEO.js";
5
- import "./chunks/4V5AAWUI.js";
4
+ } from "./chunks/QOUQIYWW.js";
5
+ import "./chunks/TDKU6D4Z.js";
6
6
  import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/extensions.ts
@@ -1,4 +1,4 @@
1
- import { H as HostConfig } from './auth-types-nnUcWhuU.js';
1
+ import { H as HostConfig } from './auth-types-1P4wuncR.js';
2
2
 
3
3
  /** An entry in the cache for one specific cacheKey */
4
4
  type CacheEntry = {
@@ -71,6 +71,27 @@ type Oauth2AuthConfig = {
71
71
  accessTokenStorage?: "session" | "local";
72
72
  /** A string with comma separated values of oauth2 scopes https://oauth.net/2/scope defaults to "user_default" */
73
73
  scope?: string;
74
+ /**
75
+ * A custom function that can be used on the client side to fetch an oauth access token from a custom backend.
76
+ * Typically used in oauth impersonation.
77
+ */
78
+ getAccessToken?: string | (() => Promise<string>);
79
+ /**
80
+ * If set to true no caching or storing of the access token is done.
81
+ * This is typically used on the serverside with impersonation so that a client always gets a fresh token.
82
+ * Caching is in that case handled on the client side.
83
+ */
84
+ noCache?: boolean;
85
+ /**
86
+ * Can be used on the serverside to impersonate a specific user when authenticating using a client secret.
87
+ * Typically used together with the `noCache` since caching is done on the browser side.
88
+ */
89
+ subject?: string;
90
+ /**
91
+ * Can be used on the serverside to impersonate a specific user when authenticating using a client secret.
92
+ * Typically used together with the `noCache` since caching is done on the browser side.
93
+ */
94
+ userId?: string;
74
95
  };
75
96
  declare global {
76
97
  /**
@@ -109,6 +130,7 @@ declare global {
109
130
  */
110
131
  var QlikMain: {
111
132
  resourceNeedsCredentials: (resourcesUrl: string) => boolean;
133
+ applyFeatureOverrides: (featureFlags: Record<string, boolean>) => Promise<void>;
112
134
  } | undefined;
113
135
  }
114
136
 
package/glossaries.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
- import './auth-types-nnUcWhuU.js';
1
+ import { A as ApiCallOptions } from './global.types-B14bb3X9.js';
2
+ import './auth-types-1P4wuncR.js';
3
3
 
4
4
  /**
5
5
  * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
package/glossaries.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/LHCJKIEO.js";
5
- import "./chunks/4V5AAWUI.js";
4
+ } from "./chunks/QOUQIYWW.js";
5
+ import "./chunks/TDKU6D4Z.js";
6
6
  import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/glossaries.ts
package/groups.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
- import './auth-types-nnUcWhuU.js';
1
+ import { A as ApiCallOptions } from './global.types-B14bb3X9.js';
2
+ import './auth-types-1P4wuncR.js';
3
3
 
4
4
  /**
5
5
  * An array of role references.
package/groups.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/LHCJKIEO.js";
5
- import "./chunks/4V5AAWUI.js";
4
+ } from "./chunks/QOUQIYWW.js";
5
+ import "./chunks/TDKU6D4Z.js";
6
6
  import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/groups.ts
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
- import './auth-types-nnUcWhuU.js';
1
+ import { A as ApiCallOptions } from './global.types-B14bb3X9.js';
2
+ import './auth-types-1P4wuncR.js';
3
3
 
4
4
  type BaseIDP = {
5
5
  /** Indicates whether the IdP is available for use. */
@@ -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?: IDPOptions;
176
- pendingOptions?: IDPOptions;
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 IDPOptions = {
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 IDPOptions, type IDPPatchSchema, type IDPPostSchema, type IDPProtocol, type IDPProvider, type IDPsStatus, type IdentityProvidersAPI, type Links, type OpenIDConfiguration, type PatchIdpHttpError, type PatchIdpHttpResponse, type PatchJWTAuthPayload, type PatchOIDCPayload, type PendingResult, clearCache, createIdp, identityProvidersExport as default, deleteIdp, getIdp, getIdpStatuses, getIdpWellKnownMetaData, getIdps, getMyIdpMeta, patchIdp };
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 };
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/LHCJKIEO.js";
5
- import "./chunks/4V5AAWUI.js";
4
+ } from "./chunks/QOUQIYWW.js";
5
+ import "./chunks/TDKU6D4Z.js";
6
6
  import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/identity-providers.ts
package/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { openAppSession } from './qix.js';
2
- import { registerAuthModule, setDefaultHostConfig } from './auth.js';
2
+ import { registerAuthModule, setDefaultHostConfig, getAccessToken } from './auth.js';
3
3
  import { ApiKeysAPI } from './api-keys.js';
4
4
  import { AppsAPI } from './apps.js';
5
5
  import { AuditsAPI } from './audits.js';
@@ -30,8 +30,8 @@ import { UsersAPI } from './users.js';
30
30
  import { WebIntegrationsAPI } from './web-integrations.js';
31
31
  import { WebNotificationsAPI } from './web-notifications.js';
32
32
  import { WebhooksAPI } from './webhooks.js';
33
- import './global.types-TzVhFPid.js';
34
- import './auth-types-nnUcWhuU.js';
33
+ import './global.types-B14bb3X9.js';
34
+ import './auth-types-1P4wuncR.js';
35
35
 
36
36
  declare const apiKeys: ApiKeysAPI;
37
37
  declare const apps: AppsAPI;
@@ -39,6 +39,7 @@ declare const audits: AuditsAPI;
39
39
  declare const auth: {
40
40
  registerAuthModule: typeof registerAuthModule;
41
41
  setDefaultHostConfig: typeof setDefaultHostConfig;
42
+ getAccessToken: typeof getAccessToken;
42
43
  };
43
44
  declare const automations: AutomationsAPI;
44
45
  declare const brands: BrandsAPI;
package/index.js CHANGED
@@ -1,14 +1,14 @@
1
1
  import {
2
2
  auth_default
3
- } from "./chunks/TFSRDRRS.js";
3
+ } from "./chunks/F36DZZYS.js";
4
4
  import {
5
5
  qix_default
6
- } from "./chunks/D62LI5YU.js";
6
+ } from "./chunks/ZT55IZXB.js";
7
7
  import {
8
8
  clearApiCache,
9
9
  invokeFetch
10
- } from "./chunks/LHCJKIEO.js";
11
- import "./chunks/4V5AAWUI.js";
10
+ } from "./chunks/QOUQIYWW.js";
11
+ import "./chunks/TDKU6D4Z.js";
12
12
  import "./chunks/4HB3TAEO.js";
13
13
 
14
14
  // src/public/public-runtime-api-generator/public-runtime-api-generator.ts
package/items.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
- import './auth-types-nnUcWhuU.js';
1
+ import { A as ApiCallOptions } from './global.types-B14bb3X9.js';
2
+ import './auth-types-1P4wuncR.js';
3
3
 
4
4
  type CollectionTypes = "private" | "public" | "publicgoverned";
5
5
  type ErrorResponseBody = {
package/items.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/LHCJKIEO.js";
5
- import "./chunks/4V5AAWUI.js";
4
+ } from "./chunks/QOUQIYWW.js";
5
+ import "./chunks/TDKU6D4Z.js";
6
6
  import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/items.ts
package/licenses.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
2
- import './auth-types-nnUcWhuU.js';
1
+ import { A as ApiCallOptions } from './global.types-B14bb3X9.js';
2
+ import './auth-types-1P4wuncR.js';
3
3
 
4
4
  type AssignmentsActionsAddRequest = {
5
5
  add: {
package/licenses.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/LHCJKIEO.js";
5
- import "./chunks/4V5AAWUI.js";
4
+ } from "./chunks/QOUQIYWW.js";
5
+ import "./chunks/TDKU6D4Z.js";
6
6
  import "./chunks/4HB3TAEO.js";
7
7
 
8
8
  // src/public/rest/licenses.ts
package/package.json CHANGED
@@ -57,5 +57,5 @@
57
57
  "./qix": "./qix.js",
58
58
  "./auth": "./auth.js"
59
59
  },
60
- "version": "0.1.0"
60
+ "version": "0.2.0"
61
61
  }
package/qix.d.ts CHANGED
@@ -1,7 +1,7 @@
1
- import './global.types-TzVhFPid.js';
2
- import { H as HostConfig } from './auth-types-nnUcWhuU.js';
1
+ import './global.types-B14bb3X9.js';
2
+ import { H as HostConfig } from './auth-types-1P4wuncR.js';
3
3
 
4
- declare const QIX_SCHEMA_VERSION = "12.1991.0";
4
+ declare const QIX_SCHEMA_VERSION = "12.2005.0";
5
5
  type AlfaNumString = {
6
6
  /**
7
7
  * Calculated value.