@qlik/api 1.22.0 → 1.24.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 (84) hide show
  1. package/api-keys.d.ts +6 -2
  2. package/api-keys.js +2 -2
  3. package/apps.d.ts +10 -2
  4. package/apps.js +2 -2
  5. package/audits.d.ts +4 -16
  6. package/audits.js +2 -2
  7. package/auth.js +2 -2
  8. package/automations.d.ts +2 -59
  9. package/automations.js +3 -19
  10. package/brands.d.ts +23 -23
  11. package/brands.js +2 -2
  12. package/chunks/{GZRY5VHW.js → 3DYV7KOJ.js} +2 -2
  13. package/chunks/{SEBN4KFZ.js → 6DEESTGF.js} +2 -2
  14. package/chunks/{PR52AAWU.js → 6QRR5VUM.js} +36 -32
  15. package/chunks/7BDAXGID.js +116 -0
  16. package/chunks/{TGDZVKG2.js → BL5PJM4B.js} +1 -1
  17. package/chunks/{SNQHDUYY.js → CZC7KEJN.js} +3 -3
  18. package/chunks/{OEVNZ5IQ.js → I5UOE4ZZ.js} +90 -85
  19. package/chunks/{KBR7JBWC.js → N3ZFICDU.js} +38 -24
  20. package/chunks/{VHPC6L7L.js → OIQ5ELGS.js} +1 -1
  21. package/chunks/{TUPLQG25.js → UA6BE3VB.js} +2 -2
  22. package/chunks/{EUWNVVK5.js → VX3MQBE7.js} +1 -1
  23. package/collections.d.ts +1 -1
  24. package/collections.js +2 -2
  25. package/csp-origins.d.ts +1 -1
  26. package/csp-origins.js +2 -2
  27. package/data-assets.d.ts +1 -1
  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 +64 -2
  32. package/data-credentials.js +11 -2
  33. package/data-files.d.ts +1 -1
  34. package/data-files.js +2 -2
  35. package/docs/rest.md +47 -0
  36. package/extensions.d.ts +1 -1
  37. package/extensions.js +2 -2
  38. package/glossaries.d.ts +3 -4
  39. package/glossaries.js +2 -2
  40. package/groups.d.ts +1 -1
  41. package/groups.js +2 -2
  42. package/identity-providers.d.ts +17 -17
  43. package/identity-providers.js +2 -2
  44. package/index.d.ts +11 -4
  45. package/index.js +90 -79
  46. package/interceptors.d.ts +51 -0
  47. package/interceptors.js +17 -0
  48. package/{global.types-qsBNouXJ.d.ts → invoke-fetch-types-BLrpeZOL.d.ts} +81 -48
  49. package/items.d.ts +1 -1
  50. package/items.js +2 -2
  51. package/licenses.d.ts +3 -1
  52. package/licenses.js +2 -2
  53. package/package.json +2 -2
  54. package/qix.d.ts +6 -3
  55. package/qix.js +2 -2
  56. package/quotas.d.ts +1 -1
  57. package/quotas.js +2 -2
  58. package/reload-tasks.d.ts +1 -1
  59. package/reload-tasks.js +2 -2
  60. package/reloads.d.ts +1 -1
  61. package/reloads.js +2 -2
  62. package/reports.d.ts +42 -4
  63. package/reports.js +2 -2
  64. package/roles.d.ts +98 -4
  65. package/roles.js +28 -4
  66. package/spaces.d.ts +3 -1
  67. package/spaces.js +2 -2
  68. package/temp-contents.d.ts +5 -5
  69. package/temp-contents.js +2 -2
  70. package/tenants.d.ts +25 -16
  71. package/tenants.js +2 -2
  72. package/themes.d.ts +1 -1
  73. package/themes.js +2 -2
  74. package/transports.d.ts +1 -1
  75. package/transports.js +2 -2
  76. package/users.d.ts +4 -39
  77. package/users.js +2 -9
  78. package/web-integrations.d.ts +1 -1
  79. package/web-integrations.js +2 -2
  80. package/web-notifications.d.ts +1 -1
  81. package/web-notifications.js +2 -2
  82. package/webhooks.d.ts +1 -1
  83. package/webhooks.js +2 -2
  84. package/chunks/7RHSSS4W.js +0 -0
package/csp-origins.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/csp-origins.ts
package/data-assets.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type BatchIdDto = {
package/data-assets.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/data-assets.ts
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type ActionDeleteRequest = {
@@ -300,7 +300,7 @@ declare const getDataConnections: (query: {
300
300
  dataName?: string;
301
301
  /** Returns extended list of properties (e.g. encrypted credential string) when set to true. */
302
302
  extended?: boolean;
303
- /** Filtering resources by properties (filterable properties only) using SCIM filter string. Note the filter string only applies to connections managed by data-connections service, i.e. filtering doesn't apply to DataFile connections. */
303
+ /** Filtering resources by properties (filterable properties only) using SCIM filter string. Note the filter string only applies to connections managed by data-connections service, i.e. filtering doesn't apply to DataFile connections. When filtering on datetime property (e.g. created, updated), datetime should be in RFC3339 format. */
304
304
  filter?: string;
305
305
  /** Base Qri (encrypted) will be returned when the query is set to true, default is false */
306
306
  includeQris?: boolean;
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/data-connections.ts
@@ -1,7 +1,22 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
+ type ActionFilterOrphanRequest = {
5
+ /** Filtering on datasource ID of credentials */
6
+ datasourceID?: string;
7
+ /** Filtering on separate status of credentials: * 0 - embedded credential * 1 - separated credential */
8
+ qSeparated?: 0 | 1;
9
+ /** Filtering on type of credentials */
10
+ qType?: string;
11
+ };
12
+ type ActionFilterOrphanResponse = {
13
+ /** Number of orphan credentials found */
14
+ count: number;
15
+ data: OrphanCredentialResItem[];
16
+ };
4
17
  type Credential = {
18
+ /** Datetime when the credential was created */
19
+ created?: string;
5
20
  /** ID datasource that the credential is created for */
6
21
  datasourceID?: string;
7
22
  links?: Link;
@@ -15,6 +30,8 @@ type Credential = {
15
30
  qReferenceKey?: string;
16
31
  /** Type of credential */
17
32
  qType: string;
33
+ /** Datetime when the credential was last updated */
34
+ updated?: string;
18
35
  };
19
36
  /**
20
37
  * Credential
@@ -53,6 +70,27 @@ type Link = {
53
70
  href: string;
54
71
  };
55
72
  };
73
+ /**
74
+ * Orphan credential
75
+ */
76
+ type OrphanCredentialResItem = {
77
+ /** Datetime when the credential was created */
78
+ created: string;
79
+ /** ID datasource that the credential is created for */
80
+ datasourceID?: string;
81
+ /** UUID of the credential */
82
+ qID: string;
83
+ /** Name of the credential */
84
+ qName: string;
85
+ /** Type of credential (i.e. connector provider of the corresponding connection) */
86
+ qType: string;
87
+ /** Tenant ID of the credential's owner */
88
+ tenant?: string;
89
+ /** Datetime when the credential was last updated */
90
+ updated: string;
91
+ /** User ID of the credential's owner */
92
+ user?: string;
93
+ };
56
94
  type PatchRequest = {
57
95
  patchData: {
58
96
  /** Operation type */
@@ -66,6 +104,23 @@ type PatchRequest = {
66
104
  type ResponseErrors = {
67
105
  errors?: Errors;
68
106
  };
107
+ /**
108
+ * Gets list of orphan data credentials (i.e. credentials that are not associated to any data connection) filtering on properties defined in request body
109
+ *
110
+ * @param body an object with the body content
111
+ * @throws FilterOrphanedDataCredentialsHttpError
112
+ */
113
+ declare const filterOrphanedDataCredentials: (body: ActionFilterOrphanRequest, options?: ApiCallOptions) => Promise<FilterOrphanedDataCredentialsHttpResponse>;
114
+ type FilterOrphanedDataCredentialsHttpResponse = {
115
+ data: ActionFilterOrphanResponse;
116
+ headers: Headers;
117
+ status: number;
118
+ };
119
+ type FilterOrphanedDataCredentialsHttpError = {
120
+ data: ResponseErrors;
121
+ headers: Headers;
122
+ status: number;
123
+ };
69
124
  /**
70
125
  * Deletes the specified credential by ID (or by name when type=credentialname is set in query)
71
126
  *
@@ -157,6 +212,13 @@ type UpdateDataCredentialHttpError = {
157
212
  */
158
213
  declare function clearCache(): void;
159
214
  interface DataCredentialsAPI {
215
+ /**
216
+ * Gets list of orphan data credentials (i.e. credentials that are not associated to any data connection) filtering on properties defined in request body
217
+ *
218
+ * @param body an object with the body content
219
+ * @throws FilterOrphanedDataCredentialsHttpError
220
+ */
221
+ filterOrphanedDataCredentials: typeof filterOrphanedDataCredentials;
160
222
  /**
161
223
  * Deletes the specified credential by ID (or by name when type=credentialname is set in query)
162
224
  *
@@ -201,4 +263,4 @@ interface DataCredentialsAPI {
201
263
  */
202
264
  declare const dataCredentialsExport: DataCredentialsAPI;
203
265
 
204
- export { type Credential, type CredentialCreate, type DataCredentialsAPI, type DeleteDataCredentialHttpError, type DeleteDataCredentialHttpResponse, type Error, type Errors, type GetDataCredentialHttpError, type GetDataCredentialHttpResponse, type Link, type PatchDataCredentialHttpError, type PatchDataCredentialHttpResponse, type PatchRequest, type ResponseErrors, type UpdateDataCredentialHttpError, type UpdateDataCredentialHttpResponse, clearCache, dataCredentialsExport as default, deleteDataCredential, getDataCredential, patchDataCredential, updateDataCredential };
266
+ export { type ActionFilterOrphanRequest, type ActionFilterOrphanResponse, type Credential, type CredentialCreate, type DataCredentialsAPI, type DeleteDataCredentialHttpError, type DeleteDataCredentialHttpResponse, type Error, type Errors, type FilterOrphanedDataCredentialsHttpError, type FilterOrphanedDataCredentialsHttpResponse, type GetDataCredentialHttpError, type GetDataCredentialHttpResponse, type Link, type OrphanCredentialResItem, type PatchDataCredentialHttpError, type PatchDataCredentialHttpResponse, type PatchRequest, type ResponseErrors, type UpdateDataCredentialHttpError, type UpdateDataCredentialHttpResponse, clearCache, dataCredentialsExport as default, deleteDataCredential, filterOrphanedDataCredentials, getDataCredential, patchDataCredential, updateDataCredential };
@@ -1,11 +1,18 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/data-credentials.ts
9
+ var filterOrphanedDataCredentials = async (body, options) => invokeFetch("data-credentials", {
10
+ method: "post",
11
+ pathTemplate: "/api/v1/data-credentials/actions/filter-orphan",
12
+ body,
13
+ contentType: "application/json",
14
+ options
15
+ });
9
16
  var deleteDataCredential = async (qID, query, options) => invokeFetch("data-credentials", {
10
17
  method: "delete",
11
18
  pathTemplate: "/api/v1/data-credentials/{qID}",
@@ -42,6 +49,7 @@ function clearCache() {
42
49
  return clearApiCache("data-credentials");
43
50
  }
44
51
  var dataCredentialsExport = {
52
+ filterOrphanedDataCredentials,
45
53
  deleteDataCredential,
46
54
  getDataCredential,
47
55
  patchDataCredential,
@@ -53,6 +61,7 @@ export {
53
61
  clearCache,
54
62
  data_credentials_default as default,
55
63
  deleteDataCredential,
64
+ filterOrphanedDataCredentials,
56
65
  getDataCredential,
57
66
  patchDataCredential,
58
67
  updateDataCredential
package/data-files.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type BatchChangeSpaceItem = {
package/data-files.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/data-files.ts
package/docs/rest.md CHANGED
@@ -62,3 +62,50 @@ try {
62
62
  ## Caching
63
63
 
64
64
  Every GET request is cached so that subsequent calls to the same api will resolve immediately from the cache. Read more about caching [here](features.md#caching).
65
+
66
+ ## Rest Interceptors
67
+
68
+ Interceptors can be added to allow custom functionality to happen before or after an api call. They run globally always on every request. The format is:
69
+
70
+ ```ts
71
+ // the interceptor format
72
+ const interceptor = async (request, proceed) => {
73
+ // do things before the request
74
+ const result = await proceed(request);
75
+ // do things after the request
76
+ return result;
77
+ };
78
+ ```
79
+
80
+ > [!WARNING]
81
+ > Use Interceptors with caution. They affect every request made by the library and can introduce strange side effects that are hard to discover and debug.
82
+
83
+ #### Examples
84
+
85
+ ```ts
86
+ import { addInterceptor, removeInterceptor } from "@qlik/api/interceptors";
87
+
88
+ // add a logging interceptor, which logs all requests, responses and errors
89
+ addInterceptor(async (request, proceed) => {
90
+ try {
91
+ console.log("-->", request.method, request.pathTemplate, request.pathVariables, request.query, request.body);
92
+ const result = await proceed(request);
93
+ console.log("<--", result.data);
94
+ return result;
95
+ } catch (err) {
96
+ console.log("<-*", err);
97
+ throw err;
98
+ }
99
+ });
100
+
101
+ // add additional header to a request
102
+ const headerInterceptor = addInterceptor(async (request, proceed) => {
103
+ // make sure headers object exists
104
+ (request.options = request.options || {}).headers = request.options.headers || {};
105
+ request.options.headers["x-another-header"] = "foobarvalue";
106
+ return proceed(request);
107
+ });
108
+
109
+ // remove an interceptor
110
+ removeInterceptor(headerInterceptor);
111
+ ```
package/extensions.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
package/extensions.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/extensions.ts
package/glossaries.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
@@ -110,6 +110,8 @@ type Category = {
110
110
  readonly createdBy: string;
111
111
  description: string;
112
112
  glossaryId: string;
113
+ /** The id for resolving updates in future imports/updates.
114
+ * Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded. */
113
115
  id: string;
114
116
  name: string;
115
117
  parentId?: string;
@@ -121,9 +123,6 @@ type Category = {
121
123
  };
122
124
  type CreateCategory = {
123
125
  description?: string;
124
- /** The id for resolving updates in future imports/updates.
125
- * Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded. */
126
- id?: string;
127
126
  /** The name of the category. May not be identical to another category belonging to the same parent. */
128
127
  name?: string;
129
128
  parentId?: string;
package/glossaries.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/glossaries.ts
package/groups.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  /**
package/groups.js CHANGED
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/groups.ts
@@ -1,4 +1,4 @@
1
- import { A as ApiCallOptions } from './global.types-qsBNouXJ.js';
1
+ import { A as ApiCallOptions } from './invoke-fetch-types-BLrpeZOL.js';
2
2
  import './auth-types-PkN9CAF_.js';
3
3
 
4
4
  type BaseIDP = {
@@ -470,7 +470,7 @@ type ClaimsMappingSAML = {
470
470
  sub: string[];
471
471
  };
472
472
  /**
473
- * This endpoint retrieves one or more identity providers from the service. The tenantID in the JWT will be used to fetch the identity provider.
473
+ * This endpoint retrieves any IdPs registered on the tenant.
474
474
  *
475
475
  * @param query an object with query parameters
476
476
  * @throws GetIdpsHttpError
@@ -498,7 +498,7 @@ type GetIdpsHttpError = {
498
498
  status: number;
499
499
  };
500
500
  /**
501
- * This endpoint creates an identity provider resource. It returns a 201 Created when creation is successful with a header "QLIK-IDP-POPTS" (A unique string representing a hash of the current configuration being tested), returns a 403 Forbidden for a non TenantAdmin user JWT or if the tenantID in the JWT does not match with any of the tenantIDs in the payload. An IdP can be created with Pending Options or options depending whether the IdP is interactive or not.
501
+ * Creates a new IdP on a tenant. Requesting user must be assigned the `TenantAdmin` role. For non-interactive IdPs (e.g. JWT), IdP must be created by sending `options` payload. For interactive IdPs (e.g. SAML or OIDC), send `pendingOptions` payload to require the interactive verification step; or send `options` payload with `skipVerify` set to `true` to skip validation step and make IdP immediately available.
502
502
  *
503
503
  * @param body an object with the body content
504
504
  * @throws CreateIdpHttpError
@@ -515,7 +515,7 @@ type CreateIdpHttpError = {
515
515
  status: number;
516
516
  };
517
517
  /**
518
- * This endpoint retrieves identity providers' metadata.
518
+ * Returns IdP configuration metadata supported on the tenant. Clients can use this information to programmatically configure their interactions with Qlik Cloud.
519
519
  *
520
520
  * @throws GetIdpWellKnownMetaDataHttpError
521
521
  */
@@ -531,7 +531,7 @@ type GetIdpWellKnownMetaDataHttpError = {
531
531
  status: number;
532
532
  };
533
533
  /**
534
- * Returns the active interactive IdP metadata
534
+ * Retrieves default IdP metadata when no interactive IdP is enabled.
535
535
  *
536
536
  * @throws GetMyIdpMetaHttpError
537
537
  */
@@ -547,7 +547,7 @@ type GetMyIdpMetaHttpError = {
547
547
  status: number;
548
548
  };
549
549
  /**
550
- * This endpoint retrieves the status of IdP configurations. Requires TenantAdmin role.
550
+ * Retrieves the status of all IdP configurations. Requires `TenantAdmin` role.
551
551
  *
552
552
  * @throws GetIdpStatusesHttpError
553
553
  */
@@ -563,7 +563,7 @@ type GetIdpStatusesHttpError = {
563
563
  status: number;
564
564
  };
565
565
  /**
566
- * This endpoint deletes an identity provider from the service. It returns a valid 204 when the IdP is deleted. Only a user with the role of TenantAdmin and tenant access can delete an associated IdP. Edge-auth service can also delete.
566
+ * Deletes an identity provider. Requesting user must be assigned the `TenantAdmin` role.
567
567
  *
568
568
  * @param id The identity provider ID.
569
569
  * @throws DeleteIdpHttpError
@@ -580,7 +580,7 @@ type DeleteIdpHttpError = {
580
580
  status: number;
581
581
  };
582
582
  /**
583
- * This endpoint is used to retrieve an identity provider from the service. It returns a valid 200 OK response when the IdP exists and the user (TenantAdmin) or service (edge-auth) is authorized to view the contents. Additionally, returns a header "QLIK-IDP-POPTS" (A unique string representing a hash of the current configuration being tested). It returns a 404 Not Found if the criteria is not met.
583
+ * Retrieves a specific IdP. Requesting user must be assigned the `TenantAdmin` role.
584
584
  *
585
585
  * @param id The identity provider ID.
586
586
  * @throws GetIdpHttpError
@@ -597,7 +597,7 @@ type GetIdpHttpError = {
597
597
  status: number;
598
598
  };
599
599
  /**
600
- * This endpoint patches an identity provider from the service. It returns a valid 204 when the IdP is patched. Only an edge-auth service request or a user with the role of TenantAdmin can patch an associated IdP. Partial failure is treated as complete failure and returns an error.
600
+ * Updates the configuration of an IdP. Requesting user must be assigned the `TenantAdmin` role. Partial failure is treated as complete failure and returns an error.
601
601
  *
602
602
  * @param id The identity provider ID.
603
603
  * @param body an object with the body content
@@ -620,53 +620,53 @@ type PatchIdpHttpError = {
620
620
  declare function clearCache(): void;
621
621
  interface IdentityProvidersAPI {
622
622
  /**
623
- * This endpoint retrieves one or more identity providers from the service. The tenantID in the JWT will be used to fetch the identity provider.
623
+ * This endpoint retrieves any IdPs registered on the tenant.
624
624
  *
625
625
  * @param query an object with query parameters
626
626
  * @throws GetIdpsHttpError
627
627
  */
628
628
  getIdps: typeof getIdps;
629
629
  /**
630
- * This endpoint creates an identity provider resource. It returns a 201 Created when creation is successful with a header "QLIK-IDP-POPTS" (A unique string representing a hash of the current configuration being tested), returns a 403 Forbidden for a non TenantAdmin user JWT or if the tenantID in the JWT does not match with any of the tenantIDs in the payload. An IdP can be created with Pending Options or options depending whether the IdP is interactive or not.
630
+ * Creates a new IdP on a tenant. Requesting user must be assigned the `TenantAdmin` role. For non-interactive IdPs (e.g. JWT), IdP must be created by sending `options` payload. For interactive IdPs (e.g. SAML or OIDC), send `pendingOptions` payload to require the interactive verification step; or send `options` payload with `skipVerify` set to `true` to skip validation step and make IdP immediately available.
631
631
  *
632
632
  * @param body an object with the body content
633
633
  * @throws CreateIdpHttpError
634
634
  */
635
635
  createIdp: typeof createIdp;
636
636
  /**
637
- * This endpoint retrieves identity providers' metadata.
637
+ * Returns IdP configuration metadata supported on the tenant. Clients can use this information to programmatically configure their interactions with Qlik Cloud.
638
638
  *
639
639
  * @throws GetIdpWellKnownMetaDataHttpError
640
640
  */
641
641
  getIdpWellKnownMetaData: typeof getIdpWellKnownMetaData;
642
642
  /**
643
- * Returns the active interactive IdP metadata
643
+ * Retrieves default IdP metadata when no interactive IdP is enabled.
644
644
  *
645
645
  * @throws GetMyIdpMetaHttpError
646
646
  */
647
647
  getMyIdpMeta: typeof getMyIdpMeta;
648
648
  /**
649
- * This endpoint retrieves the status of IdP configurations. Requires TenantAdmin role.
649
+ * Retrieves the status of all IdP configurations. Requires `TenantAdmin` role.
650
650
  *
651
651
  * @throws GetIdpStatusesHttpError
652
652
  */
653
653
  getIdpStatuses: typeof getIdpStatuses;
654
654
  /**
655
- * This endpoint deletes an identity provider from the service. It returns a valid 204 when the IdP is deleted. Only a user with the role of TenantAdmin and tenant access can delete an associated IdP. Edge-auth service can also delete.
655
+ * Deletes an identity provider. Requesting user must be assigned the `TenantAdmin` role.
656
656
  *
657
657
  * @param id The identity provider ID.
658
658
  * @throws DeleteIdpHttpError
659
659
  */
660
660
  deleteIdp: typeof deleteIdp;
661
661
  /**
662
- * This endpoint is used to retrieve an identity provider from the service. It returns a valid 200 OK response when the IdP exists and the user (TenantAdmin) or service (edge-auth) is authorized to view the contents. Additionally, returns a header "QLIK-IDP-POPTS" (A unique string representing a hash of the current configuration being tested). It returns a 404 Not Found if the criteria is not met.
662
+ * Retrieves a specific IdP. Requesting user must be assigned the `TenantAdmin` role.
663
663
  *
664
664
  * @param id The identity provider ID.
665
665
  * @throws GetIdpHttpError
666
666
  */
667
667
  getIdp: typeof getIdp;
668
668
  /**
669
- * This endpoint patches an identity provider from the service. It returns a valid 204 when the IdP is patched. Only an edge-auth service request or a user with the role of TenantAdmin can patch an associated IdP. Partial failure is treated as complete failure and returns an error.
669
+ * Updates the configuration of an IdP. Requesting user must be assigned the `TenantAdmin` role. Partial failure is treated as complete failure and returns an error.
670
670
  *
671
671
  * @param id The identity provider ID.
672
672
  * @param body an object with the body content
@@ -1,8 +1,8 @@
1
1
  import {
2
2
  clearApiCache,
3
3
  invokeFetch
4
- } from "./chunks/TUPLQG25.js";
5
- import "./chunks/SNQHDUYY.js";
4
+ } from "./chunks/UA6BE3VB.js";
5
+ import "./chunks/CZC7KEJN.js";
6
6
  import "./chunks/2ZQ3ZX7F.js";
7
7
 
8
8
  // src/public/rest/identity-providers.ts
package/index.d.ts CHANGED
@@ -1,3 +1,4 @@
1
+ import { InterceptorsAPI, createInterceptors } from './interceptors.js';
1
2
  import { registerAuthModule, setDefaultHostConfig, getAccessToken, AuthAPI } from './auth.js';
2
3
  import { QixAPI } from './qix.js';
3
4
  import { ApiKeysAPI } from './api-keys.js';
@@ -32,7 +33,7 @@ import { WebIntegrationsAPI } from './web-integrations.js';
32
33
  import { WebNotificationsAPI } from './web-notifications.js';
33
34
  import { WebhooksAPI } from './webhooks.js';
34
35
  import { H as HostConfig } from './auth-types-PkN9CAF_.js';
35
- import './global.types-qsBNouXJ.js';
36
+ import './invoke-fetch-types-BLrpeZOL.js';
36
37
 
37
38
  declare const apiKeys: ApiKeysAPI;
38
39
  declare const apps: AppsAPI;
@@ -54,6 +55,9 @@ declare const extensions: ExtensionsAPI;
54
55
  declare const glossaries: GlossariesAPI;
55
56
  declare const groups: GroupsAPI;
56
57
  declare const identityProviders: IdentityProvidersAPI;
58
+ declare const interceptors: InterceptorsAPI & {
59
+ createInterceptors: typeof createInterceptors;
60
+ };
57
61
  declare const items: ItemsAPI;
58
62
  declare const licenses: LicensesAPI;
59
63
  declare const qix: QixAPI & {
@@ -106,6 +110,8 @@ interface QlikAPI {
106
110
  groups: GroupsAPI;
107
111
  /** Functions for the identityProviders api */
108
112
  identityProviders: IdentityProvidersAPI;
113
+ /** Functions for the interceptors api */
114
+ interceptors: InterceptorsAPI;
109
115
  /** Functions for the items api */
110
116
  items: ItemsAPI;
111
117
  /** Functions for the licenses api */
@@ -141,9 +147,10 @@ interface QlikAPI {
141
147
  /** Functions for the webhooks api */
142
148
  webhooks: WebhooksAPI;
143
149
  }
144
- declare const createQlikApi: (props?: {
150
+ type CreateQlikApiProps = {
145
151
  hostConfig?: HostConfig;
146
- }) => QlikAPI;
152
+ };
153
+ declare const createQlikApi: (props?: CreateQlikApiProps) => QlikAPI;
147
154
  /** Javascript/Typescript bindings to Qlik's platform API's */
148
155
  declare const api: QlikAPI & {
149
156
  createQlikApi: (props?: {
@@ -151,4 +158,4 @@ declare const api: QlikAPI & {
151
158
  }) => QlikAPI;
152
159
  };
153
160
 
154
- export { type QlikAPI, apiKeys, apps, audits, auth, automations, brands, collections, createQlikApi, cspOrigins, dataAssets, dataConnections, dataCredentials, dataFiles, api as default, extensions, glossaries, groups, identityProviders, items, licenses, qix, quotas, reloadTasks, reloads, reports, roles, spaces, tempContents, tenants, themes, transports, users, webIntegrations, webNotifications, webhooks };
161
+ export { type CreateQlikApiProps, type QlikAPI, apiKeys, apps, audits, auth, automations, brands, collections, createQlikApi, cspOrigins, dataAssets, dataConnections, dataCredentials, dataFiles, api as default, extensions, glossaries, groups, identityProviders, interceptors, items, licenses, qix, quotas, reloadTasks, reloads, reports, roles, spaces, tempContents, tenants, themes, transports, users, webIntegrations, webNotifications, webhooks };