@qlik/api 0.0.16 → 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/README.md +1 -1
- package/api-keys.js +25 -25
- package/apps.d.ts +9 -1
- package/apps.js +97 -97
- package/audits.js +23 -23
- package/auth.js +14 -14
- package/automations.js +47 -47
- package/brands.js +35 -35
- package/chunks/4HB3TAEO.js +4 -4
- package/chunks/{HHOVS7QC.mjs → CHNBNLXY.js} +3 -3
- package/chunks/{3YV6X7S6.mjs → FFGE2RP7.js} +1 -1
- package/chunks/{HOCTJESP.mjs → JEGN7XQV.js} +3 -3
- package/chunks/{6WX5AGKQ.mjs → L2BJNKLV.js} +2 -2
- package/chunks/OPRGGO4C.js +8 -8
- package/chunks/{O4EAKEIN.mjs → RHF624NQ.js} +1 -1
- package/chunks/{BYD63JCG.mjs → SIU6HO6B.js} +5 -3
- package/chunks/{EHAANYDL.mjs → TT66UJZY.js} +3 -3
- package/chunks/{UKVTBYP6.mjs → XOVMZWDC.js} +2 -2
- package/chunks/{6AD3HYSF.mjs → XZQNE4HH.js} +1 -1
- package/collections.js +33 -33
- package/csp-origins.js +23 -23
- package/data-assets.js +21 -21
- package/data-connections.js +29 -29
- package/data-credentials.js +19 -19
- package/data-files.js +35 -35
- package/docs/authentication.md +5 -5
- package/docs/examples/fetch-spaces.md +1 -15
- package/docs/examples/show-sheet-list.md +1 -1
- package/docs/features.md +1 -1
- package/extensions.js +25 -25
- package/glossaries.js +59 -59
- package/groups.d.ts +0 -3
- package/groups.js +27 -27
- package/identity-providers.d.ts +144 -10
- package/identity-providers.js +27 -27
- package/index.js +53 -53
- package/items.js +27 -27
- package/licenses.js +29 -29
- package/package.json +36 -232
- package/qix.d.ts +1 -1
- package/qix.js +10 -10
- package/quotas.js +15 -15
- package/reload-tasks.js +21 -21
- package/reloads.js +19 -19
- package/roles.js +15 -15
- package/spaces.js +35 -35
- package/temp-contents.js +17 -17
- package/tenants.js +23 -23
- package/themes.js +25 -25
- package/transports.js +23 -23
- package/users.d.ts +1 -3
- package/users.js +31 -31
- package/web-integrations.js +21 -21
- package/web-notifications.js +23 -23
- package/webhooks.js +31 -31
- package/api-keys.d.mts +0 -336
- package/api-keys.mjs +0 -80
- package/apps.d.mts +0 -2431
- package/apps.mjs +0 -398
- package/audits.d.mts +0 -286
- package/audits.mjs +0 -64
- package/auth-types-nnUcWhuU.d.mts +0 -98
- package/auth.d.mts +0 -26
- package/auth.mjs +0 -14
- package/automations.d.mts +0 -682
- package/automations.mjs +0 -173
- package/brands.d.mts +0 -670
- package/brands.mjs +0 -123
- package/chunks/2YWCEGTS.js +0 -21
- package/chunks/34ZKUFEA.js +0 -41
- package/chunks/4WHZ4EIW.js +0 -57
- package/chunks/B4VPD3ZT.js +0 -574
- package/chunks/BM4OSDRZ.js +0 -17
- package/chunks/DCXUEDOW.mjs +0 -67
- package/chunks/MTAQE4WC.js +0 -10411
- package/chunks/PLOSYUG2.js +0 -25
- package/chunks/URIW2U5M.js +0 -17
- package/chunks/VSY5YIQY.mjs +0 -11
- package/chunks/WOYJLK4Y.js +0 -1623
- package/collections.d.mts +0 -581
- package/collections.mjs +0 -114
- package/csp-origins.d.mts +0 -273
- package/csp-origins.mjs +0 -69
- package/data-assets.d.mts +0 -205
- package/data-assets.mjs +0 -66
- package/data-connections.d.mts +0 -594
- package/data-connections.mjs +0 -103
- package/data-credentials.d.mts +0 -204
- package/data-credentials.mjs +0 -59
- package/data-files.d.mts +0 -562
- package/data-files.mjs +0 -123
- package/extensions.d.mts +0 -293
- package/extensions.mjs +0 -77
- package/global.types-5iFvFJvX.d.mts +0 -115
- package/glossaries.d.mts +0 -1173
- package/glossaries.mjs +0 -237
- package/groups.d.mts +0 -434
- package/groups.mjs +0 -88
- package/identity-providers.d.mts +0 -550
- package/identity-providers.mjs +0 -83
- package/index.d.mts +0 -142
- package/index.mjs +0 -716
- package/items.d.mts +0 -535
- package/items.mjs +0 -87
- package/licenses.d.mts +0 -459
- package/licenses.mjs +0 -92
- package/qix.d.mts +0 -11629
- package/qix.mjs +0 -10
- package/quotas.d.mts +0 -112
- package/quotas.mjs +0 -32
- package/reload-tasks.d.mts +0 -227
- package/reload-tasks.mjs +0 -62
- package/reloads.d.mts +0 -207
- package/reloads.mjs +0 -46
- package/roles.d.mts +0 -175
- package/roles.mjs +0 -31
- package/spaces.d.mts +0 -562
- package/spaces.mjs +0 -124
- package/temp-contents.d.mts +0 -167
- package/temp-contents.mjs +0 -41
- package/tenants.d.mts +0 -300
- package/tenants.mjs +0 -73
- package/themes.d.mts +0 -268
- package/themes.mjs +0 -77
- package/transports.d.mts +0 -319
- package/transports.mjs +0 -65
- package/users.d.mts +0 -631
- package/users.mjs +0 -104
- package/web-integrations.d.mts +0 -274
- package/web-integrations.mjs +0 -62
- package/web-notifications.d.mts +0 -250
- package/web-notifications.mjs +0 -69
- package/webhooks.d.mts +0 -445
- package/webhooks.mjs +0 -104
package/groups.js
CHANGED
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
1
|
+
import {
|
|
2
|
+
clearApiCache,
|
|
3
|
+
invokeFetch
|
|
4
|
+
} from "./chunks/FFGE2RP7.js";
|
|
5
|
+
import "./chunks/TT66UJZY.js";
|
|
6
|
+
import "./chunks/4HB3TAEO.js";
|
|
7
7
|
|
|
8
8
|
// src/public/rest/groups.ts
|
|
9
|
-
var getGroups = async (query, options) =>
|
|
9
|
+
var getGroups = async (query, options) => invokeFetch("groups", {
|
|
10
10
|
method: "get",
|
|
11
11
|
pathTemplate: "/api/v1/groups",
|
|
12
12
|
query,
|
|
13
13
|
options
|
|
14
14
|
});
|
|
15
|
-
var createGroup = async (body, options) =>
|
|
15
|
+
var createGroup = async (body, options) => invokeFetch("groups", {
|
|
16
16
|
method: "post",
|
|
17
17
|
pathTemplate: "/api/v1/groups",
|
|
18
18
|
body,
|
|
19
19
|
contentType: "application/json",
|
|
20
20
|
options
|
|
21
21
|
});
|
|
22
|
-
var filterGroups = async (query, body, options) =>
|
|
22
|
+
var filterGroups = async (query, body, options) => invokeFetch("groups", {
|
|
23
23
|
method: "post",
|
|
24
24
|
pathTemplate: "/api/v1/groups/actions/filter",
|
|
25
25
|
query,
|
|
@@ -27,31 +27,31 @@ var filterGroups = async (query, body, options) => _URIW2U5Mjs.invokeFetch.call(
|
|
|
27
27
|
contentType: "application/json",
|
|
28
28
|
options
|
|
29
29
|
});
|
|
30
|
-
var getGroupsSettings = async (options) =>
|
|
30
|
+
var getGroupsSettings = async (options) => invokeFetch("groups", {
|
|
31
31
|
method: "get",
|
|
32
32
|
pathTemplate: "/api/v1/groups/settings",
|
|
33
33
|
options
|
|
34
34
|
});
|
|
35
|
-
var patchGroupsSettings = async (body, options) =>
|
|
35
|
+
var patchGroupsSettings = async (body, options) => invokeFetch("groups", {
|
|
36
36
|
method: "patch",
|
|
37
37
|
pathTemplate: "/api/v1/groups/settings",
|
|
38
38
|
body,
|
|
39
39
|
contentType: "application/json",
|
|
40
40
|
options
|
|
41
41
|
});
|
|
42
|
-
var deleteGroup = async (groupId, options) =>
|
|
42
|
+
var deleteGroup = async (groupId, options) => invokeFetch("groups", {
|
|
43
43
|
method: "delete",
|
|
44
44
|
pathTemplate: "/api/v1/groups/{groupId}",
|
|
45
45
|
pathVariables: { groupId },
|
|
46
46
|
options
|
|
47
47
|
});
|
|
48
|
-
var getGroup = async (groupId, options) =>
|
|
48
|
+
var getGroup = async (groupId, options) => invokeFetch("groups", {
|
|
49
49
|
method: "get",
|
|
50
50
|
pathTemplate: "/api/v1/groups/{groupId}",
|
|
51
51
|
pathVariables: { groupId },
|
|
52
52
|
options
|
|
53
53
|
});
|
|
54
|
-
var patchGroup = async (groupId, body, options) =>
|
|
54
|
+
var patchGroup = async (groupId, body, options) => invokeFetch("groups", {
|
|
55
55
|
method: "patch",
|
|
56
56
|
pathTemplate: "/api/v1/groups/{groupId}",
|
|
57
57
|
pathVariables: { groupId },
|
|
@@ -60,7 +60,7 @@ var patchGroup = async (groupId, body, options) => _URIW2U5Mjs.invokeFetch.call(
|
|
|
60
60
|
options
|
|
61
61
|
});
|
|
62
62
|
function clearCache() {
|
|
63
|
-
return
|
|
63
|
+
return clearApiCache("groups");
|
|
64
64
|
}
|
|
65
65
|
var groupsExport = {
|
|
66
66
|
getGroups,
|
|
@@ -74,15 +74,15 @@ var groupsExport = {
|
|
|
74
74
|
clearCache
|
|
75
75
|
};
|
|
76
76
|
var groups_default = groupsExport;
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
77
|
+
export {
|
|
78
|
+
clearCache,
|
|
79
|
+
createGroup,
|
|
80
|
+
groups_default as default,
|
|
81
|
+
deleteGroup,
|
|
82
|
+
filterGroups,
|
|
83
|
+
getGroup,
|
|
84
|
+
getGroups,
|
|
85
|
+
getGroupsSettings,
|
|
86
|
+
patchGroup,
|
|
87
|
+
patchGroupsSettings
|
|
88
|
+
};
|
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
|
@@ -1,52 +1,52 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
1
|
+
import {
|
|
2
|
+
clearApiCache,
|
|
3
|
+
invokeFetch
|
|
4
|
+
} from "./chunks/FFGE2RP7.js";
|
|
5
|
+
import "./chunks/TT66UJZY.js";
|
|
6
|
+
import "./chunks/4HB3TAEO.js";
|
|
7
7
|
|
|
8
8
|
// src/public/rest/identity-providers.ts
|
|
9
|
-
var getIdps = async (query, options) =>
|
|
9
|
+
var getIdps = async (query, options) => invokeFetch("identity-providers", {
|
|
10
10
|
method: "get",
|
|
11
11
|
pathTemplate: "/api/v1/identity-providers",
|
|
12
12
|
query,
|
|
13
13
|
options
|
|
14
14
|
});
|
|
15
|
-
var createIdp = async (body, options) =>
|
|
15
|
+
var createIdp = async (body, options) => invokeFetch("identity-providers", {
|
|
16
16
|
method: "post",
|
|
17
17
|
pathTemplate: "/api/v1/identity-providers",
|
|
18
18
|
body,
|
|
19
19
|
contentType: "application/json",
|
|
20
20
|
options
|
|
21
21
|
});
|
|
22
|
-
var getIdpWellKnownMetaData = async (options) =>
|
|
22
|
+
var getIdpWellKnownMetaData = async (options) => invokeFetch("identity-providers", {
|
|
23
23
|
method: "get",
|
|
24
24
|
pathTemplate: "/api/v1/identity-providers/.well-known/metadata.json",
|
|
25
25
|
options
|
|
26
26
|
});
|
|
27
|
-
var getMyIdpMeta = async (options) =>
|
|
27
|
+
var getMyIdpMeta = async (options) => invokeFetch("identity-providers", {
|
|
28
28
|
method: "get",
|
|
29
29
|
pathTemplate: "/api/v1/identity-providers/me/meta",
|
|
30
30
|
options
|
|
31
31
|
});
|
|
32
|
-
var getIdpStatuses = async (options) =>
|
|
32
|
+
var getIdpStatuses = async (options) => invokeFetch("identity-providers", {
|
|
33
33
|
method: "get",
|
|
34
34
|
pathTemplate: "/api/v1/identity-providers/status",
|
|
35
35
|
options
|
|
36
36
|
});
|
|
37
|
-
var deleteIdp = async (id, options) =>
|
|
37
|
+
var deleteIdp = async (id, options) => invokeFetch("identity-providers", {
|
|
38
38
|
method: "delete",
|
|
39
39
|
pathTemplate: "/api/v1/identity-providers/{id}",
|
|
40
40
|
pathVariables: { id },
|
|
41
41
|
options
|
|
42
42
|
});
|
|
43
|
-
var getIdp = async (id, options) =>
|
|
43
|
+
var getIdp = async (id, options) => invokeFetch("identity-providers", {
|
|
44
44
|
method: "get",
|
|
45
45
|
pathTemplate: "/api/v1/identity-providers/{id}",
|
|
46
46
|
pathVariables: { id },
|
|
47
47
|
options
|
|
48
48
|
});
|
|
49
|
-
var patchIdp = async (id, body, options) =>
|
|
49
|
+
var patchIdp = async (id, body, options) => invokeFetch("identity-providers", {
|
|
50
50
|
method: "patch",
|
|
51
51
|
pathTemplate: "/api/v1/identity-providers/{id}",
|
|
52
52
|
pathVariables: { id },
|
|
@@ -55,7 +55,7 @@ var patchIdp = async (id, body, options) => _URIW2U5Mjs.invokeFetch.call(void 0,
|
|
|
55
55
|
options
|
|
56
56
|
});
|
|
57
57
|
function clearCache() {
|
|
58
|
-
return
|
|
58
|
+
return clearApiCache("identity-providers");
|
|
59
59
|
}
|
|
60
60
|
var identityProvidersExport = {
|
|
61
61
|
getIdps,
|
|
@@ -69,15 +69,15 @@ var identityProvidersExport = {
|
|
|
69
69
|
clearCache
|
|
70
70
|
};
|
|
71
71
|
var identity_providers_default = identityProvidersExport;
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
72
|
+
export {
|
|
73
|
+
clearCache,
|
|
74
|
+
createIdp,
|
|
75
|
+
identity_providers_default as default,
|
|
76
|
+
deleteIdp,
|
|
77
|
+
getIdp,
|
|
78
|
+
getIdpStatuses,
|
|
79
|
+
getIdpWellKnownMetaData,
|
|
80
|
+
getIdps,
|
|
81
|
+
getMyIdpMeta,
|
|
82
|
+
patchIdp
|
|
83
|
+
};
|
package/index.js
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
1
|
+
import {
|
|
2
|
+
auth_default
|
|
3
|
+
} from "./chunks/XZQNE4HH.js";
|
|
4
|
+
import {
|
|
5
|
+
qix_default
|
|
6
|
+
} from "./chunks/RHF624NQ.js";
|
|
7
|
+
import {
|
|
8
|
+
clearApiCache,
|
|
9
|
+
invokeFetch
|
|
10
|
+
} from "./chunks/FFGE2RP7.js";
|
|
11
|
+
import "./chunks/TT66UJZY.js";
|
|
12
|
+
import "./chunks/4HB3TAEO.js";
|
|
13
13
|
|
|
14
14
|
// src/public/public-runtime-api-generator/public-runtime-api-generator.ts
|
|
15
15
|
var methodAbbreviations = {
|
|
@@ -26,7 +26,7 @@ var methodAbbreviations = {
|
|
|
26
26
|
function methodCharToMethodName(method) {
|
|
27
27
|
try {
|
|
28
28
|
return methodAbbreviations[method];
|
|
29
|
-
} catch
|
|
29
|
+
} catch {
|
|
30
30
|
throw new Error(`Unknown short hand method:${method}`);
|
|
31
31
|
}
|
|
32
32
|
}
|
|
@@ -40,7 +40,7 @@ var contentTypeAbbreviations = {
|
|
|
40
40
|
function contentTypeCharToContentType(typeChar) {
|
|
41
41
|
try {
|
|
42
42
|
return contentTypeAbbreviations[typeChar];
|
|
43
|
-
} catch
|
|
43
|
+
} catch {
|
|
44
44
|
throw new Error(`Unknown short hand content-type: ${typeChar}`);
|
|
45
45
|
}
|
|
46
46
|
}
|
|
@@ -84,7 +84,7 @@ function apiDefToApi(namespace, def) {
|
|
|
84
84
|
return runtimeApiCache[namespace];
|
|
85
85
|
}
|
|
86
86
|
const api2 = {
|
|
87
|
-
clearCache: () =>
|
|
87
|
+
clearCache: () => clearApiCache(namespace)
|
|
88
88
|
};
|
|
89
89
|
const initFunc = () => {
|
|
90
90
|
traverse(namespace, "", def, api2);
|
|
@@ -153,7 +153,7 @@ function createClassicApiFn(namespace, operationName, pathTemplate, method, argN
|
|
|
153
153
|
if (useInstead) {
|
|
154
154
|
console.warn(`${namespace}.${operationName} is deprecated, use ${useInstead} instead`);
|
|
155
155
|
}
|
|
156
|
-
return
|
|
156
|
+
return invokeFetch(namespace, {
|
|
157
157
|
method,
|
|
158
158
|
pathTemplate,
|
|
159
159
|
pathVariables,
|
|
@@ -249,7 +249,7 @@ var audits = apiDefToApi("audits", {
|
|
|
249
249
|
}
|
|
250
250
|
}
|
|
251
251
|
});
|
|
252
|
-
var auth =
|
|
252
|
+
var auth = auth_default;
|
|
253
253
|
var automations = apiDefToApi("automations", {
|
|
254
254
|
api: {
|
|
255
255
|
v1: {
|
|
@@ -496,7 +496,7 @@ var licenses = apiDefToApi("licenses", {
|
|
|
496
496
|
}
|
|
497
497
|
}
|
|
498
498
|
});
|
|
499
|
-
var qix =
|
|
499
|
+
var qix = qix_default;
|
|
500
500
|
var quotas = apiDefToApi("quotas", {
|
|
501
501
|
api: { v1: { quotas: { "": ["getQuotas:GQ:"], "{id}": ["getQuota:GQ:"] } } }
|
|
502
502
|
});
|
|
@@ -679,38 +679,38 @@ var api = {
|
|
|
679
679
|
webhooks
|
|
680
680
|
};
|
|
681
681
|
var public_default = api;
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
682
|
+
export {
|
|
683
|
+
apiKeys,
|
|
684
|
+
apps,
|
|
685
|
+
audits,
|
|
686
|
+
auth,
|
|
687
|
+
automations,
|
|
688
|
+
brands,
|
|
689
|
+
collections,
|
|
690
|
+
cspOrigins,
|
|
691
|
+
dataAssets,
|
|
692
|
+
dataConnections,
|
|
693
|
+
dataCredentials,
|
|
694
|
+
dataFiles,
|
|
695
|
+
public_default as default,
|
|
696
|
+
extensions,
|
|
697
|
+
glossaries,
|
|
698
|
+
groups,
|
|
699
|
+
identityProviders,
|
|
700
|
+
items,
|
|
701
|
+
licenses,
|
|
702
|
+
qix,
|
|
703
|
+
quotas,
|
|
704
|
+
reloadTasks,
|
|
705
|
+
reloads,
|
|
706
|
+
roles,
|
|
707
|
+
spaces,
|
|
708
|
+
tempContents,
|
|
709
|
+
tenants,
|
|
710
|
+
themes,
|
|
711
|
+
transports,
|
|
712
|
+
users,
|
|
713
|
+
webIntegrations,
|
|
714
|
+
webNotifications,
|
|
715
|
+
webhooks
|
|
716
|
+
};
|