@lumoauth/api-client 1.1.0 → 1.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/.openapi-generator/FILES +16 -0
- package/README.md +14 -4
- package/api/aauth-api.ts +5 -5
- package/api/admin-email-api.ts +67 -15
- package/api/admin-mcp-api.ts +5 -5
- package/api/admin-oauth-clients-api.ts +370 -0
- package/api/agents-api.ts +5 -5
- package/api/mcp-api.ts +130 -0
- package/api/oauth-api.ts +0 -186
- package/api/well-known-api.ts +10 -10
- package/dist/api/aauth-api.d.ts +5 -5
- package/dist/api/aauth-api.js +4 -4
- package/dist/api/admin-email-api.d.ts +41 -9
- package/dist/api/admin-email-api.js +34 -14
- package/dist/api/admin-mcp-api.d.ts +5 -5
- package/dist/api/admin-mcp-api.js +4 -4
- package/dist/api/admin-oauth-clients-api.d.ts +210 -0
- package/dist/api/admin-oauth-clients-api.js +236 -0
- package/dist/api/agents-api.d.ts +5 -5
- package/dist/api/agents-api.js +4 -4
- package/dist/api/mcp-api.d.ts +73 -0
- package/dist/api/mcp-api.js +82 -0
- package/dist/api/oauth-api.d.ts +0 -110
- package/dist/api/oauth-api.js +0 -132
- package/dist/api/well-known-api.d.ts +10 -10
- package/dist/api/well-known-api.js +8 -8
- package/dist/esm/api/aauth-api.d.ts +5 -5
- package/dist/esm/api/aauth-api.js +4 -4
- package/dist/esm/api/admin-email-api.d.ts +41 -9
- package/dist/esm/api/admin-email-api.js +34 -14
- package/dist/esm/api/admin-mcp-api.d.ts +5 -5
- package/dist/esm/api/admin-mcp-api.js +4 -4
- package/dist/esm/api/admin-oauth-clients-api.d.ts +210 -0
- package/dist/esm/api/admin-oauth-clients-api.js +236 -0
- package/dist/esm/api/agents-api.d.ts +5 -5
- package/dist/esm/api/agents-api.js +4 -4
- package/dist/esm/api/mcp-api.d.ts +73 -0
- package/dist/esm/api/mcp-api.js +83 -1
- package/dist/esm/api/oauth-api.d.ts +0 -110
- package/dist/esm/api/oauth-api.js +0 -132
- package/dist/esm/api/well-known-api.d.ts +10 -10
- package/dist/esm/api/well-known-api.js +8 -8
- package/dist/esm/models/admin-agents-generate-token-request.d.ts +7 -1
- package/dist/esm/models/admin-agents-generate-token-response-data.d.ts +12 -0
- package/dist/esm/models/admin-clients-get-branding-response-data.d.ts +34 -0
- package/dist/esm/models/admin-clients-get-branding-response-data.js +14 -0
- package/dist/esm/models/admin-clients-get-branding-response.d.ts +25 -0
- package/dist/esm/models/admin-clients-get-branding-response.js +14 -0
- package/dist/esm/models/attest-response.d.ts +2 -1
- package/dist/esm/models/attest-response.js +1 -0
- package/dist/esm/models/authorization-server-metadata.d.ts +0 -6
- package/dist/esm/models/authorize-mcp-request.d.ts +1 -1
- package/dist/esm/models/get-protected-resource-metadata-root-response1-resources-item.d.ts +1 -1
- package/dist/esm/models/index.d.ts +8 -0
- package/dist/esm/models/index.js +8 -0
- package/dist/esm/models/mcp-server-tool-authorize-request-subject.d.ts +38 -0
- package/dist/esm/models/mcp-server-tool-authorize-request-subject.js +22 -0
- package/dist/esm/models/mcp-server-tool-authorize-request.d.ts +31 -0
- package/dist/esm/models/mcp-server-tool-authorize-request.js +14 -0
- package/dist/esm/models/mcp-server-tool-authorize-response.d.ts +36 -0
- package/dist/esm/models/mcp-server-tool-authorize-response.js +14 -0
- package/dist/esm/models/mcp-server.d.ts +18 -0
- package/dist/esm/models/open-id-configuration.d.ts +7 -7
- package/dist/esm/models/patch-admin-clients-update-branding-response.d.ts +32 -0
- package/dist/esm/models/patch-admin-clients-update-branding-response.js +14 -0
- package/dist/esm/models/protected-resource-metadata.d.ts +1 -1
- package/dist/esm/models/put-admin-clients-update-branding-request.d.ts +34 -0
- package/dist/esm/models/put-admin-clients-update-branding-request.js +14 -0
- package/dist/esm/models/put-admin-clients-update-branding-response.d.ts +32 -0
- package/dist/esm/models/put-admin-clients-update-branding-response.js +14 -0
- package/dist/esm/models/single-server-metadata.d.ts +1 -1
- package/dist/models/admin-agents-generate-token-request.d.ts +7 -1
- package/dist/models/admin-agents-generate-token-response-data.d.ts +12 -0
- package/dist/models/admin-clients-get-branding-response-data.d.ts +34 -0
- package/dist/models/admin-clients-get-branding-response-data.js +15 -0
- package/dist/models/admin-clients-get-branding-response.d.ts +25 -0
- package/dist/models/admin-clients-get-branding-response.js +15 -0
- package/dist/models/attest-response.d.ts +2 -1
- package/dist/models/attest-response.js +1 -0
- package/dist/models/authorization-server-metadata.d.ts +0 -6
- package/dist/models/authorize-mcp-request.d.ts +1 -1
- package/dist/models/get-protected-resource-metadata-root-response1-resources-item.d.ts +1 -1
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/dist/models/mcp-server-tool-authorize-request-subject.d.ts +38 -0
- package/dist/models/mcp-server-tool-authorize-request-subject.js +25 -0
- package/dist/models/mcp-server-tool-authorize-request.d.ts +31 -0
- package/dist/models/mcp-server-tool-authorize-request.js +15 -0
- package/dist/models/mcp-server-tool-authorize-response.d.ts +36 -0
- package/dist/models/mcp-server-tool-authorize-response.js +15 -0
- package/dist/models/mcp-server.d.ts +18 -0
- package/dist/models/open-id-configuration.d.ts +7 -7
- package/dist/models/patch-admin-clients-update-branding-response.d.ts +32 -0
- package/dist/models/patch-admin-clients-update-branding-response.js +15 -0
- package/dist/models/protected-resource-metadata.d.ts +1 -1
- package/dist/models/put-admin-clients-update-branding-request.d.ts +34 -0
- package/dist/models/put-admin-clients-update-branding-request.js +15 -0
- package/dist/models/put-admin-clients-update-branding-response.d.ts +32 -0
- package/dist/models/put-admin-clients-update-branding-response.js +15 -0
- package/dist/models/single-server-metadata.d.ts +1 -1
- package/docs/AAuthApi.md +1 -1
- package/docs/AdminAgentsApi.md +1 -1
- package/docs/AdminAgentsGenerateTokenRequest.md +3 -1
- package/docs/AdminAgentsGenerateTokenResponseData.md +4 -0
- package/docs/AdminClientsGetBrandingResponse.md +20 -0
- package/docs/AdminClientsGetBrandingResponseData.md +22 -0
- package/docs/AdminEmailApi.md +15 -2
- package/docs/AdminMcpApi.md +1 -1
- package/docs/AdminOAuthClientsApi.md +174 -0
- package/docs/AgentsApi.md +4 -3
- package/docs/AuthorizationServerMetadata.md +0 -2
- package/docs/AuthorizeMcpRequest.md +1 -1
- package/docs/GetProtectedResourceMetadataRoot200Response.md +1 -1
- package/docs/GetProtectedResourceMetadataRootResponse1ResourcesItem.md +1 -1
- package/docs/McpApi.md +64 -0
- package/docs/McpServer.md +6 -0
- package/docs/McpServerToolAuthorizeRequest.md +22 -0
- package/docs/McpServerToolAuthorizeRequestSubject.md +22 -0
- package/docs/McpServerToolAuthorizeResponse.md +24 -0
- package/docs/OAuthApi.md +0 -105
- package/docs/OpenIdConfiguration.md +3 -3
- package/docs/PatchAdminClientsUpdateBrandingResponse.md +22 -0
- package/docs/ProtectedResourceMetadata.md +1 -1
- package/docs/PutAdminClientsUpdateBrandingRequest.md +22 -0
- package/docs/PutAdminClientsUpdateBrandingResponse.md +22 -0
- package/docs/SingleServerMetadata.md +1 -1
- package/docs/WellKnownApi.md +2 -2
- package/models/admin-agents-generate-token-request.ts +7 -1
- package/models/admin-agents-generate-token-response-data.ts +12 -0
- package/models/admin-clients-get-branding-response-data.ts +36 -0
- package/models/admin-clients-get-branding-response.ts +33 -0
- package/models/attest-response.ts +2 -1
- package/models/authorization-server-metadata.ts +0 -6
- package/models/authorize-mcp-request.ts +1 -1
- package/models/get-protected-resource-metadata-root-response1-resources-item.ts +1 -1
- package/models/index.ts +8 -0
- package/models/mcp-server-tool-authorize-request-subject.ts +46 -0
- package/models/mcp-server-tool-authorize-request.ts +39 -0
- package/models/mcp-server-tool-authorize-response.ts +42 -0
- package/models/mcp-server.ts +18 -0
- package/models/open-id-configuration.ts +7 -7
- package/models/patch-admin-clients-update-branding-response.ts +36 -0
- package/models/protected-resource-metadata.ts +1 -1
- package/models/put-admin-clients-update-branding-request.ts +36 -0
- package/models/put-admin-clients-update-branding-response.ts +36 -0
- package/models/single-server-metadata.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api/mcp-api.js
CHANGED
|
@@ -23,7 +23,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
23
23
|
import globalAxios from 'axios';
|
|
24
24
|
// Some imports not used depending on template conditions
|
|
25
25
|
// @ts-ignore
|
|
26
|
-
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBearerAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
|
|
26
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBearerAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
27
27
|
// @ts-ignore
|
|
28
28
|
import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
|
|
29
29
|
/**
|
|
@@ -202,6 +202,49 @@ export const McpApiAxiosParamCreator = function (configuration) {
|
|
|
202
202
|
options: localVarRequestOptions,
|
|
203
203
|
};
|
|
204
204
|
}),
|
|
205
|
+
/**
|
|
206
|
+
* Called by the MCP server with its own client-credentials access token (scope mcp:authorize; the client must be listed in the server\'s tool_authorizer_client_ids). The body names the caller the server already verified. The server never forwards the caller\'s token.
|
|
207
|
+
* @summary Per-tool authorization for an MCP server (server credential)
|
|
208
|
+
* @param {string} orgId
|
|
209
|
+
* @param {string} serverId
|
|
210
|
+
* @param {McpServerToolAuthorizeRequest} mcpServerToolAuthorizeRequest
|
|
211
|
+
* @param {*} [options] Override http request option.
|
|
212
|
+
* @throws {RequiredError}
|
|
213
|
+
*/
|
|
214
|
+
mcpServerToolAuthorize: (orgId_1, serverId_1, mcpServerToolAuthorizeRequest_1, ...args_1) => __awaiter(this, [orgId_1, serverId_1, mcpServerToolAuthorizeRequest_1, ...args_1], void 0, function* (orgId, serverId, mcpServerToolAuthorizeRequest, options = {}) {
|
|
215
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
216
|
+
assertParamExists('mcpServerToolAuthorize', 'orgId', orgId);
|
|
217
|
+
// verify required parameter 'serverId' is not null or undefined
|
|
218
|
+
assertParamExists('mcpServerToolAuthorize', 'serverId', serverId);
|
|
219
|
+
// verify required parameter 'mcpServerToolAuthorizeRequest' is not null or undefined
|
|
220
|
+
assertParamExists('mcpServerToolAuthorize', 'mcpServerToolAuthorizeRequest', mcpServerToolAuthorizeRequest);
|
|
221
|
+
const localVarPath = `/orgs/{orgId}/api/v1/mcp/servers/{serverId}/tools/authorize`
|
|
222
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)))
|
|
223
|
+
.replace(`{${"serverId"}}`, encodeURIComponent(String(serverId)));
|
|
224
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
225
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
226
|
+
let baseOptions;
|
|
227
|
+
if (configuration) {
|
|
228
|
+
baseOptions = configuration.baseOptions;
|
|
229
|
+
}
|
|
230
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
231
|
+
const localVarHeaderParameter = {};
|
|
232
|
+
const localVarQueryParameter = {};
|
|
233
|
+
// authentication ApiKeyAuth required
|
|
234
|
+
yield setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration);
|
|
235
|
+
// authentication BearerAuth required
|
|
236
|
+
// http bearer authentication required
|
|
237
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
238
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
239
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
240
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
241
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
242
|
+
localVarRequestOptions.data = serializeDataIfNeeded(mcpServerToolAuthorizeRequest, localVarRequestOptions, configuration);
|
|
243
|
+
return {
|
|
244
|
+
url: toPathString(localVarUrlObj),
|
|
245
|
+
options: localVarRequestOptions,
|
|
246
|
+
};
|
|
247
|
+
}),
|
|
205
248
|
/**
|
|
206
249
|
* Identical to GET; the HTTP method is only recorded in the audit trail.
|
|
207
250
|
* @summary Simulated MCP server authorization challenge (POST)
|
|
@@ -330,6 +373,24 @@ export const McpApiFp = function (configuration) {
|
|
|
330
373
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
331
374
|
});
|
|
332
375
|
},
|
|
376
|
+
/**
|
|
377
|
+
* Called by the MCP server with its own client-credentials access token (scope mcp:authorize; the client must be listed in the server\'s tool_authorizer_client_ids). The body names the caller the server already verified. The server never forwards the caller\'s token.
|
|
378
|
+
* @summary Per-tool authorization for an MCP server (server credential)
|
|
379
|
+
* @param {string} orgId
|
|
380
|
+
* @param {string} serverId
|
|
381
|
+
* @param {McpServerToolAuthorizeRequest} mcpServerToolAuthorizeRequest
|
|
382
|
+
* @param {*} [options] Override http request option.
|
|
383
|
+
* @throws {RequiredError}
|
|
384
|
+
*/
|
|
385
|
+
mcpServerToolAuthorize(orgId, serverId, mcpServerToolAuthorizeRequest, options) {
|
|
386
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
387
|
+
var _a, _b, _c;
|
|
388
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.mcpServerToolAuthorize(orgId, serverId, mcpServerToolAuthorizeRequest, options);
|
|
389
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
390
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['McpApi.mcpServerToolAuthorize']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
391
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
392
|
+
});
|
|
393
|
+
},
|
|
333
394
|
/**
|
|
334
395
|
* Identical to GET; the HTTP method is only recorded in the audit trail.
|
|
335
396
|
* @summary Simulated MCP server authorization challenge (POST)
|
|
@@ -406,6 +467,16 @@ export const McpApiFactory = function (configuration, basePath, axios) {
|
|
|
406
467
|
listServers(requestParameters, options) {
|
|
407
468
|
return localVarFp.listServers(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
408
469
|
},
|
|
470
|
+
/**
|
|
471
|
+
* Called by the MCP server with its own client-credentials access token (scope mcp:authorize; the client must be listed in the server\'s tool_authorizer_client_ids). The body names the caller the server already verified. The server never forwards the caller\'s token.
|
|
472
|
+
* @summary Per-tool authorization for an MCP server (server credential)
|
|
473
|
+
* @param {McpApiMcpServerToolAuthorizeRequest} requestParameters Request parameters.
|
|
474
|
+
* @param {*} [options] Override http request option.
|
|
475
|
+
* @throws {RequiredError}
|
|
476
|
+
*/
|
|
477
|
+
mcpServerToolAuthorize(requestParameters, options) {
|
|
478
|
+
return localVarFp.mcpServerToolAuthorize(requestParameters.orgId, requestParameters.serverId, requestParameters.mcpServerToolAuthorizeRequest, options).then((request) => request(axios, basePath));
|
|
479
|
+
},
|
|
409
480
|
/**
|
|
410
481
|
* Identical to GET; the HTTP method is only recorded in the audit trail.
|
|
411
482
|
* @summary Simulated MCP server authorization challenge (POST)
|
|
@@ -480,6 +551,17 @@ export class McpApi extends BaseAPI {
|
|
|
480
551
|
listServers(requestParameters, options) {
|
|
481
552
|
return McpApiFp(this.configuration).listServers(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
482
553
|
}
|
|
554
|
+
/**
|
|
555
|
+
* Called by the MCP server with its own client-credentials access token (scope mcp:authorize; the client must be listed in the server\'s tool_authorizer_client_ids). The body names the caller the server already verified. The server never forwards the caller\'s token.
|
|
556
|
+
* @summary Per-tool authorization for an MCP server (server credential)
|
|
557
|
+
* @param {McpApiMcpServerToolAuthorizeRequest} requestParameters Request parameters.
|
|
558
|
+
* @param {*} [options] Override http request option.
|
|
559
|
+
* @throws {RequiredError}
|
|
560
|
+
* @memberof McpApi
|
|
561
|
+
*/
|
|
562
|
+
mcpServerToolAuthorize(requestParameters, options) {
|
|
563
|
+
return McpApiFp(this.configuration).mcpServerToolAuthorize(requestParameters.orgId, requestParameters.serverId, requestParameters.mcpServerToolAuthorizeRequest, options).then((request) => request(this.axios, this.basePath));
|
|
564
|
+
}
|
|
483
565
|
/**
|
|
484
566
|
* Identical to GET; the HTTP method is only recorded in the audit trail.
|
|
485
567
|
* @summary Simulated MCP server authorization challenge (POST)
|
|
@@ -90,14 +90,6 @@ export declare const OAuthApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
90
90
|
* @throws {RequiredError}
|
|
91
91
|
*/
|
|
92
92
|
par: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
93
|
-
/**
|
|
94
|
-
* Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
|
|
95
|
-
* @summary Passkey login entry point
|
|
96
|
-
* @param {string} orgId
|
|
97
|
-
* @param {*} [options] Override http request option.
|
|
98
|
-
* @throws {RequiredError}
|
|
99
|
-
*/
|
|
100
|
-
passkeyLogin: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
101
93
|
/**
|
|
102
94
|
* Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
|
|
103
95
|
* @summary Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
@@ -157,14 +149,6 @@ export declare const OAuthApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
157
149
|
* @throws {RequiredError}
|
|
158
150
|
*/
|
|
159
151
|
submitDeviceVerification: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
160
|
-
/**
|
|
161
|
-
* Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
|
|
162
|
-
* @summary Hosted login form submission
|
|
163
|
-
* @param {string} orgId
|
|
164
|
-
* @param {*} [options] Override http request option.
|
|
165
|
-
* @throws {RequiredError}
|
|
166
|
-
*/
|
|
167
|
-
submitLogin: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
168
152
|
/**
|
|
169
153
|
* Establishes the end-user browser session from JSON credentials so a following /oauth/authorize request issues a code without showing the hosted login page. Deliberately mints no tokens. Only accepted from trusted origins.
|
|
170
154
|
* @summary Programmatic (JSON) login for the authorization flow
|
|
@@ -260,14 +244,6 @@ export declare const OAuthApiFp: (configuration?: Configuration) => {
|
|
|
260
244
|
* @throws {RequiredError}
|
|
261
245
|
*/
|
|
262
246
|
par(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParResponse>>;
|
|
263
|
-
/**
|
|
264
|
-
* Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
|
|
265
|
-
* @summary Passkey login entry point
|
|
266
|
-
* @param {string} orgId
|
|
267
|
-
* @param {*} [options] Override http request option.
|
|
268
|
-
* @throws {RequiredError}
|
|
269
|
-
*/
|
|
270
|
-
passkeyLogin(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
271
247
|
/**
|
|
272
248
|
* Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
|
|
273
249
|
* @summary Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
@@ -327,14 +303,6 @@ export declare const OAuthApiFp: (configuration?: Configuration) => {
|
|
|
327
303
|
* @throws {RequiredError}
|
|
328
304
|
*/
|
|
329
305
|
submitDeviceVerification(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
330
|
-
/**
|
|
331
|
-
* Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
|
|
332
|
-
* @summary Hosted login form submission
|
|
333
|
-
* @param {string} orgId
|
|
334
|
-
* @param {*} [options] Override http request option.
|
|
335
|
-
* @throws {RequiredError}
|
|
336
|
-
*/
|
|
337
|
-
submitLogin(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
338
306
|
/**
|
|
339
307
|
* Establishes the end-user browser session from JSON credentials so a following /oauth/authorize request issues a code without showing the hosted login page. Deliberately mints no tokens. Only accepted from trusted origins.
|
|
340
308
|
* @summary Programmatic (JSON) login for the authorization flow
|
|
@@ -429,14 +397,6 @@ export declare const OAuthApiFactory: (configuration?: Configuration, basePath?:
|
|
|
429
397
|
* @throws {RequiredError}
|
|
430
398
|
*/
|
|
431
399
|
par(requestParameters: OAuthApiParRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParResponse>;
|
|
432
|
-
/**
|
|
433
|
-
* Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
|
|
434
|
-
* @summary Passkey login entry point
|
|
435
|
-
* @param {OAuthApiPasskeyLoginRequest} requestParameters Request parameters.
|
|
436
|
-
* @param {*} [options] Override http request option.
|
|
437
|
-
* @throws {RequiredError}
|
|
438
|
-
*/
|
|
439
|
-
passkeyLogin(requestParameters: OAuthApiPasskeyLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
440
400
|
/**
|
|
441
401
|
* Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
|
|
442
402
|
* @summary Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
@@ -493,14 +453,6 @@ export declare const OAuthApiFactory: (configuration?: Configuration, basePath?:
|
|
|
493
453
|
* @throws {RequiredError}
|
|
494
454
|
*/
|
|
495
455
|
submitDeviceVerification(requestParameters: OAuthApiSubmitDeviceVerificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
496
|
-
/**
|
|
497
|
-
* Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
|
|
498
|
-
* @summary Hosted login form submission
|
|
499
|
-
* @param {OAuthApiSubmitLoginRequest} requestParameters Request parameters.
|
|
500
|
-
* @param {*} [options] Override http request option.
|
|
501
|
-
* @throws {RequiredError}
|
|
502
|
-
*/
|
|
503
|
-
submitLogin(requestParameters: OAuthApiSubmitLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
504
456
|
/**
|
|
505
457
|
* Establishes the end-user browser session from JSON credentials so a following /oauth/authorize request issues a code without showing the hosted login page. Deliberately mints no tokens. Only accepted from trusted origins.
|
|
506
458
|
* @summary Programmatic (JSON) login for the authorization flow
|
|
@@ -604,15 +556,6 @@ export interface OAuthApiInterface {
|
|
|
604
556
|
* @memberof OAuthApiInterface
|
|
605
557
|
*/
|
|
606
558
|
par(requestParameters: OAuthApiParRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParResponse>;
|
|
607
|
-
/**
|
|
608
|
-
* Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
|
|
609
|
-
* @summary Passkey login entry point
|
|
610
|
-
* @param {OAuthApiPasskeyLoginRequest} requestParameters Request parameters.
|
|
611
|
-
* @param {*} [options] Override http request option.
|
|
612
|
-
* @throws {RequiredError}
|
|
613
|
-
* @memberof OAuthApiInterface
|
|
614
|
-
*/
|
|
615
|
-
passkeyLogin(requestParameters: OAuthApiPasskeyLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
616
559
|
/**
|
|
617
560
|
* Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
|
|
618
561
|
* @summary Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
@@ -676,15 +619,6 @@ export interface OAuthApiInterface {
|
|
|
676
619
|
* @memberof OAuthApiInterface
|
|
677
620
|
*/
|
|
678
621
|
submitDeviceVerification(requestParameters: OAuthApiSubmitDeviceVerificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
679
|
-
/**
|
|
680
|
-
* Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
|
|
681
|
-
* @summary Hosted login form submission
|
|
682
|
-
* @param {OAuthApiSubmitLoginRequest} requestParameters Request parameters.
|
|
683
|
-
* @param {*} [options] Override http request option.
|
|
684
|
-
* @throws {RequiredError}
|
|
685
|
-
* @memberof OAuthApiInterface
|
|
686
|
-
*/
|
|
687
|
-
submitLogin(requestParameters: OAuthApiSubmitLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
688
622
|
/**
|
|
689
623
|
* Establishes the end-user browser session from JSON credentials so a following /oauth/authorize request issues a code without showing the hosted login page. Deliberately mints no tokens. Only accepted from trusted origins.
|
|
690
624
|
* @summary Programmatic (JSON) login for the authorization flow
|
|
@@ -823,19 +757,6 @@ export interface OAuthApiParRequest {
|
|
|
823
757
|
*/
|
|
824
758
|
readonly orgId: string;
|
|
825
759
|
}
|
|
826
|
-
/**
|
|
827
|
-
* Request parameters for passkeyLogin operation in OAuthApi.
|
|
828
|
-
* @export
|
|
829
|
-
* @interface OAuthApiPasskeyLoginRequest
|
|
830
|
-
*/
|
|
831
|
-
export interface OAuthApiPasskeyLoginRequest {
|
|
832
|
-
/**
|
|
833
|
-
*
|
|
834
|
-
* @type {string}
|
|
835
|
-
* @memberof OAuthApiPasskeyLogin
|
|
836
|
-
*/
|
|
837
|
-
readonly orgId: string;
|
|
838
|
-
}
|
|
839
760
|
/**
|
|
840
761
|
* Request parameters for registerClient operation in OAuthApi.
|
|
841
762
|
* @export
|
|
@@ -945,19 +866,6 @@ export interface OAuthApiSubmitDeviceVerificationRequest {
|
|
|
945
866
|
*/
|
|
946
867
|
readonly orgId: string;
|
|
947
868
|
}
|
|
948
|
-
/**
|
|
949
|
-
* Request parameters for submitLogin operation in OAuthApi.
|
|
950
|
-
* @export
|
|
951
|
-
* @interface OAuthApiSubmitLoginRequest
|
|
952
|
-
*/
|
|
953
|
-
export interface OAuthApiSubmitLoginRequest {
|
|
954
|
-
/**
|
|
955
|
-
*
|
|
956
|
-
* @type {string}
|
|
957
|
-
* @memberof OAuthApiSubmitLogin
|
|
958
|
-
*/
|
|
959
|
-
readonly orgId: string;
|
|
960
|
-
}
|
|
961
869
|
/**
|
|
962
870
|
* Request parameters for submitLoginJson operation in OAuthApi.
|
|
963
871
|
* @export
|
|
@@ -1076,15 +984,6 @@ export declare class OAuthApi extends BaseAPI implements OAuthApiInterface {
|
|
|
1076
984
|
* @memberof OAuthApi
|
|
1077
985
|
*/
|
|
1078
986
|
par(requestParameters: OAuthApiParRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ParResponse, any, {}>>;
|
|
1079
|
-
/**
|
|
1080
|
-
* Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
|
|
1081
|
-
* @summary Passkey login entry point
|
|
1082
|
-
* @param {OAuthApiPasskeyLoginRequest} requestParameters Request parameters.
|
|
1083
|
-
* @param {*} [options] Override http request option.
|
|
1084
|
-
* @throws {RequiredError}
|
|
1085
|
-
* @memberof OAuthApi
|
|
1086
|
-
*/
|
|
1087
|
-
passkeyLogin(requestParameters: OAuthApiPasskeyLoginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1088
987
|
/**
|
|
1089
988
|
* Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
|
|
1090
989
|
* @summary Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
@@ -1148,15 +1047,6 @@ export declare class OAuthApi extends BaseAPI implements OAuthApiInterface {
|
|
|
1148
1047
|
* @memberof OAuthApi
|
|
1149
1048
|
*/
|
|
1150
1049
|
submitDeviceVerification(requestParameters: OAuthApiSubmitDeviceVerificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
1151
|
-
/**
|
|
1152
|
-
* Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
|
|
1153
|
-
* @summary Hosted login form submission
|
|
1154
|
-
* @param {OAuthApiSubmitLoginRequest} requestParameters Request parameters.
|
|
1155
|
-
* @param {*} [options] Override http request option.
|
|
1156
|
-
* @throws {RequiredError}
|
|
1157
|
-
* @memberof OAuthApi
|
|
1158
|
-
*/
|
|
1159
|
-
submitLogin(requestParameters: OAuthApiSubmitLoginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1160
1050
|
/**
|
|
1161
1051
|
* Establishes the end-user browser session from JSON credentials so a following /oauth/authorize request issues a code without showing the hosted login page. Deliberately mints no tokens. Only accepted from trusted origins.
|
|
1162
1052
|
* @summary Programmatic (JSON) login for the authorization flow
|
|
@@ -285,35 +285,6 @@ export const OAuthApiAxiosParamCreator = function (configuration) {
|
|
|
285
285
|
options: localVarRequestOptions,
|
|
286
286
|
};
|
|
287
287
|
}),
|
|
288
|
-
/**
|
|
289
|
-
* Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
|
|
290
|
-
* @summary Passkey login entry point
|
|
291
|
-
* @param {string} orgId
|
|
292
|
-
* @param {*} [options] Override http request option.
|
|
293
|
-
* @throws {RequiredError}
|
|
294
|
-
*/
|
|
295
|
-
passkeyLogin: (orgId_1, ...args_1) => __awaiter(this, [orgId_1, ...args_1], void 0, function* (orgId, options = {}) {
|
|
296
|
-
// verify required parameter 'orgId' is not null or undefined
|
|
297
|
-
assertParamExists('passkeyLogin', 'orgId', orgId);
|
|
298
|
-
const localVarPath = `/orgs/{orgId}/api/v1/oauth/passkey-login`
|
|
299
|
-
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
|
|
300
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
301
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
302
|
-
let baseOptions;
|
|
303
|
-
if (configuration) {
|
|
304
|
-
baseOptions = configuration.baseOptions;
|
|
305
|
-
}
|
|
306
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
307
|
-
const localVarHeaderParameter = {};
|
|
308
|
-
const localVarQueryParameter = {};
|
|
309
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
310
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
311
|
-
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
312
|
-
return {
|
|
313
|
-
url: toPathString(localVarUrlObj),
|
|
314
|
-
options: localVarRequestOptions,
|
|
315
|
-
};
|
|
316
|
-
}),
|
|
317
288
|
/**
|
|
318
289
|
* Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
|
|
319
290
|
* @summary Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
@@ -537,35 +508,6 @@ export const OAuthApiAxiosParamCreator = function (configuration) {
|
|
|
537
508
|
options: localVarRequestOptions,
|
|
538
509
|
};
|
|
539
510
|
}),
|
|
540
|
-
/**
|
|
541
|
-
* Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
|
|
542
|
-
* @summary Hosted login form submission
|
|
543
|
-
* @param {string} orgId
|
|
544
|
-
* @param {*} [options] Override http request option.
|
|
545
|
-
* @throws {RequiredError}
|
|
546
|
-
*/
|
|
547
|
-
submitLogin: (orgId_1, ...args_1) => __awaiter(this, [orgId_1, ...args_1], void 0, function* (orgId, options = {}) {
|
|
548
|
-
// verify required parameter 'orgId' is not null or undefined
|
|
549
|
-
assertParamExists('submitLogin', 'orgId', orgId);
|
|
550
|
-
const localVarPath = `/orgs/{orgId}/api/v1/oauth/login/submit`
|
|
551
|
-
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
|
|
552
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
553
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
554
|
-
let baseOptions;
|
|
555
|
-
if (configuration) {
|
|
556
|
-
baseOptions = configuration.baseOptions;
|
|
557
|
-
}
|
|
558
|
-
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
559
|
-
const localVarHeaderParameter = {};
|
|
560
|
-
const localVarQueryParameter = {};
|
|
561
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
562
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
563
|
-
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
564
|
-
return {
|
|
565
|
-
url: toPathString(localVarUrlObj),
|
|
566
|
-
options: localVarRequestOptions,
|
|
567
|
-
};
|
|
568
|
-
}),
|
|
569
511
|
/**
|
|
570
512
|
* Establishes the end-user browser session from JSON credentials so a following /oauth/authorize request issues a code without showing the hosted login page. Deliberately mints no tokens. Only accepted from trusted origins.
|
|
571
513
|
* @summary Programmatic (JSON) login for the authorization flow
|
|
@@ -794,22 +736,6 @@ export const OAuthApiFp = function (configuration) {
|
|
|
794
736
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
795
737
|
});
|
|
796
738
|
},
|
|
797
|
-
/**
|
|
798
|
-
* Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
|
|
799
|
-
* @summary Passkey login entry point
|
|
800
|
-
* @param {string} orgId
|
|
801
|
-
* @param {*} [options] Override http request option.
|
|
802
|
-
* @throws {RequiredError}
|
|
803
|
-
*/
|
|
804
|
-
passkeyLogin(orgId, options) {
|
|
805
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
806
|
-
var _a, _b, _c;
|
|
807
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.passkeyLogin(orgId, options);
|
|
808
|
-
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
809
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OAuthApi.passkeyLogin']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
810
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
811
|
-
});
|
|
812
|
-
},
|
|
813
739
|
/**
|
|
814
740
|
* Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
|
|
815
741
|
* @summary Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
@@ -925,22 +851,6 @@ export const OAuthApiFp = function (configuration) {
|
|
|
925
851
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
926
852
|
});
|
|
927
853
|
},
|
|
928
|
-
/**
|
|
929
|
-
* Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
|
|
930
|
-
* @summary Hosted login form submission
|
|
931
|
-
* @param {string} orgId
|
|
932
|
-
* @param {*} [options] Override http request option.
|
|
933
|
-
* @throws {RequiredError}
|
|
934
|
-
*/
|
|
935
|
-
submitLogin(orgId, options) {
|
|
936
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
937
|
-
var _a, _b, _c;
|
|
938
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.submitLogin(orgId, options);
|
|
939
|
-
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
940
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OAuthApi.submitLogin']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
941
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
942
|
-
});
|
|
943
|
-
},
|
|
944
854
|
/**
|
|
945
855
|
* Establishes the end-user browser session from JSON credentials so a following /oauth/authorize request issues a code without showing the hosted login page. Deliberately mints no tokens. Only accepted from trusted origins.
|
|
946
856
|
* @summary Programmatic (JSON) login for the authorization flow
|
|
@@ -1078,16 +988,6 @@ export const OAuthApiFactory = function (configuration, basePath, axios) {
|
|
|
1078
988
|
par(requestParameters, options) {
|
|
1079
989
|
return localVarFp.par(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1080
990
|
},
|
|
1081
|
-
/**
|
|
1082
|
-
* Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
|
|
1083
|
-
* @summary Passkey login entry point
|
|
1084
|
-
* @param {OAuthApiPasskeyLoginRequest} requestParameters Request parameters.
|
|
1085
|
-
* @param {*} [options] Override http request option.
|
|
1086
|
-
* @throws {RequiredError}
|
|
1087
|
-
*/
|
|
1088
|
-
passkeyLogin(requestParameters, options) {
|
|
1089
|
-
return localVarFp.passkeyLogin(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1090
|
-
},
|
|
1091
991
|
/**
|
|
1092
992
|
* Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
|
|
1093
993
|
* @summary Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
@@ -1158,16 +1058,6 @@ export const OAuthApiFactory = function (configuration, basePath, axios) {
|
|
|
1158
1058
|
submitDeviceVerification(requestParameters, options) {
|
|
1159
1059
|
return localVarFp.submitDeviceVerification(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1160
1060
|
},
|
|
1161
|
-
/**
|
|
1162
|
-
* Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
|
|
1163
|
-
* @summary Hosted login form submission
|
|
1164
|
-
* @param {OAuthApiSubmitLoginRequest} requestParameters Request parameters.
|
|
1165
|
-
* @param {*} [options] Override http request option.
|
|
1166
|
-
* @throws {RequiredError}
|
|
1167
|
-
*/
|
|
1168
|
-
submitLogin(requestParameters, options) {
|
|
1169
|
-
return localVarFp.submitLogin(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
1170
|
-
},
|
|
1171
1061
|
/**
|
|
1172
1062
|
* Establishes the end-user browser session from JSON credentials so a following /oauth/authorize request issues a code without showing the hosted login page. Deliberately mints no tokens. Only accepted from trusted origins.
|
|
1173
1063
|
* @summary Programmatic (JSON) login for the authorization flow
|
|
@@ -1295,17 +1185,6 @@ export class OAuthApi extends BaseAPI {
|
|
|
1295
1185
|
par(requestParameters, options) {
|
|
1296
1186
|
return OAuthApiFp(this.configuration).par(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
1297
1187
|
}
|
|
1298
|
-
/**
|
|
1299
|
-
* Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
|
|
1300
|
-
* @summary Passkey login entry point
|
|
1301
|
-
* @param {OAuthApiPasskeyLoginRequest} requestParameters Request parameters.
|
|
1302
|
-
* @param {*} [options] Override http request option.
|
|
1303
|
-
* @throws {RequiredError}
|
|
1304
|
-
* @memberof OAuthApi
|
|
1305
|
-
*/
|
|
1306
|
-
passkeyLogin(requestParameters, options) {
|
|
1307
|
-
return OAuthApiFp(this.configuration).passkeyLogin(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
1308
|
-
}
|
|
1309
1188
|
/**
|
|
1310
1189
|
* Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
|
|
1311
1190
|
* @summary Dynamic client registration (RFC 7591 / OIDC DCR)
|
|
@@ -1383,17 +1262,6 @@ export class OAuthApi extends BaseAPI {
|
|
|
1383
1262
|
submitDeviceVerification(requestParameters, options) {
|
|
1384
1263
|
return OAuthApiFp(this.configuration).submitDeviceVerification(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
1385
1264
|
}
|
|
1386
|
-
/**
|
|
1387
|
-
* Receives the hosted OAuth login page\'s form (email, password, csrf token and the authorization request parameters). Every outcome — success, invalid credentials, locked account, captcha or CSRF failure — answers with the same redirect back to /oauth/authorize, which re-renders the login page or continues the flow. Not a JSON API.
|
|
1388
|
-
* @summary Hosted login form submission
|
|
1389
|
-
* @param {OAuthApiSubmitLoginRequest} requestParameters Request parameters.
|
|
1390
|
-
* @param {*} [options] Override http request option.
|
|
1391
|
-
* @throws {RequiredError}
|
|
1392
|
-
* @memberof OAuthApi
|
|
1393
|
-
*/
|
|
1394
|
-
submitLogin(requestParameters, options) {
|
|
1395
|
-
return OAuthApiFp(this.configuration).submitLogin(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
1396
|
-
}
|
|
1397
1265
|
/**
|
|
1398
1266
|
* Establishes the end-user browser session from JSON credentials so a following /oauth/authorize request issues a code without showing the hosted login page. Deliberately mints no tokens. Only accepted from trusted origins.
|
|
1399
1267
|
* @summary Programmatic (JSON) login for the authorization flow
|
|
@@ -22,7 +22,7 @@ import type { OpenIdConfiguration } from '../models';
|
|
|
22
22
|
*/
|
|
23
23
|
export declare const WellKnownApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
24
|
/**
|
|
25
|
-
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
|
|
25
|
+
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. RFC 8414 clients read it from /.well-known/oauth-authorization-server/orgs/{orgId}/api/v1 (the issuer\'s path-inserted location) and, on a verified custom domain, from /.well-known/oauth-authorization-server.
|
|
26
26
|
* @summary OAuth 2.0 authorization server metadata (RFC 8414)
|
|
27
27
|
* @param {string} orgId
|
|
28
28
|
* @param {*} [options] Override http request option.
|
|
@@ -38,7 +38,7 @@ export declare const WellKnownApiAxiosParamCreator: (configuration?: Configurati
|
|
|
38
38
|
*/
|
|
39
39
|
getJwks: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
40
|
/**
|
|
41
|
-
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
|
|
41
|
+
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. The same document is served at the RFC 8414 location /.well-known/openid-configuration/orgs/{orgId}/api/v1 and, on a verified custom domain (whose issuer is the bare domain), at /.well-known/openid-configuration.
|
|
42
42
|
* @summary OpenID Provider configuration (OIDC Discovery 1.0)
|
|
43
43
|
* @param {string} orgId
|
|
44
44
|
* @param {*} [options] Override http request option.
|
|
@@ -60,7 +60,7 @@ export declare const WellKnownApiAxiosParamCreator: (configuration?: Configurati
|
|
|
60
60
|
*/
|
|
61
61
|
export declare const WellKnownApiFp: (configuration?: Configuration) => {
|
|
62
62
|
/**
|
|
63
|
-
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
|
|
63
|
+
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. RFC 8414 clients read it from /.well-known/oauth-authorization-server/orgs/{orgId}/api/v1 (the issuer\'s path-inserted location) and, on a verified custom domain, from /.well-known/oauth-authorization-server.
|
|
64
64
|
* @summary OAuth 2.0 authorization server metadata (RFC 8414)
|
|
65
65
|
* @param {string} orgId
|
|
66
66
|
* @param {*} [options] Override http request option.
|
|
@@ -76,7 +76,7 @@ export declare const WellKnownApiFp: (configuration?: Configuration) => {
|
|
|
76
76
|
*/
|
|
77
77
|
getJwks(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonWebKeySet>>;
|
|
78
78
|
/**
|
|
79
|
-
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
|
|
79
|
+
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. The same document is served at the RFC 8414 location /.well-known/openid-configuration/orgs/{orgId}/api/v1 and, on a verified custom domain (whose issuer is the bare domain), at /.well-known/openid-configuration.
|
|
80
80
|
* @summary OpenID Provider configuration (OIDC Discovery 1.0)
|
|
81
81
|
* @param {string} orgId
|
|
82
82
|
* @param {*} [options] Override http request option.
|
|
@@ -98,7 +98,7 @@ export declare const WellKnownApiFp: (configuration?: Configuration) => {
|
|
|
98
98
|
*/
|
|
99
99
|
export declare const WellKnownApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
100
100
|
/**
|
|
101
|
-
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
|
|
101
|
+
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. RFC 8414 clients read it from /.well-known/oauth-authorization-server/orgs/{orgId}/api/v1 (the issuer\'s path-inserted location) and, on a verified custom domain, from /.well-known/oauth-authorization-server.
|
|
102
102
|
* @summary OAuth 2.0 authorization server metadata (RFC 8414)
|
|
103
103
|
* @param {WellKnownApiGetAuthorizationServerMetadataRequest} requestParameters Request parameters.
|
|
104
104
|
* @param {*} [options] Override http request option.
|
|
@@ -114,7 +114,7 @@ export declare const WellKnownApiFactory: (configuration?: Configuration, basePa
|
|
|
114
114
|
*/
|
|
115
115
|
getJwks(requestParameters: WellKnownApiGetJwksRequest, options?: RawAxiosRequestConfig): AxiosPromise<JsonWebKeySet>;
|
|
116
116
|
/**
|
|
117
|
-
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
|
|
117
|
+
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. The same document is served at the RFC 8414 location /.well-known/openid-configuration/orgs/{orgId}/api/v1 and, on a verified custom domain (whose issuer is the bare domain), at /.well-known/openid-configuration.
|
|
118
118
|
* @summary OpenID Provider configuration (OIDC Discovery 1.0)
|
|
119
119
|
* @param {WellKnownApiGetOpenidConfigurationRequest} requestParameters Request parameters.
|
|
120
120
|
* @param {*} [options] Override http request option.
|
|
@@ -137,7 +137,7 @@ export declare const WellKnownApiFactory: (configuration?: Configuration, basePa
|
|
|
137
137
|
*/
|
|
138
138
|
export interface WellKnownApiInterface {
|
|
139
139
|
/**
|
|
140
|
-
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
|
|
140
|
+
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. RFC 8414 clients read it from /.well-known/oauth-authorization-server/orgs/{orgId}/api/v1 (the issuer\'s path-inserted location) and, on a verified custom domain, from /.well-known/oauth-authorization-server.
|
|
141
141
|
* @summary OAuth 2.0 authorization server metadata (RFC 8414)
|
|
142
142
|
* @param {WellKnownApiGetAuthorizationServerMetadataRequest} requestParameters Request parameters.
|
|
143
143
|
* @param {*} [options] Override http request option.
|
|
@@ -155,7 +155,7 @@ export interface WellKnownApiInterface {
|
|
|
155
155
|
*/
|
|
156
156
|
getJwks(requestParameters: WellKnownApiGetJwksRequest, options?: RawAxiosRequestConfig): AxiosPromise<JsonWebKeySet>;
|
|
157
157
|
/**
|
|
158
|
-
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
|
|
158
|
+
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. The same document is served at the RFC 8414 location /.well-known/openid-configuration/orgs/{orgId}/api/v1 and, on a verified custom domain (whose issuer is the bare domain), at /.well-known/openid-configuration.
|
|
159
159
|
* @summary OpenID Provider configuration (OIDC Discovery 1.0)
|
|
160
160
|
* @param {WellKnownApiGetOpenidConfigurationRequest} requestParameters Request parameters.
|
|
161
161
|
* @param {*} [options] Override http request option.
|
|
@@ -233,7 +233,7 @@ export interface WellKnownApiGetSsfConfigurationRequest {
|
|
|
233
233
|
*/
|
|
234
234
|
export declare class WellKnownApi extends BaseAPI implements WellKnownApiInterface {
|
|
235
235
|
/**
|
|
236
|
-
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
|
|
236
|
+
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. RFC 8414 clients read it from /.well-known/oauth-authorization-server/orgs/{orgId}/api/v1 (the issuer\'s path-inserted location) and, on a verified custom domain, from /.well-known/oauth-authorization-server.
|
|
237
237
|
* @summary OAuth 2.0 authorization server metadata (RFC 8414)
|
|
238
238
|
* @param {WellKnownApiGetAuthorizationServerMetadataRequest} requestParameters Request parameters.
|
|
239
239
|
* @param {*} [options] Override http request option.
|
|
@@ -251,7 +251,7 @@ export declare class WellKnownApi extends BaseAPI implements WellKnownApiInterfa
|
|
|
251
251
|
*/
|
|
252
252
|
getJwks(requestParameters: WellKnownApiGetJwksRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JsonWebKeySet, any, {}>>;
|
|
253
253
|
/**
|
|
254
|
-
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active.
|
|
254
|
+
* Public, CORS-enabled and cacheable (Cache-Control: public, max-age=3600). Endpoint URLs are rewritten to the organization\'s custom domain when one is active. The same document is served at the RFC 8414 location /.well-known/openid-configuration/orgs/{orgId}/api/v1 and, on a verified custom domain (whose issuer is the bare domain), at /.well-known/openid-configuration.
|
|
255
255
|
* @summary OpenID Provider configuration (OIDC Discovery 1.0)
|
|
256
256
|
* @param {WellKnownApiGetOpenidConfigurationRequest} requestParameters Request parameters.
|
|
257
257
|
* @param {*} [options] Override http request option.
|