@lumoauth/api-client 1.2.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 +10 -0
- package/README.md +10 -4
- package/api/admin-email-api.ts +67 -15
- package/api/admin-oauth-clients-api.ts +370 -0
- package/api/oauth-api.ts +0 -186
- package/dist/api/admin-email-api.d.ts +41 -9
- package/dist/api/admin-email-api.js +34 -14
- package/dist/api/admin-oauth-clients-api.d.ts +210 -0
- package/dist/api/admin-oauth-clients-api.js +236 -0
- package/dist/api/oauth-api.d.ts +0 -110
- package/dist/api/oauth-api.js +0 -132
- 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-oauth-clients-api.d.ts +210 -0
- package/dist/esm/api/admin-oauth-clients-api.js +236 -0
- package/dist/esm/api/oauth-api.d.ts +0 -110
- package/dist/esm/api/oauth-api.js +0 -132
- 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/authorization-server-metadata.d.ts +0 -6
- package/dist/esm/models/index.d.ts +5 -0
- package/dist/esm/models/index.js +5 -0
- package/dist/esm/models/open-id-configuration.d.ts +6 -6
- 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/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/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/authorization-server-metadata.d.ts +0 -6
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/dist/models/open-id-configuration.d.ts +6 -6
- 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/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/docs/AdminClientsGetBrandingResponse.md +20 -0
- package/docs/AdminClientsGetBrandingResponseData.md +22 -0
- package/docs/AdminEmailApi.md +15 -2
- package/docs/AdminOAuthClientsApi.md +174 -0
- package/docs/AuthorizationServerMetadata.md +0 -2
- package/docs/OAuthApi.md +0 -105
- package/docs/OpenIdConfiguration.md +2 -2
- package/docs/PatchAdminClientsUpdateBrandingResponse.md +22 -0
- package/docs/PutAdminClientsUpdateBrandingRequest.md +22 -0
- package/docs/PutAdminClientsUpdateBrandingResponse.md +22 -0
- package/models/admin-clients-get-branding-response-data.ts +36 -0
- package/models/admin-clients-get-branding-response.ts +33 -0
- package/models/authorization-server-metadata.ts +0 -6
- package/models/index.ts +5 -0
- package/models/open-id-configuration.ts +6 -6
- package/models/patch-admin-clients-update-branding-response.ts +36 -0
- package/models/put-admin-clients-update-branding-request.ts +36 -0
- package/models/put-admin-clients-update-branding-response.ts +36 -0
- package/package.json +1 -1
|
@@ -71,6 +71,44 @@ export const AdminOAuthClientsApiAxiosParamCreator = function (configuration) {
|
|
|
71
71
|
options: localVarRequestOptions,
|
|
72
72
|
};
|
|
73
73
|
}),
|
|
74
|
+
/**
|
|
75
|
+
* Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
|
|
76
|
+
* @summary Get an OAuth client\'s login and consent page branding
|
|
77
|
+
* @param {string} orgId
|
|
78
|
+
* @param {string} clientId
|
|
79
|
+
* @param {*} [options] Override http request option.
|
|
80
|
+
* @throws {RequiredError}
|
|
81
|
+
*/
|
|
82
|
+
adminClientsGetBranding: (orgId_1, clientId_1, ...args_1) => __awaiter(this, [orgId_1, clientId_1, ...args_1], void 0, function* (orgId, clientId, options = {}) {
|
|
83
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
84
|
+
assertParamExists('adminClientsGetBranding', 'orgId', orgId);
|
|
85
|
+
// verify required parameter 'clientId' is not null or undefined
|
|
86
|
+
assertParamExists('adminClientsGetBranding', 'clientId', clientId);
|
|
87
|
+
const localVarPath = `/orgs/{orgId}/api/v1/admin/clients/{clientId}/branding`
|
|
88
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)))
|
|
89
|
+
.replace(`{${"clientId"}}`, encodeURIComponent(String(clientId)));
|
|
90
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
91
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
92
|
+
let baseOptions;
|
|
93
|
+
if (configuration) {
|
|
94
|
+
baseOptions = configuration.baseOptions;
|
|
95
|
+
}
|
|
96
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
97
|
+
const localVarHeaderParameter = {};
|
|
98
|
+
const localVarQueryParameter = {};
|
|
99
|
+
// authentication ApiKeyAuth required
|
|
100
|
+
yield setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration);
|
|
101
|
+
// authentication BearerAuth required
|
|
102
|
+
// http bearer authentication required
|
|
103
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
104
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
105
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
106
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
107
|
+
return {
|
|
108
|
+
url: toPathString(localVarUrlObj),
|
|
109
|
+
options: localVarRequestOptions,
|
|
110
|
+
};
|
|
111
|
+
}),
|
|
74
112
|
/**
|
|
75
113
|
*
|
|
76
114
|
* @summary Create an OAuth client
|
|
@@ -329,6 +367,47 @@ export const AdminOAuthClientsApiAxiosParamCreator = function (configuration) {
|
|
|
329
367
|
options: localVarRequestOptions,
|
|
330
368
|
};
|
|
331
369
|
}),
|
|
370
|
+
/**
|
|
371
|
+
*
|
|
372
|
+
* @summary Change keys of an OAuth client\'s login and/or consent page branding
|
|
373
|
+
* @param {string} orgId
|
|
374
|
+
* @param {string} clientId
|
|
375
|
+
* @param {AdminClientsGetBrandingResponseData} [adminClientsGetBrandingResponseData]
|
|
376
|
+
* @param {*} [options] Override http request option.
|
|
377
|
+
* @throws {RequiredError}
|
|
378
|
+
*/
|
|
379
|
+
patchAdminClientsUpdateBranding: (orgId_1, clientId_1, adminClientsGetBrandingResponseData_1, ...args_1) => __awaiter(this, [orgId_1, clientId_1, adminClientsGetBrandingResponseData_1, ...args_1], void 0, function* (orgId, clientId, adminClientsGetBrandingResponseData, options = {}) {
|
|
380
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
381
|
+
assertParamExists('patchAdminClientsUpdateBranding', 'orgId', orgId);
|
|
382
|
+
// verify required parameter 'clientId' is not null or undefined
|
|
383
|
+
assertParamExists('patchAdminClientsUpdateBranding', 'clientId', clientId);
|
|
384
|
+
const localVarPath = `/orgs/{orgId}/api/v1/admin/clients/{clientId}/branding`
|
|
385
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)))
|
|
386
|
+
.replace(`{${"clientId"}}`, encodeURIComponent(String(clientId)));
|
|
387
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
388
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
389
|
+
let baseOptions;
|
|
390
|
+
if (configuration) {
|
|
391
|
+
baseOptions = configuration.baseOptions;
|
|
392
|
+
}
|
|
393
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
394
|
+
const localVarHeaderParameter = {};
|
|
395
|
+
const localVarQueryParameter = {};
|
|
396
|
+
// authentication ApiKeyAuth required
|
|
397
|
+
yield setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration);
|
|
398
|
+
// authentication BearerAuth required
|
|
399
|
+
// http bearer authentication required
|
|
400
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
401
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
402
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
403
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
404
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
405
|
+
localVarRequestOptions.data = serializeDataIfNeeded(adminClientsGetBrandingResponseData, localVarRequestOptions, configuration);
|
|
406
|
+
return {
|
|
407
|
+
url: toPathString(localVarUrlObj),
|
|
408
|
+
options: localVarRequestOptions,
|
|
409
|
+
};
|
|
410
|
+
}),
|
|
332
411
|
/**
|
|
333
412
|
*
|
|
334
413
|
* @summary Update an OAuth client
|
|
@@ -367,6 +446,47 @@ export const AdminOAuthClientsApiAxiosParamCreator = function (configuration) {
|
|
|
367
446
|
options: localVarRequestOptions,
|
|
368
447
|
};
|
|
369
448
|
}),
|
|
449
|
+
/**
|
|
450
|
+
*
|
|
451
|
+
* @summary Replace an OAuth client\'s login and/or consent page branding
|
|
452
|
+
* @param {string} orgId
|
|
453
|
+
* @param {string} clientId
|
|
454
|
+
* @param {PutAdminClientsUpdateBrandingRequest} [putAdminClientsUpdateBrandingRequest]
|
|
455
|
+
* @param {*} [options] Override http request option.
|
|
456
|
+
* @throws {RequiredError}
|
|
457
|
+
*/
|
|
458
|
+
putAdminClientsUpdateBranding: (orgId_1, clientId_1, putAdminClientsUpdateBrandingRequest_1, ...args_1) => __awaiter(this, [orgId_1, clientId_1, putAdminClientsUpdateBrandingRequest_1, ...args_1], void 0, function* (orgId, clientId, putAdminClientsUpdateBrandingRequest, options = {}) {
|
|
459
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
460
|
+
assertParamExists('putAdminClientsUpdateBranding', 'orgId', orgId);
|
|
461
|
+
// verify required parameter 'clientId' is not null or undefined
|
|
462
|
+
assertParamExists('putAdminClientsUpdateBranding', 'clientId', clientId);
|
|
463
|
+
const localVarPath = `/orgs/{orgId}/api/v1/admin/clients/{clientId}/branding`
|
|
464
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)))
|
|
465
|
+
.replace(`{${"clientId"}}`, encodeURIComponent(String(clientId)));
|
|
466
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
467
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
468
|
+
let baseOptions;
|
|
469
|
+
if (configuration) {
|
|
470
|
+
baseOptions = configuration.baseOptions;
|
|
471
|
+
}
|
|
472
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
473
|
+
const localVarHeaderParameter = {};
|
|
474
|
+
const localVarQueryParameter = {};
|
|
475
|
+
// authentication ApiKeyAuth required
|
|
476
|
+
yield setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration);
|
|
477
|
+
// authentication BearerAuth required
|
|
478
|
+
// http bearer authentication required
|
|
479
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
480
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
481
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
482
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
483
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
484
|
+
localVarRequestOptions.data = serializeDataIfNeeded(putAdminClientsUpdateBrandingRequest, localVarRequestOptions, configuration);
|
|
485
|
+
return {
|
|
486
|
+
url: toPathString(localVarUrlObj),
|
|
487
|
+
options: localVarRequestOptions,
|
|
488
|
+
};
|
|
489
|
+
}),
|
|
370
490
|
/**
|
|
371
491
|
*
|
|
372
492
|
* @summary Rotate an OAuth client secret
|
|
@@ -507,6 +627,23 @@ export const AdminOAuthClientsApiFp = function (configuration) {
|
|
|
507
627
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
508
628
|
});
|
|
509
629
|
},
|
|
630
|
+
/**
|
|
631
|
+
* Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
|
|
632
|
+
* @summary Get an OAuth client\'s login and consent page branding
|
|
633
|
+
* @param {string} orgId
|
|
634
|
+
* @param {string} clientId
|
|
635
|
+
* @param {*} [options] Override http request option.
|
|
636
|
+
* @throws {RequiredError}
|
|
637
|
+
*/
|
|
638
|
+
adminClientsGetBranding(orgId, clientId, options) {
|
|
639
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
640
|
+
var _a, _b, _c;
|
|
641
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminClientsGetBranding(orgId, clientId, options);
|
|
642
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
643
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminOAuthClientsApi.adminClientsGetBranding']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
644
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
645
|
+
});
|
|
646
|
+
},
|
|
510
647
|
/**
|
|
511
648
|
*
|
|
512
649
|
* @summary Create an OAuth client
|
|
@@ -624,6 +761,24 @@ export const AdminOAuthClientsApiFp = function (configuration) {
|
|
|
624
761
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
625
762
|
});
|
|
626
763
|
},
|
|
764
|
+
/**
|
|
765
|
+
*
|
|
766
|
+
* @summary Change keys of an OAuth client\'s login and/or consent page branding
|
|
767
|
+
* @param {string} orgId
|
|
768
|
+
* @param {string} clientId
|
|
769
|
+
* @param {AdminClientsGetBrandingResponseData} [adminClientsGetBrandingResponseData]
|
|
770
|
+
* @param {*} [options] Override http request option.
|
|
771
|
+
* @throws {RequiredError}
|
|
772
|
+
*/
|
|
773
|
+
patchAdminClientsUpdateBranding(orgId, clientId, adminClientsGetBrandingResponseData, options) {
|
|
774
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
775
|
+
var _a, _b, _c;
|
|
776
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.patchAdminClientsUpdateBranding(orgId, clientId, adminClientsGetBrandingResponseData, options);
|
|
777
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
778
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminOAuthClientsApi.patchAdminClientsUpdateBranding']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
779
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
780
|
+
});
|
|
781
|
+
},
|
|
627
782
|
/**
|
|
628
783
|
*
|
|
629
784
|
* @summary Update an OAuth client
|
|
@@ -641,6 +796,24 @@ export const AdminOAuthClientsApiFp = function (configuration) {
|
|
|
641
796
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
642
797
|
});
|
|
643
798
|
},
|
|
799
|
+
/**
|
|
800
|
+
*
|
|
801
|
+
* @summary Replace an OAuth client\'s login and/or consent page branding
|
|
802
|
+
* @param {string} orgId
|
|
803
|
+
* @param {string} clientId
|
|
804
|
+
* @param {PutAdminClientsUpdateBrandingRequest} [putAdminClientsUpdateBrandingRequest]
|
|
805
|
+
* @param {*} [options] Override http request option.
|
|
806
|
+
* @throws {RequiredError}
|
|
807
|
+
*/
|
|
808
|
+
putAdminClientsUpdateBranding(orgId, clientId, putAdminClientsUpdateBrandingRequest, options) {
|
|
809
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
810
|
+
var _a, _b, _c;
|
|
811
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.putAdminClientsUpdateBranding(orgId, clientId, putAdminClientsUpdateBrandingRequest, options);
|
|
812
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
813
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminOAuthClientsApi.putAdminClientsUpdateBranding']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
814
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
815
|
+
});
|
|
816
|
+
},
|
|
644
817
|
/**
|
|
645
818
|
*
|
|
646
819
|
* @summary Rotate an OAuth client secret
|
|
@@ -711,6 +884,16 @@ export const AdminOAuthClientsApiFactory = function (configuration, basePath, ax
|
|
|
711
884
|
adminClientsCimdCheck(requestParameters, options) {
|
|
712
885
|
return localVarFp.adminClientsCimdCheck(requestParameters.orgId, requestParameters.adminClientsCimdCheckRequest, options).then((request) => request(axios, basePath));
|
|
713
886
|
},
|
|
887
|
+
/**
|
|
888
|
+
* Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
|
|
889
|
+
* @summary Get an OAuth client\'s login and consent page branding
|
|
890
|
+
* @param {AdminOAuthClientsApiAdminClientsGetBrandingRequest} requestParameters Request parameters.
|
|
891
|
+
* @param {*} [options] Override http request option.
|
|
892
|
+
* @throws {RequiredError}
|
|
893
|
+
*/
|
|
894
|
+
adminClientsGetBranding(requestParameters, options) {
|
|
895
|
+
return localVarFp.adminClientsGetBranding(requestParameters.orgId, requestParameters.clientId, options).then((request) => request(axios, basePath));
|
|
896
|
+
},
|
|
714
897
|
/**
|
|
715
898
|
*
|
|
716
899
|
* @summary Create an OAuth client
|
|
@@ -781,6 +964,16 @@ export const AdminOAuthClientsApiFactory = function (configuration, basePath, ax
|
|
|
781
964
|
listClients(requestParameters, options) {
|
|
782
965
|
return localVarFp.listClients(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
783
966
|
},
|
|
967
|
+
/**
|
|
968
|
+
*
|
|
969
|
+
* @summary Change keys of an OAuth client\'s login and/or consent page branding
|
|
970
|
+
* @param {AdminOAuthClientsApiPatchAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
|
|
971
|
+
* @param {*} [options] Override http request option.
|
|
972
|
+
* @throws {RequiredError}
|
|
973
|
+
*/
|
|
974
|
+
patchAdminClientsUpdateBranding(requestParameters, options) {
|
|
975
|
+
return localVarFp.patchAdminClientsUpdateBranding(requestParameters.orgId, requestParameters.clientId, requestParameters.adminClientsGetBrandingResponseData, options).then((request) => request(axios, basePath));
|
|
976
|
+
},
|
|
784
977
|
/**
|
|
785
978
|
*
|
|
786
979
|
* @summary Update an OAuth client
|
|
@@ -791,6 +984,16 @@ export const AdminOAuthClientsApiFactory = function (configuration, basePath, ax
|
|
|
791
984
|
patchClient(requestParameters, options) {
|
|
792
985
|
return localVarFp.patchClient(requestParameters.orgId, requestParameters.clientId, options).then((request) => request(axios, basePath));
|
|
793
986
|
},
|
|
987
|
+
/**
|
|
988
|
+
*
|
|
989
|
+
* @summary Replace an OAuth client\'s login and/or consent page branding
|
|
990
|
+
* @param {AdminOAuthClientsApiPutAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
|
|
991
|
+
* @param {*} [options] Override http request option.
|
|
992
|
+
* @throws {RequiredError}
|
|
993
|
+
*/
|
|
994
|
+
putAdminClientsUpdateBranding(requestParameters, options) {
|
|
995
|
+
return localVarFp.putAdminClientsUpdateBranding(requestParameters.orgId, requestParameters.clientId, requestParameters.putAdminClientsUpdateBrandingRequest, options).then((request) => request(axios, basePath));
|
|
996
|
+
},
|
|
794
997
|
/**
|
|
795
998
|
*
|
|
796
999
|
* @summary Rotate an OAuth client secret
|
|
@@ -841,6 +1044,17 @@ export class AdminOAuthClientsApi extends BaseAPI {
|
|
|
841
1044
|
adminClientsCimdCheck(requestParameters, options) {
|
|
842
1045
|
return AdminOAuthClientsApiFp(this.configuration).adminClientsCimdCheck(requestParameters.orgId, requestParameters.adminClientsCimdCheckRequest, options).then((request) => request(this.axios, this.basePath));
|
|
843
1046
|
}
|
|
1047
|
+
/**
|
|
1048
|
+
* Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
|
|
1049
|
+
* @summary Get an OAuth client\'s login and consent page branding
|
|
1050
|
+
* @param {AdminOAuthClientsApiAdminClientsGetBrandingRequest} requestParameters Request parameters.
|
|
1051
|
+
* @param {*} [options] Override http request option.
|
|
1052
|
+
* @throws {RequiredError}
|
|
1053
|
+
* @memberof AdminOAuthClientsApi
|
|
1054
|
+
*/
|
|
1055
|
+
adminClientsGetBranding(requestParameters, options) {
|
|
1056
|
+
return AdminOAuthClientsApiFp(this.configuration).adminClientsGetBranding(requestParameters.orgId, requestParameters.clientId, options).then((request) => request(this.axios, this.basePath));
|
|
1057
|
+
}
|
|
844
1058
|
/**
|
|
845
1059
|
*
|
|
846
1060
|
* @summary Create an OAuth client
|
|
@@ -918,6 +1132,17 @@ export class AdminOAuthClientsApi extends BaseAPI {
|
|
|
918
1132
|
listClients(requestParameters, options) {
|
|
919
1133
|
return AdminOAuthClientsApiFp(this.configuration).listClients(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
920
1134
|
}
|
|
1135
|
+
/**
|
|
1136
|
+
*
|
|
1137
|
+
* @summary Change keys of an OAuth client\'s login and/or consent page branding
|
|
1138
|
+
* @param {AdminOAuthClientsApiPatchAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
|
|
1139
|
+
* @param {*} [options] Override http request option.
|
|
1140
|
+
* @throws {RequiredError}
|
|
1141
|
+
* @memberof AdminOAuthClientsApi
|
|
1142
|
+
*/
|
|
1143
|
+
patchAdminClientsUpdateBranding(requestParameters, options) {
|
|
1144
|
+
return AdminOAuthClientsApiFp(this.configuration).patchAdminClientsUpdateBranding(requestParameters.orgId, requestParameters.clientId, requestParameters.adminClientsGetBrandingResponseData, options).then((request) => request(this.axios, this.basePath));
|
|
1145
|
+
}
|
|
921
1146
|
/**
|
|
922
1147
|
*
|
|
923
1148
|
* @summary Update an OAuth client
|
|
@@ -929,6 +1154,17 @@ export class AdminOAuthClientsApi extends BaseAPI {
|
|
|
929
1154
|
patchClient(requestParameters, options) {
|
|
930
1155
|
return AdminOAuthClientsApiFp(this.configuration).patchClient(requestParameters.orgId, requestParameters.clientId, options).then((request) => request(this.axios, this.basePath));
|
|
931
1156
|
}
|
|
1157
|
+
/**
|
|
1158
|
+
*
|
|
1159
|
+
* @summary Replace an OAuth client\'s login and/or consent page branding
|
|
1160
|
+
* @param {AdminOAuthClientsApiPutAdminClientsUpdateBrandingRequest} requestParameters Request parameters.
|
|
1161
|
+
* @param {*} [options] Override http request option.
|
|
1162
|
+
* @throws {RequiredError}
|
|
1163
|
+
* @memberof AdminOAuthClientsApi
|
|
1164
|
+
*/
|
|
1165
|
+
putAdminClientsUpdateBranding(requestParameters, options) {
|
|
1166
|
+
return AdminOAuthClientsApiFp(this.configuration).putAdminClientsUpdateBranding(requestParameters.orgId, requestParameters.clientId, requestParameters.putAdminClientsUpdateBrandingRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1167
|
+
}
|
|
932
1168
|
/**
|
|
933
1169
|
*
|
|
934
1170
|
* @summary Rotate an OAuth client secret
|
|
@@ -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
|