@qlik/api 2.2.0 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/analytics/change-stores.d.ts +386 -0
- package/analytics/change-stores.js +123 -0
- package/analytics.d.ts +14 -0
- package/analytics.js +13 -0
- package/api-keys.d.ts +362 -3
- package/api-keys.js +2 -3
- package/apps.d.ts +2673 -3
- package/apps.js +2 -3
- package/assistants.d.ts +1370 -3
- package/assistants.js +2 -3
- package/audits.d.ts +318 -3
- package/audits.js +4 -4
- package/auth-types.d.ts +1 -1
- package/auth-types.js +1 -2
- package/auth.d.ts +94 -2
- package/auth.js +63 -3
- package/automation-connections.d.ts +366 -3
- package/automation-connections.js +2 -3
- package/automation-connectors.d.ts +84 -3
- package/automation-connectors.js +2 -3
- package/automations.d.ts +805 -3
- package/automations.js +2 -3
- package/automl-deployments.d.ts +101 -3
- package/automl-deployments.js +2 -3
- package/automl-predictions.d.ts +238 -3
- package/automl-predictions.js +2 -3
- package/banners.d.ts +184 -3
- package/banners.js +2 -3
- package/brands.d.ts +670 -3
- package/brands.js +2 -3
- package/chunks/{auth-Cle0_tmz.js → auth-BowS4SUR.js} +1 -5
- package/chunks/{chunk-EtTptKIv.js → chunk-D3vHIbds.js} +2 -2
- package/chunks/{dist-gXLIqDJW.js → dist-n3iOVn1W.js} +4 -4
- package/chunks/{auth-functions-BmZgZYSs.js → interceptors-DipDBQQ5.js} +258 -54
- package/chunks/{invoke-fetch-PcVIxLW4.js → invoke-fetch-B7lGscuQ.js} +3 -3
- package/chunks/{invoke-fetch-CucBpA1C.js → invoke-fetch-DhdyFZ0F.js} +1 -5
- package/chunks/{public-runtime-modules-Dwjzb3l8.js → public-runtime-modules-QhLPeQr5.js} +7 -7
- package/chunks/{qix-DI5o5XF4.d.ts → qix-CrqXv44x.d.ts} +6 -2
- package/chunks/{qix-DjxuPCX0.js → qix-RCUslia8.js} +11 -10
- package/chunks/{qix-chunk-entrypoint-tmTo-kpa.js → qix-chunk-entrypoint-WAS4NVTf.js} +48 -50
- package/collections.d.ts +582 -3
- package/collections.js +2 -3
- package/conditions.d.ts +662 -3
- package/conditions.js +2 -3
- package/consumption.d.ts +182 -3
- package/consumption.js +2 -3
- package/core/ip-policies.d.ts +328 -4
- package/core/ip-policies.js +108 -5
- package/core.d.ts +13 -4
- package/core.js +3 -4
- package/csp-origins.d.ts +273 -3
- package/csp-origins.js +2 -3
- package/csrf-token.d.ts +62 -3
- package/csrf-token.js +2 -3
- package/data-alerts.d.ts +1004 -3
- package/data-alerts.js +2 -3
- package/data-assets.d.ts +207 -3
- package/data-assets.js +2 -3
- package/data-connections.d.ts +678 -3
- package/data-connections.js +2 -3
- package/data-credentials.d.ts +292 -3
- package/data-credentials.js +2 -3
- package/data-files.d.ts +860 -3
- package/data-files.js +2 -3
- package/data-qualities.d.ts +175 -3
- package/data-qualities.js +2 -3
- package/data-sets.d.ts +424 -3
- package/data-sets.js +2 -3
- package/data-sources.d.ts +348 -3
- package/data-sources.js +2 -3
- package/data-stores.d.ts +537 -3
- package/data-stores.js +2 -3
- package/dcaas.d.ts +192 -3
- package/dcaas.js +2 -3
- package/di-projects.d.ts +812 -4
- package/di-projects.js +25 -4
- package/direct-access-agents.d.ts +710 -4
- package/direct-access-agents.js +37 -5
- package/docs/authentication.md +1 -1
- package/encryption.d.ts +372 -3
- package/encryption.js +2 -3
- package/extensions.d.ts +295 -3
- package/extensions.js +2 -3
- package/global-types.d.ts +1 -1
- package/global-types.js +0 -2
- package/glossaries.d.ts +1223 -3
- package/glossaries.js +2 -3
- package/groups.d.ts +510 -3
- package/groups.js +2 -3
- package/identity-providers.d.ts +711 -3
- package/identity-providers.js +2 -3
- package/index.d.ts +78 -69
- package/index.js +28 -10
- package/interceptors.d.ts +52 -3
- package/interceptors.js +1 -2
- package/invoke-fetch-types.d.ts +1 -1
- package/items.d.ts +536 -3
- package/items.js +2 -3
- package/knowledgebases.d.ts +976 -3
- package/knowledgebases.js +2 -3
- package/licenses.d.ts +663 -3
- package/licenses.js +2 -3
- package/lineage-graphs.d.ts +704 -3
- package/lineage-graphs.js +2 -3
- package/ml.d.ts +2808 -3
- package/ml.js +2 -3
- package/notes.d.ts +110 -3
- package/notes.js +2 -3
- package/notifications.d.ts +98 -3
- package/notifications.js +2 -3
- package/oauth-callback.iife.js +1151 -0
- package/oauth-clients.d.ts +562 -3
- package/oauth-clients.js +2 -3
- package/oauth-tokens.d.ts +126 -3
- package/oauth-tokens.js +2 -3
- package/package.json +6 -4
- package/qix.d.ts +3 -3
- package/qix.js +38 -3
- package/questions.d.ts +364 -3
- package/questions.js +2 -3
- package/quotas.d.ts +112 -3
- package/quotas.js +2 -3
- package/reload-tasks.d.ts +249 -3
- package/reload-tasks.js +2 -3
- package/reloads.d.ts +260 -3
- package/reloads.js +2 -3
- package/report-templates.d.ts +287 -3
- package/report-templates.js +2 -3
- package/reports.d.ts +863 -3
- package/reports.js +2 -3
- package/roles.d.ts +312 -3
- package/roles.js +2 -3
- package/sharing-tasks.d.ts +1164 -3
- package/sharing-tasks.js +2 -3
- package/spaces.d.ts +779 -3
- package/spaces.js +2 -3
- package/tasks.d.ts +564 -3
- package/tasks.js +2 -3
- package/temp-contents.d.ts +167 -3
- package/temp-contents.js +2 -3
- package/tenants.d.ts +360 -3
- package/tenants.js +2 -3
- package/themes.d.ts +270 -3
- package/themes.js +2 -3
- package/transports.d.ts +435 -4
- package/transports.js +20 -5
- package/ui-config.d.ts +274 -3
- package/ui-config.js +2 -3
- package/users.d.ts +674 -3
- package/users.js +2 -3
- package/web-integrations.d.ts +294 -3
- package/web-integrations.js +2 -3
- package/web-notifications.d.ts +273 -3
- package/web-notifications.js +2 -3
- package/webhooks.d.ts +505 -3
- package/webhooks.js +2 -3
- package/chunks/api-keys-D6Rqaov4.d.ts +0 -365
- package/chunks/apps-BwpXUGDb.d.ts +0 -2673
- package/chunks/assistants-wh6Qe7l6.d.ts +0 -1366
- package/chunks/audits-DakwzT97.d.ts +0 -316
- package/chunks/auth-6mptVm5Q.d.ts +0 -95
- package/chunks/auth-D11iO7ZV.js +0 -65
- package/chunks/automation-connections-k2G_n9rj.d.ts +0 -366
- package/chunks/automation-connectors-J5OE-1P0.d.ts +0 -84
- package/chunks/automations-BGy83EBO.d.ts +0 -797
- package/chunks/automl-deployments-CWEpX2pk.d.ts +0 -101
- package/chunks/automl-predictions-BNIjRhBm.d.ts +0 -238
- package/chunks/banners-CgBRnZGv.d.ts +0 -184
- package/chunks/brands-DCgk6Gqx.d.ts +0 -671
- package/chunks/collections-BpYjcpIY.d.ts +0 -582
- package/chunks/conditions-CJJG7Uph.d.ts +0 -662
- package/chunks/consumption-DerFk437.d.ts +0 -182
- package/chunks/core-DQXNZdnf.d.ts +0 -12
- package/chunks/csp-origins-3NJlh_n9.d.ts +0 -273
- package/chunks/csrf-token-DoaoOQzH.d.ts +0 -63
- package/chunks/data-alerts-CILSEFbQ.d.ts +0 -1004
- package/chunks/data-assets-CJDcssoX.d.ts +0 -207
- package/chunks/data-connections-VSB13K6g.d.ts +0 -678
- package/chunks/data-credentials-ChEp_hyU.d.ts +0 -292
- package/chunks/data-files-CVzn9M6V.d.ts +0 -860
- package/chunks/data-qualities-DBrot957.d.ts +0 -176
- package/chunks/data-sets-CFzxgWnO.d.ts +0 -424
- package/chunks/data-sources-IsAaof_C.d.ts +0 -346
- package/chunks/data-stores-DFOPdgfz.d.ts +0 -537
- package/chunks/dcaas-qyv7YlrN.d.ts +0 -192
- package/chunks/di-projects-DVQTxASr.d.ts +0 -777
- package/chunks/direct-access-agents-B77OhzZi.d.ts +0 -580
- package/chunks/encryption-BjA6xbCO.d.ts +0 -372
- package/chunks/extensions-OO0WtInj.d.ts +0 -294
- package/chunks/glossaries-CIX7-KT_.d.ts +0 -1213
- package/chunks/groups-C86-UG7S.d.ts +0 -511
- package/chunks/identity-providers-h0dKNxGZ.d.ts +0 -711
- package/chunks/interceptors-Csx2tEi5.d.ts +0 -52
- package/chunks/interceptors-DTYm37AU.js +0 -104
- package/chunks/ip-policies-CKRIlbP7.d.ts +0 -327
- package/chunks/ip-policies-DXlf172B.js +0 -108
- package/chunks/items-C-jzqvFW.d.ts +0 -536
- package/chunks/knowledgebases-CyQtVcZN.d.ts +0 -977
- package/chunks/licenses-xzjnkitW.d.ts +0 -663
- package/chunks/lineage-graphs-CViCCzKy.d.ts +0 -697
- package/chunks/ml-Abt2MUva.d.ts +0 -2809
- package/chunks/notes-BZxuyDgt.d.ts +0 -111
- package/chunks/notifications-Bd_gp4jU.d.ts +0 -99
- package/chunks/oauth-clients-B5QPr4IM.d.ts +0 -563
- package/chunks/oauth-tokens-1b7V8182.d.ts +0 -127
- package/chunks/qix-CYQsLyGQ.js +0 -40
- package/chunks/questions-BVp0tvNs.d.ts +0 -364
- package/chunks/quotas-CfAebRJd.d.ts +0 -113
- package/chunks/reload-tasks-DfwUTetn.d.ts +0 -249
- package/chunks/reloads-CwmagnFx.d.ts +0 -260
- package/chunks/report-templates-DjQYj5dn.d.ts +0 -287
- package/chunks/reports-DzNC6Uq3.d.ts +0 -861
- package/chunks/roles-BYFIY6E7.d.ts +0 -312
- package/chunks/sharing-tasks-BMGIQ-FO.d.ts +0 -1164
- package/chunks/spaces-BK823t-b.d.ts +0 -780
- package/chunks/tasks-COKDfShO.d.ts +0 -564
- package/chunks/temp-contents-zDomB-g6.d.ts +0 -168
- package/chunks/tenants-Bhn86519.d.ts +0 -361
- package/chunks/themes-v9NbhiBo.d.ts +0 -269
- package/chunks/transports-CqEiFxD3.d.ts +0 -362
- package/chunks/ui-config-Crs0mVMp.d.ts +0 -274
- package/chunks/users-BSOBU_fg.d.ts +0 -675
- package/chunks/web-integrations-MisPAHod.d.ts +0 -295
- package/chunks/web-notifications-DVy6FHYh.d.ts +0 -274
- package/chunks/webhooks-Dr4EiXqy.d.ts +0 -505
- /package/chunks/{auth-types-E99tzdN0.d.ts → auth-types-YrlH_R9f.d.ts} +0 -0
- /package/chunks/{auth-types-JehqruDP.js → auth-types-h43TVDpB.js} +0 -0
- /package/chunks/{global-types-CrOvI33z.js → global-types-CEVAJebk.js} +0 -0
- /package/chunks/{invoke-fetch-CbU2Dgqr.d.ts → invoke-fetch-C1Z0RJYU.d.ts} +0 -0
- /package/chunks/{utils-BnC4lrlq.js → utils-vv-xFm06.js} +0 -0
- /package/chunks/{websocket-errors-DSbO6kDZ.js → websocket-errors-CRTDTtBL.js} +0 -0
package/oauth-clients.d.ts
CHANGED
|
@@ -1,4 +1,563 @@
|
|
|
1
|
-
import "./chunks/auth-types-
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
3
|
-
|
|
1
|
+
import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
|
|
2
|
+
import "./chunks/invoke-fetch-C1Z0RJYU.js";
|
|
3
|
+
|
|
4
|
+
//#region src/public/rest/oauth-clients.d.ts
|
|
5
|
+
/**
|
|
6
|
+
* Hints of any client application secrets
|
|
7
|
+
*/
|
|
8
|
+
type ClientSecrets = {
|
|
9
|
+
/** The timestamp for when the client-secret record was created. */
|
|
10
|
+
createdAt?: string;
|
|
11
|
+
/** The identifier for the user that created the client-secret record. */
|
|
12
|
+
createdBy?: string;
|
|
13
|
+
/** Hint of a client application secret */
|
|
14
|
+
hint: string;
|
|
15
|
+
}[];
|
|
16
|
+
/**
|
|
17
|
+
* Response schema for reading a connection config
|
|
18
|
+
*/
|
|
19
|
+
type ConnectionConfigReadResponse = {
|
|
20
|
+
/** Consent method */
|
|
21
|
+
readonly consentMethod: string;
|
|
22
|
+
/** OAuth client has been deleted by owning tenant, only applies for published clients. */
|
|
23
|
+
readonly deletedByOwner?: boolean;
|
|
24
|
+
/** Status */
|
|
25
|
+
readonly status?: string;
|
|
26
|
+
};
|
|
27
|
+
type Error = {
|
|
28
|
+
/** The unique code for the error */
|
|
29
|
+
code: string;
|
|
30
|
+
/** Additional details about the error */
|
|
31
|
+
detail?: string;
|
|
32
|
+
/** A summary of the error */
|
|
33
|
+
title: string;
|
|
34
|
+
};
|
|
35
|
+
type ErrorResponse = {
|
|
36
|
+
errors?: Error[];
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* JSON Web Key (JWK) for the public key used to verify the signature of a client assertion JWT
|
|
40
|
+
*/
|
|
41
|
+
type JWK = {
|
|
42
|
+
/** Algorithm intended for use with the key */
|
|
43
|
+
alg: "RS256" | "RS512" | "ES384";
|
|
44
|
+
/** Curve for EC keys */
|
|
45
|
+
crv?: string;
|
|
46
|
+
/** Exponent for RSA keys */
|
|
47
|
+
e?: string;
|
|
48
|
+
/** Key ID */
|
|
49
|
+
kid: string;
|
|
50
|
+
/** Key type (e.g., RSA, EC) */
|
|
51
|
+
kty: "RSA" | "EC";
|
|
52
|
+
/** Modulus for RSA keys */
|
|
53
|
+
n?: string;
|
|
54
|
+
/** Intended use of the key (typically "sig" for signature) */
|
|
55
|
+
use: "sig";
|
|
56
|
+
/** X coordinate for EC keys */
|
|
57
|
+
x?: string;
|
|
58
|
+
/** Y coordinate for EC keys */
|
|
59
|
+
y?: string;
|
|
60
|
+
};
|
|
61
|
+
type Link = {
|
|
62
|
+
/** URL that defines the resource */
|
|
63
|
+
href: string;
|
|
64
|
+
};
|
|
65
|
+
type Links = {
|
|
66
|
+
next?: Link;
|
|
67
|
+
prev?: Link;
|
|
68
|
+
self?: Link;
|
|
69
|
+
};
|
|
70
|
+
/**
|
|
71
|
+
* Schema for a OAuth client when listing as an admin user
|
|
72
|
+
*/
|
|
73
|
+
type OAuthClientAdminListItem = {
|
|
74
|
+
/** List of allowed authentication methods for the client */
|
|
75
|
+
allowedAuthMethods?: ("client_secret" | "private_key_jwt")[];
|
|
76
|
+
/** List of allowed origins for client */
|
|
77
|
+
allowedOrigins?: string[];
|
|
78
|
+
/** Client application id */
|
|
79
|
+
readonly clientId: string;
|
|
80
|
+
/** Hints of any client application secrets */
|
|
81
|
+
readonly clientSecrets?: ClientSecrets;
|
|
82
|
+
/** Response schema for reading a connection config */
|
|
83
|
+
connectionConfig?: ConnectionConfigReadResponse;
|
|
84
|
+
/** List of public keys for JWT authentication */
|
|
85
|
+
publicKeys?: JWK[];
|
|
86
|
+
/** List of allowed redirect URIs for login */
|
|
87
|
+
redirectUris?: string[];
|
|
88
|
+
} & OAuthClientBase;
|
|
89
|
+
/**
|
|
90
|
+
* Response schema for listing OAuth clients as an admin user
|
|
91
|
+
*/
|
|
92
|
+
type OAuthClientAdminListResponse = {
|
|
93
|
+
data: OAuthClientAdminListItem[];
|
|
94
|
+
links: Links;
|
|
95
|
+
/** Total number of oauth clients, included only if `totalResults` query parameter is set to true. */
|
|
96
|
+
totalResults?: number;
|
|
97
|
+
};
|
|
98
|
+
/**
|
|
99
|
+
* Response schema for reading an OAuth client as an admin user
|
|
100
|
+
*/
|
|
101
|
+
type OAuthClientAdminReadResponse = {
|
|
102
|
+
/** List of allowed authentication methods for the client */
|
|
103
|
+
allowedAuthMethods?: ("client_secret" | "private_key_jwt")[];
|
|
104
|
+
/** List of allowed origins for client */
|
|
105
|
+
allowedOrigins?: string[];
|
|
106
|
+
/** Client application id */
|
|
107
|
+
readonly clientId: string;
|
|
108
|
+
/** Hints of any client application secrets */
|
|
109
|
+
readonly clientSecrets?: ClientSecrets;
|
|
110
|
+
/** List of public keys for JWT authentication */
|
|
111
|
+
publicKeys?: JWK[];
|
|
112
|
+
/** List of allowed redirect URIs for login */
|
|
113
|
+
redirectUris?: string[];
|
|
114
|
+
} & OAuthClientBase;
|
|
115
|
+
/**
|
|
116
|
+
* Base schema for OAuth client requests and responses
|
|
117
|
+
*/
|
|
118
|
+
type OAuthClientBase = {
|
|
119
|
+
/** Allowed grant types, only for use with appType: 'web' */
|
|
120
|
+
allowedGrantTypes?: ("client_credentials" | "urn:qlik:oauth:user-impersonation")[];
|
|
121
|
+
/** List of allowed scopes for this client. For a full list of scopes see [qlik.dev/authenticate/oauth/scopes/](https://qlik.dev/authenticate/oauth/scopes/). */
|
|
122
|
+
allowedScopes?: string[];
|
|
123
|
+
/** Application type */
|
|
124
|
+
appType: "web" | "native" | "spa" | "anonymous-embed";
|
|
125
|
+
/** Client application name */
|
|
126
|
+
clientName: string;
|
|
127
|
+
/** URI for homepage of client */
|
|
128
|
+
clientUri?: string;
|
|
129
|
+
/** The timestamp for when the oauth-clients record was created. */
|
|
130
|
+
createdAt: string;
|
|
131
|
+
/** The timestamp for when the oauth-clients record was deleted. */
|
|
132
|
+
deletedAt?: string;
|
|
133
|
+
/** Client description */
|
|
134
|
+
description?: string;
|
|
135
|
+
/** Is set if client disabled */
|
|
136
|
+
readonly disableTag?: string;
|
|
137
|
+
/** URI for logo of client */
|
|
138
|
+
logoUri?: string;
|
|
139
|
+
/** The timestamp which is set, if the client is published. */
|
|
140
|
+
publishedAt?: string;
|
|
141
|
+
/** The timestamp for when the oauth-clients record was updated. */
|
|
142
|
+
updatedAt?: string;
|
|
143
|
+
};
|
|
144
|
+
/**
|
|
145
|
+
* Request schema for OAuth client creation
|
|
146
|
+
*/
|
|
147
|
+
type OAuthClientCreateRequest = {
|
|
148
|
+
/** List of allowed authentication methods for the client */
|
|
149
|
+
allowedAuthMethods?: ("client_secret" | "private_key_jwt")[];
|
|
150
|
+
/** Allowed grant types, only for use with appType: 'web' */
|
|
151
|
+
allowedGrantTypes?: ("client_credentials" | "urn:qlik:oauth:user-impersonation")[];
|
|
152
|
+
/** List of allowed origins for this client, only available with SPA application type */
|
|
153
|
+
allowedOrigins?: string[];
|
|
154
|
+
/** List of allowed scopes for this client. For a full list of scopes see [qlik.dev/authenticate/oauth/scopes/](https://qlik.dev/authenticate/oauth/scopes/). */
|
|
155
|
+
allowedScopes?: string[];
|
|
156
|
+
/** Application type */
|
|
157
|
+
appType: "web" | "native" | "spa" | "anonymous-embed";
|
|
158
|
+
/** Client application name */
|
|
159
|
+
clientName: string;
|
|
160
|
+
/** URI for homepage of client */
|
|
161
|
+
clientUri?: string;
|
|
162
|
+
/** Optional settings for configuring the client connection. */
|
|
163
|
+
connectionConfig?: {
|
|
164
|
+
/** Specifies the consent method for the connection. The only allowed value is "trusted." */
|
|
165
|
+
consentMethod?: "trusted";
|
|
166
|
+
};
|
|
167
|
+
/** Client description */
|
|
168
|
+
description?: string;
|
|
169
|
+
/** URI for logo of client */
|
|
170
|
+
logoUri?: string;
|
|
171
|
+
/** List of public keys for JWT authentication (required when using private_key_jwt) */
|
|
172
|
+
publicKeys?: JWK[];
|
|
173
|
+
/** List of allowed redirect URIs for login */
|
|
174
|
+
redirectUris?: string[];
|
|
175
|
+
};
|
|
176
|
+
/**
|
|
177
|
+
* Response schema for OAuth client creation
|
|
178
|
+
*/
|
|
179
|
+
type OAuthClientCreateResponse = {
|
|
180
|
+
/** List of allowed authentication methods for the client */
|
|
181
|
+
allowedAuthMethods?: ("client_secret" | "private_key_jwt")[];
|
|
182
|
+
/** List of allowed redirect URIs for login */
|
|
183
|
+
allowedOrigins?: string[];
|
|
184
|
+
/** Client application id */
|
|
185
|
+
readonly clientId: string;
|
|
186
|
+
/** Client application secret */
|
|
187
|
+
readonly clientSecret: string;
|
|
188
|
+
/** List of public keys for JWT authentication */
|
|
189
|
+
publicKeys?: JWK[];
|
|
190
|
+
/** List of allowed redirect URIs for login */
|
|
191
|
+
redirectUris?: string[];
|
|
192
|
+
} & OAuthClientBase;
|
|
193
|
+
/**
|
|
194
|
+
* Response schema for listing OAuth clients
|
|
195
|
+
*/
|
|
196
|
+
type OAuthClientListResponse = {
|
|
197
|
+
data: OAuthClientReadResponse[];
|
|
198
|
+
links: Links;
|
|
199
|
+
};
|
|
200
|
+
/**
|
|
201
|
+
* Response schema for successfully publishing an OAuth client
|
|
202
|
+
*/
|
|
203
|
+
type OAuthClientPublishResponse = {
|
|
204
|
+
/** The timestamp which is set, if the client is published. */
|
|
205
|
+
publishedAt: string;
|
|
206
|
+
};
|
|
207
|
+
/**
|
|
208
|
+
* Response schema for reading an OAuth client
|
|
209
|
+
*/
|
|
210
|
+
type OAuthClientReadResponse = {
|
|
211
|
+
/** Client application id */
|
|
212
|
+
readonly clientId: string;
|
|
213
|
+
} & OAuthClientBase;
|
|
214
|
+
/**
|
|
215
|
+
* Response schema for creating an OAuth client application secret
|
|
216
|
+
*/
|
|
217
|
+
type OAuthClientSecretResponse = {
|
|
218
|
+
/** Client application id */
|
|
219
|
+
readonly clientId: string;
|
|
220
|
+
/** Client application secret */
|
|
221
|
+
readonly clientSecret: string;
|
|
222
|
+
/** The timestamp for when the client-secret record was created. */
|
|
223
|
+
createdAt?: string;
|
|
224
|
+
/** The identifier for the user that created the client-secret record. */
|
|
225
|
+
createdBy?: string;
|
|
226
|
+
/** Client application hint */
|
|
227
|
+
readonly hint: string;
|
|
228
|
+
};
|
|
229
|
+
/**
|
|
230
|
+
* A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902
|
|
231
|
+
*/
|
|
232
|
+
type OAuthClientUpdate = {
|
|
233
|
+
/** The operation to be performed */
|
|
234
|
+
op: "add" | "remove" | "replace";
|
|
235
|
+
/** The path for the given resource field to patch */
|
|
236
|
+
path: "/allowedOrigins" | "/clientName" | "/clientUri" | "/description" | "/logoUri" | "/redirectUris" | "/allowedScopes" | "/allowedGrantTypes";
|
|
237
|
+
/** The value to be used for this operation. */
|
|
238
|
+
value?: string | string[];
|
|
239
|
+
};
|
|
240
|
+
/**
|
|
241
|
+
* A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902
|
|
242
|
+
*/
|
|
243
|
+
type OAuthConnectionConfigUpdate = {
|
|
244
|
+
/** The operation to be performed */
|
|
245
|
+
op: "replace";
|
|
246
|
+
/** The path for the given resource field to patch */
|
|
247
|
+
path: "/consentMethod";
|
|
248
|
+
/** The value to be used for this operation. */
|
|
249
|
+
value: "required" | "trusted";
|
|
250
|
+
};
|
|
251
|
+
/**
|
|
252
|
+
* Retrieve all OAuth clients.
|
|
253
|
+
* @example
|
|
254
|
+
* getOAuthClients(
|
|
255
|
+
* {
|
|
256
|
+
* filter: "appType eq \"spa\" and clientId eq \"b3ee66d6f21d1611efa89a425f656f6f\"",
|
|
257
|
+
* totalResults: true
|
|
258
|
+
* }
|
|
259
|
+
* )
|
|
260
|
+
*
|
|
261
|
+
* @param query an object with query parameters
|
|
262
|
+
* @throws GetOAuthClientsHttpError
|
|
263
|
+
*/
|
|
264
|
+
declare function getOAuthClients(query: {
|
|
265
|
+
/** The filter query that should be used to filter the list of oauth clients. The filter syntax is defined in RFC 7644. Valid attributes for filtering are `clientId`, `clientName`, `appType`, and `tenantId`. */
|
|
266
|
+
filter?: string;
|
|
267
|
+
/** The number of OAuth client entries to retrieve. */
|
|
268
|
+
limit?: number;
|
|
269
|
+
/** The next page cursor */
|
|
270
|
+
next?: string;
|
|
271
|
+
/** The previous page cursor */
|
|
272
|
+
prev?: string;
|
|
273
|
+
/** The attribute to sort by, beginning with + for ascending and - for descending. Valid attributes for sorting are clientId, clientName, appType, tenantId, createdAt, updatedAt. */
|
|
274
|
+
sort?: string;
|
|
275
|
+
/** Boolean query parameter that determines if the total count of results should be included in the response. If true, the response includes the total number of results in the `totalResults` field. If false or not included in the query, `totalResults` will be excluded from the response. */
|
|
276
|
+
totalResults?: boolean;
|
|
277
|
+
}, options?: ApiCallOptions): Promise<GetOAuthClientsHttpResponse>;
|
|
278
|
+
type GetOAuthClientsHttpResponse = {
|
|
279
|
+
data: OAuthClientAdminListResponse | OAuthClientListResponse;
|
|
280
|
+
headers: Headers;
|
|
281
|
+
status: 200;
|
|
282
|
+
};
|
|
283
|
+
type GetOAuthClientsHttpError = {
|
|
284
|
+
data: ErrorResponse;
|
|
285
|
+
headers: Headers;
|
|
286
|
+
status: 401 | 403 | 500 | 503;
|
|
287
|
+
};
|
|
288
|
+
/**
|
|
289
|
+
* Create a new OAuth client. Requires `TenantAdmin` role when created in-tenant. `appType` cannot be changed after creation. Consent method and published state can be changed after creation. For supported `appType`, use `PATCH /oauth-clients/{id}/connection-configs/me` to change consent method, and `POST /oauth-clients/{id}/actions/publish` to change the client to published after creation.
|
|
290
|
+
*
|
|
291
|
+
* @param body an object with the body content
|
|
292
|
+
* @throws CreateOAuthClientHttpError
|
|
293
|
+
*/
|
|
294
|
+
declare function createOAuthClient(body: OAuthClientCreateRequest, options?: ApiCallOptions): Promise<CreateOAuthClientHttpResponse>;
|
|
295
|
+
type CreateOAuthClientHttpResponse = {
|
|
296
|
+
data: OAuthClientCreateResponse;
|
|
297
|
+
headers: Headers;
|
|
298
|
+
status: 201;
|
|
299
|
+
};
|
|
300
|
+
type CreateOAuthClientHttpError = {
|
|
301
|
+
data: ErrorResponse;
|
|
302
|
+
headers: Headers;
|
|
303
|
+
status: 400 | 401 | 403 | 500 | 503;
|
|
304
|
+
};
|
|
305
|
+
/**
|
|
306
|
+
* Delete the specified OAuth client.
|
|
307
|
+
*
|
|
308
|
+
* @param id The unique identifier for the OAuth client
|
|
309
|
+
* @throws DeleteOAuthClientHttpError
|
|
310
|
+
*/
|
|
311
|
+
declare function deleteOAuthClient(id: string, options?: ApiCallOptions): Promise<DeleteOAuthClientHttpResponse>;
|
|
312
|
+
type DeleteOAuthClientHttpResponse = {
|
|
313
|
+
data: void;
|
|
314
|
+
headers: Headers;
|
|
315
|
+
status: 204;
|
|
316
|
+
};
|
|
317
|
+
type DeleteOAuthClientHttpError = {
|
|
318
|
+
data: ErrorResponse;
|
|
319
|
+
headers: Headers;
|
|
320
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
321
|
+
};
|
|
322
|
+
/**
|
|
323
|
+
* Retrieves the specified OAuth client.
|
|
324
|
+
*
|
|
325
|
+
* @param id The unique identifier for the OAuth client
|
|
326
|
+
* @throws GetOAuthClientHttpError
|
|
327
|
+
*/
|
|
328
|
+
declare function getOAuthClient(id: string, options?: ApiCallOptions): Promise<GetOAuthClientHttpResponse>;
|
|
329
|
+
type GetOAuthClientHttpResponse = {
|
|
330
|
+
data: OAuthClientAdminReadResponse | OAuthClientReadResponse;
|
|
331
|
+
headers: Headers;
|
|
332
|
+
status: 200;
|
|
333
|
+
};
|
|
334
|
+
type GetOAuthClientHttpError = {
|
|
335
|
+
data: ErrorResponse;
|
|
336
|
+
headers: Headers;
|
|
337
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
338
|
+
};
|
|
339
|
+
/**
|
|
340
|
+
* Updates the specified OAuth client.
|
|
341
|
+
*
|
|
342
|
+
* @param id The unique identifier for the OAuth client
|
|
343
|
+
* @param body an object with the body content
|
|
344
|
+
* @throws PatchOAuthClientHttpError
|
|
345
|
+
*/
|
|
346
|
+
declare function patchOAuthClient(id: string, body: OAuthClientUpdate[], options?: ApiCallOptions): Promise<PatchOAuthClientHttpResponse>;
|
|
347
|
+
type PatchOAuthClientHttpResponse = {
|
|
348
|
+
data: void;
|
|
349
|
+
headers: Headers;
|
|
350
|
+
status: 204;
|
|
351
|
+
};
|
|
352
|
+
type PatchOAuthClientHttpError = {
|
|
353
|
+
data: ErrorResponse;
|
|
354
|
+
headers: Headers;
|
|
355
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
356
|
+
};
|
|
357
|
+
/**
|
|
358
|
+
* Publishes the specified OAuth client. By default, OAuth clients are bound to the tenant that created it. Publishing shares the client and makes it available to all other tenants within a region. Third-party applications connecting to Qlik Cloud can then have the same client ID for all Qlik Cloud tenants.
|
|
359
|
+
*
|
|
360
|
+
* @param id The unique identifier for the OAuth client
|
|
361
|
+
* @throws PublishOAuthClientHttpError
|
|
362
|
+
*/
|
|
363
|
+
declare function publishOAuthClient(id: string, options?: ApiCallOptions): Promise<PublishOAuthClientHttpResponse>;
|
|
364
|
+
type PublishOAuthClientHttpResponse = {
|
|
365
|
+
data: OAuthClientPublishResponse;
|
|
366
|
+
headers: Headers;
|
|
367
|
+
status: 201;
|
|
368
|
+
};
|
|
369
|
+
type PublishOAuthClientHttpError = {
|
|
370
|
+
data: ErrorResponse;
|
|
371
|
+
headers: Headers;
|
|
372
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
373
|
+
};
|
|
374
|
+
/**
|
|
375
|
+
* Create a new client secret for the specified OAuth client. An OAuth client can have a maximum of 5 client secrets at one time.
|
|
376
|
+
*
|
|
377
|
+
* @param id The unique identifier for the OAuth client
|
|
378
|
+
* @throws CreateOAuthClientSecretHttpError
|
|
379
|
+
*/
|
|
380
|
+
declare function createOAuthClientSecret(id: string, options?: ApiCallOptions): Promise<CreateOAuthClientSecretHttpResponse>;
|
|
381
|
+
type CreateOAuthClientSecretHttpResponse = {
|
|
382
|
+
data: OAuthClientSecretResponse;
|
|
383
|
+
headers: Headers;
|
|
384
|
+
status: 201;
|
|
385
|
+
};
|
|
386
|
+
type CreateOAuthClientSecretHttpError = {
|
|
387
|
+
data: ErrorResponse;
|
|
388
|
+
headers: Headers;
|
|
389
|
+
status: 400 | 401 | 403 | 404 | 409 | 500 | 503;
|
|
390
|
+
};
|
|
391
|
+
/**
|
|
392
|
+
* Deletes a specific client secret for an OAuth client.
|
|
393
|
+
*
|
|
394
|
+
* @param id The unique identifier for the OAuth client
|
|
395
|
+
* @param hint The unique identifier for the OAuth secret
|
|
396
|
+
* @throws DeleteOAuthClientSecretHttpError
|
|
397
|
+
*/
|
|
398
|
+
declare function deleteOAuthClientSecret(id: string, hint: string, options?: ApiCallOptions): Promise<DeleteOAuthClientSecretHttpResponse>;
|
|
399
|
+
type DeleteOAuthClientSecretHttpResponse = {
|
|
400
|
+
data: void;
|
|
401
|
+
headers: Headers;
|
|
402
|
+
status: 204;
|
|
403
|
+
};
|
|
404
|
+
type DeleteOAuthClientSecretHttpError = {
|
|
405
|
+
data: ErrorResponse;
|
|
406
|
+
headers: Headers;
|
|
407
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
408
|
+
};
|
|
409
|
+
/**
|
|
410
|
+
* Deletes the connection config for the calling tenant, related to the supplied client id.
|
|
411
|
+
*
|
|
412
|
+
* @param id The unique identifier for the OAuth client
|
|
413
|
+
* @throws DeleteOAuthClientConnectionConfigHttpError
|
|
414
|
+
*/
|
|
415
|
+
declare function deleteOAuthClientConnectionConfig(id: string, options?: ApiCallOptions): Promise<DeleteOAuthClientConnectionConfigHttpResponse>;
|
|
416
|
+
type DeleteOAuthClientConnectionConfigHttpResponse = {
|
|
417
|
+
data: void;
|
|
418
|
+
headers: Headers;
|
|
419
|
+
status: 204;
|
|
420
|
+
};
|
|
421
|
+
type DeleteOAuthClientConnectionConfigHttpError = {
|
|
422
|
+
data: ErrorResponse;
|
|
423
|
+
headers: Headers;
|
|
424
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
425
|
+
};
|
|
426
|
+
/**
|
|
427
|
+
* Get configuration for consent method and status.
|
|
428
|
+
*
|
|
429
|
+
* @param id The unique identifier for an OAuth client
|
|
430
|
+
* @throws GetOAuthClientConnectionConfigHttpError
|
|
431
|
+
*/
|
|
432
|
+
declare function getOAuthClientConnectionConfig(id: string, options?: ApiCallOptions): Promise<GetOAuthClientConnectionConfigHttpResponse>;
|
|
433
|
+
type GetOAuthClientConnectionConfigHttpResponse = {
|
|
434
|
+
data: ConnectionConfigReadResponse;
|
|
435
|
+
headers: Headers;
|
|
436
|
+
status: 200;
|
|
437
|
+
};
|
|
438
|
+
type GetOAuthClientConnectionConfigHttpError = {
|
|
439
|
+
data: ErrorResponse;
|
|
440
|
+
headers: Headers;
|
|
441
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
442
|
+
};
|
|
443
|
+
/**
|
|
444
|
+
* Updates the consent method for the specified OAuth client.
|
|
445
|
+
*
|
|
446
|
+
* @param id The unique identifier for the OAuth client
|
|
447
|
+
* @param body an object with the body content
|
|
448
|
+
* @throws PatchOAuthClientConnectionConfigHttpError
|
|
449
|
+
*/
|
|
450
|
+
declare function patchOAuthClientConnectionConfig(id: string, body: OAuthConnectionConfigUpdate[], options?: ApiCallOptions): Promise<PatchOAuthClientConnectionConfigHttpResponse>;
|
|
451
|
+
type PatchOAuthClientConnectionConfigHttpResponse = {
|
|
452
|
+
data: void;
|
|
453
|
+
headers: Headers;
|
|
454
|
+
status: 204;
|
|
455
|
+
};
|
|
456
|
+
type PatchOAuthClientConnectionConfigHttpError = {
|
|
457
|
+
data: ErrorResponse;
|
|
458
|
+
headers: Headers;
|
|
459
|
+
status: 400 | 401 | 403 | 404 | 500 | 503;
|
|
460
|
+
};
|
|
461
|
+
/**
|
|
462
|
+
* Clears the cache for oauth-clients api requests.
|
|
463
|
+
*/
|
|
464
|
+
declare function clearCache(): void;
|
|
465
|
+
type OauthClientsAPI = {
|
|
466
|
+
/**
|
|
467
|
+
* Retrieve all OAuth clients.
|
|
468
|
+
* @example
|
|
469
|
+
* getOAuthClients(
|
|
470
|
+
* {
|
|
471
|
+
* filter: "appType eq \"spa\" and clientId eq \"b3ee66d6f21d1611efa89a425f656f6f\"",
|
|
472
|
+
* totalResults: true
|
|
473
|
+
* }
|
|
474
|
+
* )
|
|
475
|
+
*
|
|
476
|
+
* @param query an object with query parameters
|
|
477
|
+
* @throws GetOAuthClientsHttpError
|
|
478
|
+
*/
|
|
479
|
+
getOAuthClients: typeof getOAuthClients;
|
|
480
|
+
/**
|
|
481
|
+
* Create a new OAuth client. Requires `TenantAdmin` role when created in-tenant. `appType` cannot be changed after creation. Consent method and published state can be changed after creation. For supported `appType`, use `PATCH /oauth-clients/{id}/connection-configs/me` to change consent method, and `POST /oauth-clients/{id}/actions/publish` to change the client to published after creation.
|
|
482
|
+
*
|
|
483
|
+
* @param body an object with the body content
|
|
484
|
+
* @throws CreateOAuthClientHttpError
|
|
485
|
+
*/
|
|
486
|
+
createOAuthClient: typeof createOAuthClient;
|
|
487
|
+
/**
|
|
488
|
+
* Delete the specified OAuth client.
|
|
489
|
+
*
|
|
490
|
+
* @param id The unique identifier for the OAuth client
|
|
491
|
+
* @throws DeleteOAuthClientHttpError
|
|
492
|
+
*/
|
|
493
|
+
deleteOAuthClient: typeof deleteOAuthClient;
|
|
494
|
+
/**
|
|
495
|
+
* Retrieves the specified OAuth client.
|
|
496
|
+
*
|
|
497
|
+
* @param id The unique identifier for the OAuth client
|
|
498
|
+
* @throws GetOAuthClientHttpError
|
|
499
|
+
*/
|
|
500
|
+
getOAuthClient: typeof getOAuthClient;
|
|
501
|
+
/**
|
|
502
|
+
* Updates the specified OAuth client.
|
|
503
|
+
*
|
|
504
|
+
* @param id The unique identifier for the OAuth client
|
|
505
|
+
* @param body an object with the body content
|
|
506
|
+
* @throws PatchOAuthClientHttpError
|
|
507
|
+
*/
|
|
508
|
+
patchOAuthClient: typeof patchOAuthClient;
|
|
509
|
+
/**
|
|
510
|
+
* Publishes the specified OAuth client. By default, OAuth clients are bound to the tenant that created it. Publishing shares the client and makes it available to all other tenants within a region. Third-party applications connecting to Qlik Cloud can then have the same client ID for all Qlik Cloud tenants.
|
|
511
|
+
*
|
|
512
|
+
* @param id The unique identifier for the OAuth client
|
|
513
|
+
* @throws PublishOAuthClientHttpError
|
|
514
|
+
*/
|
|
515
|
+
publishOAuthClient: typeof publishOAuthClient;
|
|
516
|
+
/**
|
|
517
|
+
* Create a new client secret for the specified OAuth client. An OAuth client can have a maximum of 5 client secrets at one time.
|
|
518
|
+
*
|
|
519
|
+
* @param id The unique identifier for the OAuth client
|
|
520
|
+
* @throws CreateOAuthClientSecretHttpError
|
|
521
|
+
*/
|
|
522
|
+
createOAuthClientSecret: typeof createOAuthClientSecret;
|
|
523
|
+
/**
|
|
524
|
+
* Deletes a specific client secret for an OAuth client.
|
|
525
|
+
*
|
|
526
|
+
* @param id The unique identifier for the OAuth client
|
|
527
|
+
* @param hint The unique identifier for the OAuth secret
|
|
528
|
+
* @throws DeleteOAuthClientSecretHttpError
|
|
529
|
+
*/
|
|
530
|
+
deleteOAuthClientSecret: typeof deleteOAuthClientSecret;
|
|
531
|
+
/**
|
|
532
|
+
* Deletes the connection config for the calling tenant, related to the supplied client id.
|
|
533
|
+
*
|
|
534
|
+
* @param id The unique identifier for the OAuth client
|
|
535
|
+
* @throws DeleteOAuthClientConnectionConfigHttpError
|
|
536
|
+
*/
|
|
537
|
+
deleteOAuthClientConnectionConfig: typeof deleteOAuthClientConnectionConfig;
|
|
538
|
+
/**
|
|
539
|
+
* Get configuration for consent method and status.
|
|
540
|
+
*
|
|
541
|
+
* @param id The unique identifier for an OAuth client
|
|
542
|
+
* @throws GetOAuthClientConnectionConfigHttpError
|
|
543
|
+
*/
|
|
544
|
+
getOAuthClientConnectionConfig: typeof getOAuthClientConnectionConfig;
|
|
545
|
+
/**
|
|
546
|
+
* Updates the consent method for the specified OAuth client.
|
|
547
|
+
*
|
|
548
|
+
* @param id The unique identifier for the OAuth client
|
|
549
|
+
* @param body an object with the body content
|
|
550
|
+
* @throws PatchOAuthClientConnectionConfigHttpError
|
|
551
|
+
*/
|
|
552
|
+
patchOAuthClientConnectionConfig: typeof patchOAuthClientConnectionConfig;
|
|
553
|
+
/**
|
|
554
|
+
* Clears the cache for oauth-clients api requests.
|
|
555
|
+
*/
|
|
556
|
+
clearCache: typeof clearCache;
|
|
557
|
+
};
|
|
558
|
+
/**
|
|
559
|
+
* Functions for the oauth-clients api
|
|
560
|
+
*/
|
|
561
|
+
declare const oauthClientsExport: OauthClientsAPI;
|
|
562
|
+
//#endregion
|
|
4
563
|
export { ClientSecrets, ConnectionConfigReadResponse, CreateOAuthClientHttpError, CreateOAuthClientHttpResponse, CreateOAuthClientSecretHttpError, CreateOAuthClientSecretHttpResponse, DeleteOAuthClientConnectionConfigHttpError, DeleteOAuthClientConnectionConfigHttpResponse, DeleteOAuthClientHttpError, DeleteOAuthClientHttpResponse, DeleteOAuthClientSecretHttpError, DeleteOAuthClientSecretHttpResponse, Error, ErrorResponse, GetOAuthClientConnectionConfigHttpError, GetOAuthClientConnectionConfigHttpResponse, GetOAuthClientHttpError, GetOAuthClientHttpResponse, GetOAuthClientsHttpError, GetOAuthClientsHttpResponse, JWK, Link, Links, OAuthClientAdminListItem, OAuthClientAdminListResponse, OAuthClientAdminReadResponse, OAuthClientBase, OAuthClientCreateRequest, OAuthClientCreateResponse, OAuthClientListResponse, OAuthClientPublishResponse, OAuthClientReadResponse, OAuthClientSecretResponse, OAuthClientUpdate, OAuthConnectionConfigUpdate, OauthClientsAPI, PatchOAuthClientConnectionConfigHttpError, PatchOAuthClientConnectionConfigHttpResponse, PatchOAuthClientHttpError, PatchOAuthClientHttpResponse, PublishOAuthClientHttpError, PublishOAuthClientHttpResponse, clearCache, createOAuthClient, createOAuthClientSecret, oauthClientsExport as default, deleteOAuthClient, deleteOAuthClientConnectionConfig, deleteOAuthClientSecret, getOAuthClient, getOAuthClientConnectionConfig, getOAuthClients, patchOAuthClient, patchOAuthClientConnectionConfig, publishOAuthClient };
|
package/oauth-clients.js
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import "./chunks/
|
|
2
|
-
import "./chunks/
|
|
3
|
-
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
|
|
1
|
+
import "./chunks/public-runtime-modules-QhLPeQr5.js";
|
|
2
|
+
import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
|
|
4
3
|
|
|
5
4
|
//#region src/public/rest/oauth-clients.ts
|
|
6
5
|
/**
|