@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.mjs
DELETED
|
@@ -1,88 +0,0 @@
|
|
|
1
|
-
import {
|
|
2
|
-
clearApiCache,
|
|
3
|
-
invokeFetch
|
|
4
|
-
} from "./chunks/3YV6X7S6.mjs";
|
|
5
|
-
import "./chunks/EHAANYDL.mjs";
|
|
6
|
-
import "./chunks/VSY5YIQY.mjs";
|
|
7
|
-
|
|
8
|
-
// src/public/rest/groups.ts
|
|
9
|
-
var getGroups = async (query, options) => invokeFetch("groups", {
|
|
10
|
-
method: "get",
|
|
11
|
-
pathTemplate: "/api/v1/groups",
|
|
12
|
-
query,
|
|
13
|
-
options
|
|
14
|
-
});
|
|
15
|
-
var createGroup = async (body, options) => invokeFetch("groups", {
|
|
16
|
-
method: "post",
|
|
17
|
-
pathTemplate: "/api/v1/groups",
|
|
18
|
-
body,
|
|
19
|
-
contentType: "application/json",
|
|
20
|
-
options
|
|
21
|
-
});
|
|
22
|
-
var filterGroups = async (query, body, options) => invokeFetch("groups", {
|
|
23
|
-
method: "post",
|
|
24
|
-
pathTemplate: "/api/v1/groups/actions/filter",
|
|
25
|
-
query,
|
|
26
|
-
body,
|
|
27
|
-
contentType: "application/json",
|
|
28
|
-
options
|
|
29
|
-
});
|
|
30
|
-
var getGroupsSettings = async (options) => invokeFetch("groups", {
|
|
31
|
-
method: "get",
|
|
32
|
-
pathTemplate: "/api/v1/groups/settings",
|
|
33
|
-
options
|
|
34
|
-
});
|
|
35
|
-
var patchGroupsSettings = async (body, options) => invokeFetch("groups", {
|
|
36
|
-
method: "patch",
|
|
37
|
-
pathTemplate: "/api/v1/groups/settings",
|
|
38
|
-
body,
|
|
39
|
-
contentType: "application/json",
|
|
40
|
-
options
|
|
41
|
-
});
|
|
42
|
-
var deleteGroup = async (groupId, options) => invokeFetch("groups", {
|
|
43
|
-
method: "delete",
|
|
44
|
-
pathTemplate: "/api/v1/groups/{groupId}",
|
|
45
|
-
pathVariables: { groupId },
|
|
46
|
-
options
|
|
47
|
-
});
|
|
48
|
-
var getGroup = async (groupId, options) => invokeFetch("groups", {
|
|
49
|
-
method: "get",
|
|
50
|
-
pathTemplate: "/api/v1/groups/{groupId}",
|
|
51
|
-
pathVariables: { groupId },
|
|
52
|
-
options
|
|
53
|
-
});
|
|
54
|
-
var patchGroup = async (groupId, body, options) => invokeFetch("groups", {
|
|
55
|
-
method: "patch",
|
|
56
|
-
pathTemplate: "/api/v1/groups/{groupId}",
|
|
57
|
-
pathVariables: { groupId },
|
|
58
|
-
body,
|
|
59
|
-
contentType: "application/json",
|
|
60
|
-
options
|
|
61
|
-
});
|
|
62
|
-
function clearCache() {
|
|
63
|
-
return clearApiCache("groups");
|
|
64
|
-
}
|
|
65
|
-
var groupsExport = {
|
|
66
|
-
getGroups,
|
|
67
|
-
createGroup,
|
|
68
|
-
filterGroups,
|
|
69
|
-
getGroupsSettings,
|
|
70
|
-
patchGroupsSettings,
|
|
71
|
-
deleteGroup,
|
|
72
|
-
getGroup,
|
|
73
|
-
patchGroup,
|
|
74
|
-
clearCache
|
|
75
|
-
};
|
|
76
|
-
var groups_default = groupsExport;
|
|
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.mts
DELETED
|
@@ -1,550 +0,0 @@
|
|
|
1
|
-
import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
|
|
2
|
-
import './auth-types-nnUcWhuU.mjs';
|
|
3
|
-
|
|
4
|
-
type BaseIDP = {
|
|
5
|
-
/** Indicates whether the IdP is available for use. */
|
|
6
|
-
active?: boolean;
|
|
7
|
-
clockToleranceSec?: number;
|
|
8
|
-
/** When the flag is true, new users should be created when logging in for the first time. */
|
|
9
|
-
createNewUsersOnLogin?: boolean;
|
|
10
|
-
/** The timestamp for when the IdP was created. */
|
|
11
|
-
created?: string;
|
|
12
|
-
description?: string;
|
|
13
|
-
/** The unique identifier for the IdP. */
|
|
14
|
-
id?: string;
|
|
15
|
-
/** Indicates the type of connection with the IdP, either interactive login or a machine to machine connection. */
|
|
16
|
-
interactive?: boolean;
|
|
17
|
-
/** The timestamp for when the IdP was last updated. */
|
|
18
|
-
lastUpdated?: string;
|
|
19
|
-
meta?: unknown;
|
|
20
|
-
/** Direct the user on logout to a specific URI. */
|
|
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`. */
|
|
23
|
-
protocol?: IDPProtocol;
|
|
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
|
-
provider?: IDPProvider;
|
|
26
|
-
/** The tenant identifiers associated with the given IdP. */
|
|
27
|
-
tenantIds?: string[];
|
|
28
|
-
};
|
|
29
|
-
/**
|
|
30
|
-
* Payload for creating an identity provider using JWT authentication.
|
|
31
|
-
*/
|
|
32
|
-
type CreateJWTAuthPayload = {
|
|
33
|
-
/** 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. */
|
|
34
|
-
clockToleranceSec?: number;
|
|
35
|
-
description?: string;
|
|
36
|
-
/** Required IdP configurations. */
|
|
37
|
-
options: {
|
|
38
|
-
/** The JWT issuer. */
|
|
39
|
-
issuer: string;
|
|
40
|
-
/** Keys for verifying JWTs. Limited to 1 key per identity provider. */
|
|
41
|
-
staticKeys: {
|
|
42
|
-
/** Key ID used to sign the JWTs. */
|
|
43
|
-
kid: string;
|
|
44
|
-
/** Pem-encoded public key for verifying the JWTs. */
|
|
45
|
-
pem: string;
|
|
46
|
-
}[];
|
|
47
|
-
};
|
|
48
|
-
/** The protocol to be used for communicating with the identity provider. */
|
|
49
|
-
protocol: "jwtAuth";
|
|
50
|
-
/** The identity provider to be used. */
|
|
51
|
-
provider: "external";
|
|
52
|
-
/** The tenant identifiers that map to the given IdP. */
|
|
53
|
-
tenantIds?: string[];
|
|
54
|
-
};
|
|
55
|
-
/**
|
|
56
|
-
* Payload for creating an OIDC-compatible identity provider.
|
|
57
|
-
*/
|
|
58
|
-
type CreateOIDCPayload = {
|
|
59
|
-
/** 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. */
|
|
60
|
-
clockToleranceSec?: number;
|
|
61
|
-
/** Tells the consumer of the IdP that new users should be created on login if they don't exist. */
|
|
62
|
-
createNewUsersOnLogin?: boolean;
|
|
63
|
-
description?: string;
|
|
64
|
-
/** Indicates whether the IdP is meant for interactive login. */
|
|
65
|
-
interactive: boolean;
|
|
66
|
-
/** Required OIDC configurations for non-interactive IdPs and interactive IdPs with `skipVerify` flag enabled. */
|
|
67
|
-
options?: {
|
|
68
|
-
/** Only clients with IDs in this list will be allowed API access. A blank list or empty value means any client IDs authenticated against the IdP will be allowed access. */
|
|
69
|
-
allowedClientIds?: string[];
|
|
70
|
-
/** Allows for setting audience in access tokens. */
|
|
71
|
-
audience?: string;
|
|
72
|
-
/** 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. */
|
|
73
|
-
claimsMapping: ClaimsMappingNonInteractive;
|
|
74
|
-
/** The OpenID configuration endpoint. (Ex: https://<domain>/.well-known/openid-configuration). Required if openid_configuration is not given. */
|
|
75
|
-
discoveryUrl?: string;
|
|
76
|
-
/** OpenID configuration */
|
|
77
|
-
openid_configuration?: OpenIDConfiguration;
|
|
78
|
-
/** The realm identifier for the IdP. */
|
|
79
|
-
realm?: string;
|
|
80
|
-
};
|
|
81
|
-
/** Required OIDC configurations for interactive IdPs that require verification. */
|
|
82
|
-
pendingOptions?: {
|
|
83
|
-
/** When true, the `offline_access` scope will not be requested from the IdP where applicable. */
|
|
84
|
-
blockOfflineAccessScope?: boolean;
|
|
85
|
-
/** 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. */
|
|
86
|
-
claimsMapping: ClaimsMappingInteractive;
|
|
87
|
-
/** The client identifier used as part of authenticating an interactive identity provider. */
|
|
88
|
-
clientId: string;
|
|
89
|
-
/** The client secret used as part of authenticating an interactive identity provider. */
|
|
90
|
-
clientSecret: string;
|
|
91
|
-
/** The OpenID configuration endpoint. (Ex: https://<domain>/.well-known/openid-configuration). Required if openid_configuration is not given. */
|
|
92
|
-
discoveryUrl?: string;
|
|
93
|
-
/** Only ADFS and AzureAD IdPs can set this property. For ADFS and AzureAD, it defaults to false. For other IdPs, it defaults to undefined. */
|
|
94
|
-
emailVerifiedAlwaysTrue?: boolean;
|
|
95
|
-
/** OpenID configuration */
|
|
96
|
-
openid_configuration?: OpenIDConfiguration;
|
|
97
|
-
/** The realm identifier for the IdP. */
|
|
98
|
-
realm?: string;
|
|
99
|
-
/** Scope which will be sent along with token requests to the IdP. Scopes should be space delimited. Will default to certain values depending on the IdP provider. */
|
|
100
|
-
scope?: string;
|
|
101
|
-
/** If true, will use the claims from the ID token. By default it is set to true for ADFS and AzureAD. */
|
|
102
|
-
useClaimsFromIdToken?: boolean;
|
|
103
|
-
};
|
|
104
|
-
/** Direct the user on logout to a specific URI. */
|
|
105
|
-
postLogoutRedirectUri?: string;
|
|
106
|
-
/** The protocol to be used for communicating with the identity provider. */
|
|
107
|
-
protocol: "OIDC";
|
|
108
|
-
/** The identity provider to be used. */
|
|
109
|
-
provider: "auth0" | "okta" | "generic" | "salesforce" | "keycloak" | "adfs" | "azureAD";
|
|
110
|
-
/** If set to `true`, skips IdP verification process and assumes the IdP is verified. */
|
|
111
|
-
skipVerify?: boolean;
|
|
112
|
-
/** The tenant identifiers that map to the given IdP. */
|
|
113
|
-
tenantIds?: string[];
|
|
114
|
-
};
|
|
115
|
-
/**
|
|
116
|
-
* An error object.
|
|
117
|
-
*/
|
|
118
|
-
type Error = {
|
|
119
|
-
/** The error code. */
|
|
120
|
-
code: string;
|
|
121
|
-
/** A human-readable explanation specific to this occurrence of the problem. */
|
|
122
|
-
detail?: string;
|
|
123
|
-
/** Additional properties relating to the error. */
|
|
124
|
-
meta?: unknown;
|
|
125
|
-
/** References to the source of the error. */
|
|
126
|
-
source?: {
|
|
127
|
-
/** The URI query parameter that caused the error. */
|
|
128
|
-
parameter?: string;
|
|
129
|
-
/** A JSON pointer to the property that caused the error. */
|
|
130
|
-
pointer?: string;
|
|
131
|
-
};
|
|
132
|
-
/** The HTTP status code. */
|
|
133
|
-
status?: number;
|
|
134
|
-
/** Summary of the problem. */
|
|
135
|
-
title: string;
|
|
136
|
-
};
|
|
137
|
-
/**
|
|
138
|
-
* A representation of the errors encountered from the HTTP request.
|
|
139
|
-
*/
|
|
140
|
-
type Errors = {
|
|
141
|
-
errors?: Error[];
|
|
142
|
-
};
|
|
143
|
-
type IDP = IDPOIDC | IDPJWTAuth;
|
|
144
|
-
type IDPArray = {
|
|
145
|
-
/** An array of IdPs. */
|
|
146
|
-
data?: IDP[];
|
|
147
|
-
/** Contains pagination links. */
|
|
148
|
-
links?: Links;
|
|
149
|
-
};
|
|
150
|
-
/**
|
|
151
|
-
* An identity provider for JWT authentication.
|
|
152
|
-
*/
|
|
153
|
-
type IDPJWTAuth = BaseIDP & {
|
|
154
|
-
options?: {
|
|
155
|
-
/** The expected JWT issuer */
|
|
156
|
-
issuer?: string;
|
|
157
|
-
staticKeys?: {
|
|
158
|
-
/** Key ID used to sign the JWTs. */
|
|
159
|
-
kid?: string;
|
|
160
|
-
/** Pem-encoded public key for verifying the JWTs. */
|
|
161
|
-
pem?: string;
|
|
162
|
-
}[];
|
|
163
|
-
};
|
|
164
|
-
};
|
|
165
|
-
type IDPMeta = {
|
|
166
|
-
/** A link to direct you to where you can upgrade your trial or manage your subscriptions. Only available if the default identity provider is used (no custom interactive identity providers are active). */
|
|
167
|
-
upgradeSubscriptionLink?: string;
|
|
168
|
-
/** 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). */
|
|
169
|
-
userPortalLink?: string;
|
|
170
|
-
};
|
|
171
|
-
/**
|
|
172
|
-
* An OIDC-compliant identity provider.
|
|
173
|
-
*/
|
|
174
|
-
type IDPOIDC = BaseIDP & {
|
|
175
|
-
options?: IDPOptions;
|
|
176
|
-
pendingOptions?: IDPOptions;
|
|
177
|
-
pendingResult?: PendingResult;
|
|
178
|
-
/** The state of pendingOptions. This represents the latest IdP test result. */
|
|
179
|
-
pendingState?: "verified" | "pending" | "error";
|
|
180
|
-
};
|
|
181
|
-
type IDPOptions = {
|
|
182
|
-
/** If true, the `offline_access` scope will not be requested from the IdP, where applicable. */
|
|
183
|
-
blockOfflineAccessScope?: boolean;
|
|
184
|
-
/** 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. */
|
|
185
|
-
claimsMapping?: ClaimsMappingInteractive;
|
|
186
|
-
/** The client identifier used as part of authenticating an interactive identity provider. */
|
|
187
|
-
clientId?: string;
|
|
188
|
-
/** The client secret used as part of authenticating an interactive identity provider. */
|
|
189
|
-
clientSecret?: string;
|
|
190
|
-
/** The OpenID configuration endpoint. (Ex: https://<domain>/.well-known/openid-configuration). */
|
|
191
|
-
discoveryUrl?: string;
|
|
192
|
-
/** Determines if email_verified should be always true. This field is only used in ADFS and AzureAD IdPs. */
|
|
193
|
-
emailVerifiedAlwaysTrue?: boolean;
|
|
194
|
-
/** This field is only used in Qlik Sense Enterprise Client-Managed IdPs. */
|
|
195
|
-
issuer?: string;
|
|
196
|
-
/** OpenID configuration */
|
|
197
|
-
openid_configuration?: OpenIDConfiguration;
|
|
198
|
-
/** The realm identifier for the IdP. */
|
|
199
|
-
realm?: string;
|
|
200
|
-
/** Scope that will be sent along with token requests to the IdP. */
|
|
201
|
-
scope?: string;
|
|
202
|
-
};
|
|
203
|
-
type IDPPatchSchema = PatchOIDCPayload[] | PatchJWTAuthPayload[];
|
|
204
|
-
type IDPPostSchema = CreateOIDCPayload | CreateJWTAuthPayload;
|
|
205
|
-
/**
|
|
206
|
-
* The protocol to be used for communicating with the identity provider. Valid values are `OIDC`, `jwtAuth`, and `qsefw-local-bearer-token`.
|
|
207
|
-
*/
|
|
208
|
-
type IDPProtocol = "OIDC" | "jwtAuth" | "qsefw-local-bearer-token";
|
|
209
|
-
/**
|
|
210
|
-
* 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
|
-
*/
|
|
212
|
-
type IDPProvider = "auth0" | "okta" | "qlik" | "generic" | "salesforce" | "keycloak" | "adfs" | "external" | "azureAD";
|
|
213
|
-
type IDPsStatus = {
|
|
214
|
-
/** The number of active interactive IdPs. */
|
|
215
|
-
active_interactive_idps_count?: number;
|
|
216
|
-
/** A list of IdP metadata. */
|
|
217
|
-
idps_metadata?: {
|
|
218
|
-
/** Indicates whether the IdP is available for use. */
|
|
219
|
-
active?: boolean;
|
|
220
|
-
/** Indicates whether the IdP is meant for interactive login. */
|
|
221
|
-
interactive?: boolean;
|
|
222
|
-
/** 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`. */
|
|
223
|
-
provider?: IDPProvider;
|
|
224
|
-
}[];
|
|
225
|
-
};
|
|
226
|
-
/**
|
|
227
|
-
* Contains pagination links.
|
|
228
|
-
*/
|
|
229
|
-
type Links = {
|
|
230
|
-
next?: {
|
|
231
|
-
/** Link to the next page of items. */
|
|
232
|
-
href?: string;
|
|
233
|
-
};
|
|
234
|
-
prev?: {
|
|
235
|
-
/** Link to the previous page of items. */
|
|
236
|
-
href?: string;
|
|
237
|
-
};
|
|
238
|
-
self?: {
|
|
239
|
-
/** Link to the current page of items. */
|
|
240
|
-
href?: string;
|
|
241
|
-
};
|
|
242
|
-
};
|
|
243
|
-
/**
|
|
244
|
-
* OpenID configuration
|
|
245
|
-
*/
|
|
246
|
-
type OpenIDConfiguration = {
|
|
247
|
-
/** OAuth 2.0 Authorization Endpoint */
|
|
248
|
-
authorization_endpoint: string;
|
|
249
|
-
/** URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP. */
|
|
250
|
-
end_session_endpoint?: string;
|
|
251
|
-
/** The introspection endpoint is an OAuth 2.0 endpoint that takes a parameter representing an OAuth 2.0 token and returns a JSON [RFC7159] document representing the meta information. */
|
|
252
|
-
introspection_endpoint?: string;
|
|
253
|
-
/** OpenID Provider issuer */
|
|
254
|
-
issuer: string;
|
|
255
|
-
/** URL of the OP's JSON Web Key Set [JWK] document */
|
|
256
|
-
jwks_uri: string;
|
|
257
|
-
/** OAuth 2.0 Token Endpoint */
|
|
258
|
-
token_endpoint: string;
|
|
259
|
-
/** URL of the OP's UserInfo Endpoint */
|
|
260
|
-
userinfo_endpoint?: string;
|
|
261
|
-
};
|
|
262
|
-
/**
|
|
263
|
-
* A patch request for an identity provider using the `jwtAuth` protocol.
|
|
264
|
-
*/
|
|
265
|
-
type PatchJWTAuthPayload = {
|
|
266
|
-
/** The "operation" to be performed on a given IdP. */
|
|
267
|
-
op: "replace";
|
|
268
|
-
/** The "path" to the part of the IdP document. */
|
|
269
|
-
path?: "/description";
|
|
270
|
-
/** The "value" data type is dependent on the path value being used. */
|
|
271
|
-
value?: unknown;
|
|
272
|
-
};
|
|
273
|
-
/**
|
|
274
|
-
* A patch request for an identity provider using the `OIDC` protocol.
|
|
275
|
-
*/
|
|
276
|
-
type PatchOIDCPayload = {
|
|
277
|
-
/** 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. */
|
|
278
|
-
op: "replace" | "promote-options";
|
|
279
|
-
/** The "path" to the part of the IdP document. */
|
|
280
|
-
path?: "/active" | "/description" | "/meta" | "/options" | "/options/realm" | "/options/discoveryUrl" | "/options/claimsMapping" | "/pendingOptions" | "/pendingOptions/realm" | "/pendingOptions/discoveryUrl" | "/pendingOptions/clientId" | "/pendingOptions/clientSecret" | "/pendingOptions/emailVerifiedAlwaysTrue" | "/pendingOptions/claimsMapping" | "/postLogoutRedirectUri" | "/clockToleranceSec";
|
|
281
|
-
/** The "value" data type is dependent on the path value being used. */
|
|
282
|
-
value?: unknown;
|
|
283
|
-
};
|
|
284
|
-
type PendingResult = {
|
|
285
|
-
/** A unique readable error message based on the error that has occurred. */
|
|
286
|
-
error?: string;
|
|
287
|
-
/** The claims retrieved from the external IdP. */
|
|
288
|
-
idpClaims?: unknown;
|
|
289
|
-
oauth2Error?: {
|
|
290
|
-
/** An error code to identity the authentication error. */
|
|
291
|
-
error: string;
|
|
292
|
-
/** An optional human-readable description for the given error code. */
|
|
293
|
-
errorDescription?: string;
|
|
294
|
-
/** An optional URI that includes additional information about the given error. */
|
|
295
|
-
errorURI?: string;
|
|
296
|
-
};
|
|
297
|
-
/** The resultant claims based on the claims received from the external IdP. */
|
|
298
|
-
resultantClaims?: unknown;
|
|
299
|
-
/** The timestamp for when the test was started for an IdP configuration. This field is only available during lifespan of the test. */
|
|
300
|
-
started?: string;
|
|
301
|
-
/** The status of the IdP configuration being tested. */
|
|
302
|
-
status: "success" | "pending" | "error" | "claimsError" | "callbackError" | "tokenError" | "protocolError" | "networkError" | "configChangedDuringTestError";
|
|
303
|
-
};
|
|
304
|
-
/**
|
|
305
|
-
* 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
|
-
*/
|
|
307
|
-
type ClaimsMappingInteractive = {
|
|
308
|
-
/** A list of JSON pointers used to map the user's client ID. */
|
|
309
|
-
client_id?: string[];
|
|
310
|
-
/** A list of JSON pointers used to map the user's email. */
|
|
311
|
-
email?: string[];
|
|
312
|
-
/** A list of JSON pointers used to map the user's email_verified claim. */
|
|
313
|
-
email_verified?: string[];
|
|
314
|
-
/** A list of JSON pointers used to map the user's groups. */
|
|
315
|
-
groups?: string[];
|
|
316
|
-
/** A list of JSON pointers used to map the user's locale. */
|
|
317
|
-
locale?: string[];
|
|
318
|
-
/** A list of JSON pointers used to map the user's name. */
|
|
319
|
-
name?: string[];
|
|
320
|
-
/** A list of JSON pointers used to map the user's picture. */
|
|
321
|
-
picture?: string[];
|
|
322
|
-
/** A list of JSON pointers used to map the user's subject. */
|
|
323
|
-
sub?: string[];
|
|
324
|
-
/** A list of JSON pointers used to map the user's zoneinfo. */
|
|
325
|
-
zoneinfo?: string[];
|
|
326
|
-
};
|
|
327
|
-
/**
|
|
328
|
-
* 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.
|
|
329
|
-
*/
|
|
330
|
-
type ClaimsMappingNonInteractive = {
|
|
331
|
-
/** A list of JSON pointers used to map the user's client ID. */
|
|
332
|
-
client_id?: string[];
|
|
333
|
-
/** A list of JSON pointers used to map the user's subject. */
|
|
334
|
-
sub?: string[];
|
|
335
|
-
};
|
|
336
|
-
/**
|
|
337
|
-
* 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
|
-
*
|
|
339
|
-
* @param query an object with query parameters
|
|
340
|
-
* @throws GetIdpsHttpError
|
|
341
|
-
*/
|
|
342
|
-
declare const getIdps: (query: {
|
|
343
|
-
/** If provided, filters the results by the active field. */
|
|
344
|
-
active?: boolean;
|
|
345
|
-
/** The number of IdP entries to retrieve. */
|
|
346
|
-
limit?: number;
|
|
347
|
-
/** The next page cursor. */
|
|
348
|
-
next?: string;
|
|
349
|
-
/** The previous page cursor. */
|
|
350
|
-
prev?: string;
|
|
351
|
-
}, options?: ApiCallOptions) => Promise<GetIdpsHttpResponse>;
|
|
352
|
-
type GetIdpsHttpResponse = {
|
|
353
|
-
data: IDPArray;
|
|
354
|
-
headers: Headers;
|
|
355
|
-
status: number;
|
|
356
|
-
prev?: (options?: ApiCallOptions) => Promise<GetIdpsHttpResponse>;
|
|
357
|
-
next?: (options?: ApiCallOptions) => Promise<GetIdpsHttpResponse>;
|
|
358
|
-
};
|
|
359
|
-
type GetIdpsHttpError = {
|
|
360
|
-
data: Errors;
|
|
361
|
-
headers: Headers;
|
|
362
|
-
status: number;
|
|
363
|
-
};
|
|
364
|
-
/**
|
|
365
|
-
* 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.
|
|
366
|
-
*
|
|
367
|
-
* @param body an object with the body content
|
|
368
|
-
* @throws CreateIdpHttpError
|
|
369
|
-
*/
|
|
370
|
-
declare const createIdp: (body: IDPPostSchema, options?: ApiCallOptions) => Promise<CreateIdpHttpResponse>;
|
|
371
|
-
type CreateIdpHttpResponse = {
|
|
372
|
-
data: IDP;
|
|
373
|
-
headers: Headers;
|
|
374
|
-
status: number;
|
|
375
|
-
};
|
|
376
|
-
type CreateIdpHttpError = {
|
|
377
|
-
data: Errors;
|
|
378
|
-
headers: Headers;
|
|
379
|
-
status: number;
|
|
380
|
-
};
|
|
381
|
-
/**
|
|
382
|
-
* This endpoint retrieves identity providers' metadata.
|
|
383
|
-
*
|
|
384
|
-
* @throws GetIdpWellKnownMetaDataHttpError
|
|
385
|
-
*/
|
|
386
|
-
declare const getIdpWellKnownMetaData: (options?: ApiCallOptions) => Promise<GetIdpWellKnownMetaDataHttpResponse>;
|
|
387
|
-
type GetIdpWellKnownMetaDataHttpResponse = {
|
|
388
|
-
data: unknown;
|
|
389
|
-
headers: Headers;
|
|
390
|
-
status: number;
|
|
391
|
-
};
|
|
392
|
-
type GetIdpWellKnownMetaDataHttpError = {
|
|
393
|
-
data: unknown;
|
|
394
|
-
headers: Headers;
|
|
395
|
-
status: number;
|
|
396
|
-
};
|
|
397
|
-
/**
|
|
398
|
-
* Returns the active interactive IdP metadata
|
|
399
|
-
*
|
|
400
|
-
* @throws GetMyIdpMetaHttpError
|
|
401
|
-
*/
|
|
402
|
-
declare const getMyIdpMeta: (options?: ApiCallOptions) => Promise<GetMyIdpMetaHttpResponse>;
|
|
403
|
-
type GetMyIdpMetaHttpResponse = {
|
|
404
|
-
data: IDPMeta;
|
|
405
|
-
headers: Headers;
|
|
406
|
-
status: number;
|
|
407
|
-
};
|
|
408
|
-
type GetMyIdpMetaHttpError = {
|
|
409
|
-
data: Errors;
|
|
410
|
-
headers: Headers;
|
|
411
|
-
status: number;
|
|
412
|
-
};
|
|
413
|
-
/**
|
|
414
|
-
* This endpoint retrieves the status of IdP configurations. Requires TenantAdmin role.
|
|
415
|
-
*
|
|
416
|
-
* @throws GetIdpStatusesHttpError
|
|
417
|
-
*/
|
|
418
|
-
declare const getIdpStatuses: (options?: ApiCallOptions) => Promise<GetIdpStatusesHttpResponse>;
|
|
419
|
-
type GetIdpStatusesHttpResponse = {
|
|
420
|
-
data: IDPsStatus;
|
|
421
|
-
headers: Headers;
|
|
422
|
-
status: number;
|
|
423
|
-
};
|
|
424
|
-
type GetIdpStatusesHttpError = {
|
|
425
|
-
data: Errors;
|
|
426
|
-
headers: Headers;
|
|
427
|
-
status: number;
|
|
428
|
-
};
|
|
429
|
-
/**
|
|
430
|
-
* 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.
|
|
431
|
-
*
|
|
432
|
-
* @param id The identity provider ID.
|
|
433
|
-
* @throws DeleteIdpHttpError
|
|
434
|
-
*/
|
|
435
|
-
declare const deleteIdp: (id: string, options?: ApiCallOptions) => Promise<DeleteIdpHttpResponse>;
|
|
436
|
-
type DeleteIdpHttpResponse = {
|
|
437
|
-
data: void;
|
|
438
|
-
headers: Headers;
|
|
439
|
-
status: number;
|
|
440
|
-
};
|
|
441
|
-
type DeleteIdpHttpError = {
|
|
442
|
-
data: Errors;
|
|
443
|
-
headers: Headers;
|
|
444
|
-
status: number;
|
|
445
|
-
};
|
|
446
|
-
/**
|
|
447
|
-
* 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.
|
|
448
|
-
*
|
|
449
|
-
* @param id The identity provider ID.
|
|
450
|
-
* @throws GetIdpHttpError
|
|
451
|
-
*/
|
|
452
|
-
declare const getIdp: (id: string, options?: ApiCallOptions) => Promise<GetIdpHttpResponse>;
|
|
453
|
-
type GetIdpHttpResponse = {
|
|
454
|
-
data: IDP;
|
|
455
|
-
headers: Headers;
|
|
456
|
-
status: number;
|
|
457
|
-
};
|
|
458
|
-
type GetIdpHttpError = {
|
|
459
|
-
data: Errors;
|
|
460
|
-
headers: Headers;
|
|
461
|
-
status: number;
|
|
462
|
-
};
|
|
463
|
-
/**
|
|
464
|
-
* 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.
|
|
465
|
-
*
|
|
466
|
-
* @param id The identity provider ID.
|
|
467
|
-
* @param body an object with the body content
|
|
468
|
-
* @throws PatchIdpHttpError
|
|
469
|
-
*/
|
|
470
|
-
declare const patchIdp: (id: string, body: IDPPatchSchema, options?: ApiCallOptions) => Promise<PatchIdpHttpResponse>;
|
|
471
|
-
type PatchIdpHttpResponse = {
|
|
472
|
-
data: void;
|
|
473
|
-
headers: Headers;
|
|
474
|
-
status: number;
|
|
475
|
-
};
|
|
476
|
-
type PatchIdpHttpError = {
|
|
477
|
-
data: Errors;
|
|
478
|
-
headers: Headers;
|
|
479
|
-
status: number;
|
|
480
|
-
};
|
|
481
|
-
/**
|
|
482
|
-
* Clears the cache for identity-providers api requests.
|
|
483
|
-
*/
|
|
484
|
-
declare function clearCache(): void;
|
|
485
|
-
interface IdentityProvidersAPI {
|
|
486
|
-
/**
|
|
487
|
-
* This endpoint retrieves one or more identity providers from the service. The tenantID in the JWT will be used to fetch the identity provider.
|
|
488
|
-
*
|
|
489
|
-
* @param query an object with query parameters
|
|
490
|
-
* @throws GetIdpsHttpError
|
|
491
|
-
*/
|
|
492
|
-
getIdps: typeof getIdps;
|
|
493
|
-
/**
|
|
494
|
-
* 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.
|
|
495
|
-
*
|
|
496
|
-
* @param body an object with the body content
|
|
497
|
-
* @throws CreateIdpHttpError
|
|
498
|
-
*/
|
|
499
|
-
createIdp: typeof createIdp;
|
|
500
|
-
/**
|
|
501
|
-
* This endpoint retrieves identity providers' metadata.
|
|
502
|
-
*
|
|
503
|
-
* @throws GetIdpWellKnownMetaDataHttpError
|
|
504
|
-
*/
|
|
505
|
-
getIdpWellKnownMetaData: typeof getIdpWellKnownMetaData;
|
|
506
|
-
/**
|
|
507
|
-
* Returns the active interactive IdP metadata
|
|
508
|
-
*
|
|
509
|
-
* @throws GetMyIdpMetaHttpError
|
|
510
|
-
*/
|
|
511
|
-
getMyIdpMeta: typeof getMyIdpMeta;
|
|
512
|
-
/**
|
|
513
|
-
* This endpoint retrieves the status of IdP configurations. Requires TenantAdmin role.
|
|
514
|
-
*
|
|
515
|
-
* @throws GetIdpStatusesHttpError
|
|
516
|
-
*/
|
|
517
|
-
getIdpStatuses: typeof getIdpStatuses;
|
|
518
|
-
/**
|
|
519
|
-
* 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.
|
|
520
|
-
*
|
|
521
|
-
* @param id The identity provider ID.
|
|
522
|
-
* @throws DeleteIdpHttpError
|
|
523
|
-
*/
|
|
524
|
-
deleteIdp: typeof deleteIdp;
|
|
525
|
-
/**
|
|
526
|
-
* 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.
|
|
527
|
-
*
|
|
528
|
-
* @param id The identity provider ID.
|
|
529
|
-
* @throws GetIdpHttpError
|
|
530
|
-
*/
|
|
531
|
-
getIdp: typeof getIdp;
|
|
532
|
-
/**
|
|
533
|
-
* 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.
|
|
534
|
-
*
|
|
535
|
-
* @param id The identity provider ID.
|
|
536
|
-
* @param body an object with the body content
|
|
537
|
-
* @throws PatchIdpHttpError
|
|
538
|
-
*/
|
|
539
|
-
patchIdp: typeof patchIdp;
|
|
540
|
-
/**
|
|
541
|
-
* Clears the cache for identity-providers api requests.
|
|
542
|
-
*/
|
|
543
|
-
clearCache: typeof clearCache;
|
|
544
|
-
}
|
|
545
|
-
/**
|
|
546
|
-
* Functions for the identity-providers api
|
|
547
|
-
*/
|
|
548
|
-
declare const identityProvidersExport: IdentityProvidersAPI;
|
|
549
|
-
|
|
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 };
|