@qlik/api 0.0.9 → 0.0.11

package/glossaries.js

@@ -1,25 +1,25 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _EL2GSPZZjs = require('./chunks/EL2GSPZZ.js');
-require('./chunks/W2I5OQA5.js');
+var _NZ6E5ZHOjs = require('./chunks/NZ6E5ZHO.js');
+require('./chunks/NBNOAZT5.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/glossaries.ts
-var getGlossaries = async (query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var getGlossaries = async (query, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "get",
   pathTemplate: "/api/v1/glossaries",
   query,
   options
 });
-var createGlossary = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var createGlossary = async (body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "post",
   pathTemplate: "/api/v1/glossaries",
   body,
   contentType: "application/json",
   options
 });
-var importGlossary = async (query, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var importGlossary = async (query, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "post",
   pathTemplate: "/api/v1/glossaries/actions/import",
   query,
@@ -27,19 +27,19 @@ var importGlossary = async (query, body, options) => _EL2GSPZZjs.invokeFetch.cal
   contentType: "application/json",
   options
 });
-var deleteGlossary = async (id, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var deleteGlossary = async (id, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "delete",
   pathTemplate: "/api/v1/glossaries/{id}",
   pathVariables: { id },
   options
 });
-var getGlossary = async (id, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var getGlossary = async (id, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "get",
   pathTemplate: "/api/v1/glossaries/{id}",
   pathVariables: { id },
   options
 });
-var patchGlossary = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var patchGlossary = async (id, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "patch",
   pathTemplate: "/api/v1/glossaries/{id}",
   pathVariables: { id },
@@ -47,7 +47,7 @@ var patchGlossary = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call(vo
   contentType: "application/json",
   options
 });
-var updateGlossary = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var updateGlossary = async (id, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "put",
   pathTemplate: "/api/v1/glossaries/{id}",
   pathVariables: { id },
@@ -55,20 +55,20 @@ var updateGlossary = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call(v
   contentType: "application/json",
   options
 });
-var exportGlossary = async (id, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var exportGlossary = async (id, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "get",
   pathTemplate: "/api/v1/glossaries/{id}/actions/export",
   pathVariables: { id },
   options
 });
-var getGlossaryCategories = async (id, query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var getGlossaryCategories = async (id, query, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "get",
   pathTemplate: "/api/v1/glossaries/{id}/categories",
   pathVariables: { id },
   query,
   options
 });
-var createGlossaryCategory = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var createGlossaryCategory = async (id, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "post",
   pathTemplate: "/api/v1/glossaries/{id}/categories",
   pathVariables: { id },
@@ -76,19 +76,19 @@ var createGlossaryCategory = async (id, body, options) => _EL2GSPZZjs.invokeFetc
   contentType: "application/json",
   options
 });
-var deleteGlossaryCategory = async (id, categoryId, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var deleteGlossaryCategory = async (id, categoryId, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "delete",
   pathTemplate: "/api/v1/glossaries/{id}/categories/{categoryId}",
   pathVariables: { id, categoryId },
   options
 });
-var getGlossaryCategory = async (id, categoryId, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var getGlossaryCategory = async (id, categoryId, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "get",
   pathTemplate: "/api/v1/glossaries/{id}/categories/{categoryId}",
   pathVariables: { id, categoryId },
   options
 });
-var patchGlossaryCategory = async (id, categoryId, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var patchGlossaryCategory = async (id, categoryId, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "patch",
   pathTemplate: "/api/v1/glossaries/{id}/categories/{categoryId}",
   pathVariables: { id, categoryId },
@@ -96,7 +96,7 @@ var patchGlossaryCategory = async (id, categoryId, body, options) => _EL2GSPZZjs
   contentType: "application/json",
   options
 });
-var updateGlossaryCategory = async (id, categoryId, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var updateGlossaryCategory = async (id, categoryId, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "put",
   pathTemplate: "/api/v1/glossaries/{id}/categories/{categoryId}",
   pathVariables: { id, categoryId },
@@ -104,14 +104,14 @@ var updateGlossaryCategory = async (id, categoryId, body, options) => _EL2GSPZZj
   contentType: "application/json",
   options
 });
-var getGlossaryTerms = async (id, query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var getGlossaryTerms = async (id, query, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "get",
   pathTemplate: "/api/v1/glossaries/{id}/terms",
   pathVariables: { id },
   query,
   options
 });
-var createGlossaryTerm = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var createGlossaryTerm = async (id, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "post",
   pathTemplate: "/api/v1/glossaries/{id}/terms",
   pathVariables: { id },
@@ -119,19 +119,19 @@ var createGlossaryTerm = async (id, body, options) => _EL2GSPZZjs.invokeFetch.ca
   contentType: "application/json",
   options
 });
-var deleteGlossaryTerm = async (id, termId, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var deleteGlossaryTerm = async (id, termId, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "delete",
   pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}",
   pathVariables: { id, termId },
   options
 });
-var getGlossaryTerm = async (id, termId, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var getGlossaryTerm = async (id, termId, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "get",
   pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}",
   pathVariables: { id, termId },
   options
 });
-var patchGlossaryTerm = async (id, termId, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var patchGlossaryTerm = async (id, termId, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "patch",
   pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}",
   pathVariables: { id, termId },
@@ -139,7 +139,7 @@ var patchGlossaryTerm = async (id, termId, body, options) => _EL2GSPZZjs.invokeF
   contentType: "application/json",
   options
 });
-var updateGlossaryTerm = async (id, termId, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var updateGlossaryTerm = async (id, termId, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "put",
   pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}",
   pathVariables: { id, termId },
@@ -147,21 +147,21 @@ var updateGlossaryTerm = async (id, termId, body, options) => _EL2GSPZZjs.invoke
   contentType: "application/json",
   options
 });
-var changeGlossaryTermStatus = async (id, termId, query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var changeGlossaryTermStatus = async (id, termId, query, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "post",
   pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}/actions/change-status",
   pathVariables: { id, termId },
   query,
   options
 });
-var getGlossaryTermLinks = async (id, termId, query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var getGlossaryTermLinks = async (id, termId, query, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "get",
   pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}/links",
   pathVariables: { id, termId },
   query,
   options
 });
-var createGlossaryTermLink = async (id, termId, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var createGlossaryTermLink = async (id, termId, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "post",
   pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}/links",
   pathVariables: { id, termId },
@@ -169,7 +169,7 @@ var createGlossaryTermLink = async (id, termId, body, options) => _EL2GSPZZjs.in
   contentType: "application/json",
   options
 });
-var getGlossaryTermRevisions = async (id, termId, query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "glossaries", {
+var getGlossaryTermRevisions = async (id, termId, query, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "glossaries", {
   method: "get",
   pathTemplate: "/api/v1/glossaries/{id}/terms/{termId}/revisions",
   pathVariables: { id, termId },
@@ -177,7 +177,7 @@ var getGlossaryTermRevisions = async (id, termId, query, options) => _EL2GSPZZjs
   options
 });
 function clearCache() {
-  return _EL2GSPZZjs.clearApiCache.call(void 0, "glossaries");
+  return _NZ6E5ZHOjs.clearApiCache.call(void 0, "glossaries");
 }
 var glossariesExport = {
   getGlossaries,

package/glossaries.mjs

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/POR3DZIU.mjs";
-import "./chunks/VLLTA4EY.mjs";
+} from "./chunks/J3UXBHGX.mjs";
+import "./chunks/E3HDOP72.mjs";
 import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/glossaries.ts

package/groups.d.mts

@@ -1,6 +1,9 @@
 import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
+/**
+ * An array of role references.
+ */
 type AssignedRoles = {
     /** The unique role identitier */
     id: string;
@@ -13,14 +16,23 @@ type AssignedRoles = {
     /** The type of role */
     readonly type: "default";
 }[];
+/**
+ * An array of role reference identifiers.
+ */
 type AssignedRolesRefIDs = {
     /** The unique role identitier */
     id: string;
 }[];
+/**
+ * An array of role reference names.
+ */
 type AssignedRolesRefNames = {
     /** The name of the role */
     name: string;
 }[];
+/**
+ * An error object describing the error.
+ */
 type Error = {
     /** The error code. */
     code: string;
@@ -40,16 +52,25 @@ type Error = {
     /** Summary of the problem. */
     title: string;
 };
+/**
+ * The error response object describing the error from the handling of an HTTP request.
+ */
 type Errors = {
     /** An array of errors related to the operation. */
     errors?: Error[];
     /** A unique identifier for tracing the error. */
     traceId?: string;
 };
+/**
+ * An advanced query filter to be used for complex user querying in the tenant.
+ */
 type Filter = {
     /** The advanced filtering to be applied the query. All conditional statements within this query parameter are case insensitive. */
     filter?: string;
 };
+/**
+ * represents a Group document
+ */
 type Group = {
     assignedRoles?: {
         id: string;
@@ -78,6 +99,9 @@ type Group = {
     /** The tenant identifier associated with the given group */
     tenantId: string;
 };
+/**
+ * A JSON Patch document.
+ */
 type GroupPatch = {
     /** The operation to be performed. Currently "replace" is the only supported operation. */
     op: "replace";
@@ -86,6 +110,9 @@ type GroupPatch = {
     /** The roles to assign to the group (limit of 100 roles per group). */
     value: AssignedRolesRefIDs | AssignedRolesRefNames;
 };
+/**
+ * An array of JSON Patches for a group.
+ */
 type GroupPatchSchema = GroupPatch[];
 type GroupPostSchema = {
     /** The roles to assign to the group (limit of 100 roles per group). */
@@ -95,6 +122,9 @@ type GroupPostSchema = {
     /** The status of the created group within the tenant. Defaults to active if empty. */
     status?: "active";
 };
+/**
+ * represents a GroupSetting document
+ */
 type GroupSettings = {
     /** Determines if groups should be created on login. */
     autoCreateGroups: boolean;
@@ -126,6 +156,9 @@ type GroupSettings = {
     /** The unique tenant identifier. */
     tenantId: string;
 };
+/**
+ * A result object when listing groups.
+ */
 type Groups = {
     /** An array of groups. */
     data?: Group[];
@@ -146,6 +179,9 @@ type Groups = {
     /** Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true. */
     totalResults?: number;
 };
+/**
+ * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
+ */
 type SettingsPatch = {
     /** The operation to be performed. */
     op: "replace";
@@ -154,6 +190,9 @@ type SettingsPatch = {
     /** The value to be used for this operation. */
     value: boolean | AssignedRolesRefIDs | AssignedRolesRefNames;
 };
+/**
+ * An array of JSON Patches for the groups settings.
+ */
 type SettingsPatchSchema = SettingsPatch[];
 /**
  * Returns a list of groups with cursor-based pagination.

package/groups.d.ts

@@ -1,6 +1,9 @@
 import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
 import './auth-types-nnUcWhuU.js';
 
+/**
+ * An array of role references.
+ */
 type AssignedRoles = {
     /** The unique role identitier */
     id: string;
@@ -13,14 +16,23 @@ type AssignedRoles = {
     /** The type of role */
     readonly type: "default";
 }[];
+/**
+ * An array of role reference identifiers.
+ */
 type AssignedRolesRefIDs = {
     /** The unique role identitier */
     id: string;
 }[];
+/**
+ * An array of role reference names.
+ */
 type AssignedRolesRefNames = {
     /** The name of the role */
     name: string;
 }[];
+/**
+ * An error object describing the error.
+ */
 type Error = {
     /** The error code. */
     code: string;
@@ -40,16 +52,25 @@ type Error = {
     /** Summary of the problem. */
     title: string;
 };
+/**
+ * The error response object describing the error from the handling of an HTTP request.
+ */
 type Errors = {
     /** An array of errors related to the operation. */
     errors?: Error[];
     /** A unique identifier for tracing the error. */
     traceId?: string;
 };
+/**
+ * An advanced query filter to be used for complex user querying in the tenant.
+ */
 type Filter = {
     /** The advanced filtering to be applied the query. All conditional statements within this query parameter are case insensitive. */
     filter?: string;
 };
+/**
+ * represents a Group document
+ */
 type Group = {
     assignedRoles?: {
         id: string;
@@ -78,6 +99,9 @@ type Group = {
     /** The tenant identifier associated with the given group */
     tenantId: string;
 };
+/**
+ * A JSON Patch document.
+ */
 type GroupPatch = {
     /** The operation to be performed. Currently "replace" is the only supported operation. */
     op: "replace";
@@ -86,6 +110,9 @@ type GroupPatch = {
     /** The roles to assign to the group (limit of 100 roles per group). */
     value: AssignedRolesRefIDs | AssignedRolesRefNames;
 };
+/**
+ * An array of JSON Patches for a group.
+ */
 type GroupPatchSchema = GroupPatch[];
 type GroupPostSchema = {
     /** The roles to assign to the group (limit of 100 roles per group). */
@@ -95,6 +122,9 @@ type GroupPostSchema = {
     /** The status of the created group within the tenant. Defaults to active if empty. */
     status?: "active";
 };
+/**
+ * represents a GroupSetting document
+ */
 type GroupSettings = {
     /** Determines if groups should be created on login. */
     autoCreateGroups: boolean;
@@ -126,6 +156,9 @@ type GroupSettings = {
     /** The unique tenant identifier. */
     tenantId: string;
 };
+/**
+ * A result object when listing groups.
+ */
 type Groups = {
     /** An array of groups. */
     data?: Group[];
@@ -146,6 +179,9 @@ type Groups = {
     /** Indicates the total number of matching documents. Will only be returned if the query parameter "totalResults" is true. */
     totalResults?: number;
 };
+/**
+ * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
+ */
 type SettingsPatch = {
     /** The operation to be performed. */
     op: "replace";
@@ -154,6 +190,9 @@ type SettingsPatch = {
     /** The value to be used for this operation. */
     value: boolean | AssignedRolesRefIDs | AssignedRolesRefNames;
 };
+/**
+ * An array of JSON Patches for the groups settings.
+ */
 type SettingsPatchSchema = SettingsPatch[];
 /**
  * Returns a list of groups with cursor-based pagination.

package/groups.js

@@ -1,25 +1,25 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _EL2GSPZZjs = require('./chunks/EL2GSPZZ.js');
-require('./chunks/W2I5OQA5.js');
+var _NZ6E5ZHOjs = require('./chunks/NZ6E5ZHO.js');
+require('./chunks/NBNOAZT5.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/groups.ts
-var getGroups = async (query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "groups", {
+var getGroups = async (query, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "groups", {
   method: "get",
   pathTemplate: "/api/v1/groups",
   query,
   options
 });
-var createGroup = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "groups", {
+var createGroup = async (body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "groups", {
   method: "post",
   pathTemplate: "/api/v1/groups",
   body,
   contentType: "application/json",
   options
 });
-var filterGroups = async (query, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "groups", {
+var filterGroups = async (query, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "groups", {
   method: "post",
   pathTemplate: "/api/v1/groups/actions/filter",
   query,
@@ -27,31 +27,31 @@ var filterGroups = async (query, body, options) => _EL2GSPZZjs.invokeFetch.call(
   contentType: "application/json",
   options
 });
-var getGroupsSettings = async (options) => _EL2GSPZZjs.invokeFetch.call(void 0, "groups", {
+var getGroupsSettings = async (options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "groups", {
   method: "get",
   pathTemplate: "/api/v1/groups/settings",
   options
 });
-var patchGroupsSettings = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "groups", {
+var patchGroupsSettings = async (body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "groups", {
   method: "patch",
   pathTemplate: "/api/v1/groups/settings",
   body,
   contentType: "application/json",
   options
 });
-var deleteGroup = async (groupId, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "groups", {
+var deleteGroup = async (groupId, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "groups", {
   method: "delete",
   pathTemplate: "/api/v1/groups/{groupId}",
   pathVariables: { groupId },
   options
 });
-var getGroup = async (groupId, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "groups", {
+var getGroup = async (groupId, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "groups", {
   method: "get",
   pathTemplate: "/api/v1/groups/{groupId}",
   pathVariables: { groupId },
   options
 });
-var patchGroup = async (groupId, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "groups", {
+var patchGroup = async (groupId, body, options) => _NZ6E5ZHOjs.invokeFetch.call(void 0, "groups", {
   method: "patch",
   pathTemplate: "/api/v1/groups/{groupId}",
   pathVariables: { groupId },
@@ -60,7 +60,7 @@ var patchGroup = async (groupId, body, options) => _EL2GSPZZjs.invokeFetch.call(
   options
 });
 function clearCache() {
-  return _EL2GSPZZjs.clearApiCache.call(void 0, "groups");
+  return _NZ6E5ZHOjs.clearApiCache.call(void 0, "groups");
 }
 var groupsExport = {
   getGroups,

package/groups.mjs

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/POR3DZIU.mjs";
-import "./chunks/VLLTA4EY.mjs";
+} from "./chunks/J3UXBHGX.mjs";
+import "./chunks/E3HDOP72.mjs";
 import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/groups.ts

package/identity-providers.d.mts

@@ -26,6 +26,9 @@ type BaseIDP = {
     /** The tenant identifiers associated with the given IdP. */
     tenantIds?: string[];
 };
+/**
+ * Payload for creating an identity provider using JWT authentication.
+ */
 type CreateJWTAuthPayload = {
     /** 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. */
     clockToleranceSec?: number;
@@ -49,6 +52,9 @@ type CreateJWTAuthPayload = {
     /** The tenant identifiers that map to the given IdP. */
     tenantIds?: string[];
 };
+/**
+ * Payload for creating an OIDC-compatible identity provider.
+ */
 type CreateOIDCPayload = {
     /** 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. */
     clockToleranceSec?: number;
@@ -106,6 +112,9 @@ type CreateOIDCPayload = {
     /** The tenant identifiers that map to the given IdP. */
     tenantIds?: string[];
 };
+/**
+ * An error object.
+ */
 type Error = {
     /** The error code. */
     code: string;
@@ -125,6 +134,9 @@ type Error = {
     /** Summary of the problem. */
     title: string;
 };
+/**
+ * A representation of the errors encountered from the HTTP request.
+ */
 type Errors = {
     errors?: Error[];
 };
@@ -135,6 +147,9 @@ type IDPArray = {
     /** Contains pagination links. */
     links?: Links;
 };
+/**
+ * An identity provider for JWT authentication.
+ */
 type IDPJWTAuth = BaseIDP & {
     options?: {
         /** The expected JWT issuer */
@@ -153,6 +168,9 @@ type IDPMeta = {
     /** A link to direct you to where you can manage your Qlik account. Only available if the default identity provider is used (no custom interactive identity providers are active). */
     userPortalLink?: string;
 };
+/**
+ * An OIDC-compliant identity provider.
+ */
 type IDPOIDC = BaseIDP & {
     options?: IDPOptions;
     pendingOptions?: IDPOptions;
@@ -184,7 +202,13 @@ type IDPOptions = {
 };
 type IDPPatchSchema = PatchOIDCPayload[] | PatchJWTAuthPayload[];
 type IDPPostSchema = CreateOIDCPayload | CreateJWTAuthPayload;
+/**
+ * The protocol to be used for communicating with the identity provider. Valid values are `OIDC`, `jwtAuth`, and `qsefw-local-bearer-token`.
+ */
 type IDPProtocol = "OIDC" | "jwtAuth" | "qsefw-local-bearer-token";
+/**
+ * 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`.
+ */
 type IDPProvider = "auth0" | "okta" | "qlik" | "generic" | "salesforce" | "keycloak" | "adfs" | "external" | "azureAD";
 type IDPsStatus = {
     /** The number of active interactive IdPs. */
@@ -199,6 +223,9 @@ type IDPsStatus = {
         provider?: IDPProvider;
     }[];
 };
+/**
+ * Contains pagination links.
+ */
 type Links = {
     next?: {
         /** Link to the next page of items. */
@@ -213,6 +240,9 @@ type Links = {
         href?: string;
     };
 };
+/**
+ * OpenID configuration
+ */
 type OpenIDConfiguration = {
     /** OAuth 2.0 Authorization Endpoint */
     authorization_endpoint: string;
@@ -229,6 +259,9 @@ type OpenIDConfiguration = {
     /** URL of the OP's UserInfo Endpoint */
     userinfo_endpoint?: string;
 };
+/**
+ * A patch request for an identity provider using the `jwtAuth` protocol.
+ */
 type PatchJWTAuthPayload = {
     /** The "operation" to be performed on a given IdP. */
     op: "replace";
@@ -237,6 +270,9 @@ type PatchJWTAuthPayload = {
     /** The "value" data type is dependent on the path value being used. */
     value?: unknown;
 };
+/**
+ * A patch request for an identity provider using the `OIDC` protocol.
+ */
 type PatchOIDCPayload = {
     /** The "operation" to be performed on a given IdP. Currently supports a custom operation value called "promote-options" that allows the test configuration to be promoted to the current configuration used for login. */
     op: "replace" | "promote-options";
@@ -265,6 +301,9 @@ type PendingResult = {
     /** The status of the IdP configuration being tested. */
     status: "success" | "pending" | "error" | "claimsError" | "callbackError" | "tokenError" | "protocolError" | "networkError" | "configChangedDuringTestError";
 };
+/**
+ * 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.
+ */
 type ClaimsMappingInteractive = {
     /** A list of JSON pointers used to map the user's client ID. */
     client_id?: string[];
@@ -285,6 +324,9 @@ type ClaimsMappingInteractive = {
     /** A list of JSON pointers used to map the user's zoneinfo. */
     zoneinfo?: string[];
 };
+/**
+ * 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.
+ */
 type ClaimsMappingNonInteractive = {
     /** A list of JSON pointers used to map the user's client ID. */
     client_id?: string[];