@lumoauth/api-client 1.0.0 → 1.1.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.
Files changed (69) hide show
  1. package/.openapi-generator/FILES +10 -0
  2. package/.openapi-generator-ignore +1 -1
  3. package/README.md +8 -2
  4. package/api/admin-oauth-clients-api.ts +118 -0
  5. package/api/authorization-api.ts +5 -26
  6. package/dist/api/admin-oauth-clients-api.d.ts +65 -0
  7. package/dist/api/admin-oauth-clients-api.js +77 -0
  8. package/dist/api/authorization-api.d.ts +5 -5
  9. package/dist/api/authorization-api.js +4 -18
  10. package/dist/esm/api/admin-oauth-clients-api.d.ts +65 -0
  11. package/dist/esm/api/admin-oauth-clients-api.js +78 -1
  12. package/dist/esm/api/authorization-api.d.ts +5 -5
  13. package/dist/esm/api/authorization-api.js +4 -18
  14. package/dist/esm/models/admin-clients-cimd-check-request.d.ts +30 -0
  15. package/dist/esm/models/admin-clients-cimd-check-request.js +14 -0
  16. package/dist/esm/models/admin-clients-cimd-check-response.d.ts +25 -0
  17. package/dist/esm/models/admin-clients-cimd-check-response.js +14 -0
  18. package/dist/esm/models/authentication-settings.d.ts +1 -1
  19. package/dist/esm/models/authorization-server-metadata.d.ts +1 -1
  20. package/dist/esm/models/cimd-check-result-effective.d.ts +112 -0
  21. package/dist/esm/models/cimd-check-result-effective.js +31 -0
  22. package/dist/esm/models/cimd-check-result-shadow-client.d.ts +30 -0
  23. package/dist/esm/models/cimd-check-result-shadow-client.js +14 -0
  24. package/dist/esm/models/cimd-check-result.d.ts +76 -0
  25. package/dist/esm/models/cimd-check-result.js +14 -0
  26. package/dist/esm/models/index.d.ts +5 -0
  27. package/dist/esm/models/index.js +5 -0
  28. package/dist/esm/models/open-id-configuration.d.ts +1 -1
  29. package/dist/esm/models/push-enrollment-started.d.ts +7 -1
  30. package/dist/models/admin-clients-cimd-check-request.d.ts +30 -0
  31. package/dist/models/admin-clients-cimd-check-request.js +15 -0
  32. package/dist/models/admin-clients-cimd-check-response.d.ts +25 -0
  33. package/dist/models/admin-clients-cimd-check-response.js +15 -0
  34. package/dist/models/authentication-settings.d.ts +1 -1
  35. package/dist/models/authorization-server-metadata.d.ts +1 -1
  36. package/dist/models/cimd-check-result-effective.d.ts +112 -0
  37. package/dist/models/cimd-check-result-effective.js +34 -0
  38. package/dist/models/cimd-check-result-shadow-client.d.ts +30 -0
  39. package/dist/models/cimd-check-result-shadow-client.js +15 -0
  40. package/dist/models/cimd-check-result.d.ts +76 -0
  41. package/dist/models/cimd-check-result.js +15 -0
  42. package/dist/models/index.d.ts +5 -0
  43. package/dist/models/index.js +5 -0
  44. package/dist/models/open-id-configuration.d.ts +1 -1
  45. package/dist/models/push-enrollment-started.d.ts +7 -1
  46. package/docs/AdminClientsCimdCheckRequest.md +22 -0
  47. package/docs/AdminClientsCimdCheckResponse.md +20 -0
  48. package/docs/AdminOAuthClientsApi.md +57 -0
  49. package/docs/AuthenticationSettings.md +1 -1
  50. package/docs/AuthorizationApi.md +8 -8
  51. package/docs/AuthorizationServerMetadata.md +1 -1
  52. package/docs/CimdCheckResult.md +37 -0
  53. package/docs/CimdCheckResultEffective.md +45 -0
  54. package/docs/CimdCheckResultShadowClient.md +23 -0
  55. package/docs/EnrollAuthenticator201Response.md +3 -1
  56. package/docs/OpenIdConfiguration.md +1 -1
  57. package/docs/PushEnrollmentStarted.md +3 -1
  58. package/docs/WellKnownApi.md +2 -2
  59. package/models/admin-clients-cimd-check-request.ts +36 -0
  60. package/models/admin-clients-cimd-check-response.ts +33 -0
  61. package/models/authentication-settings.ts +1 -1
  62. package/models/authorization-server-metadata.ts +1 -1
  63. package/models/cimd-check-result-effective.ts +120 -0
  64. package/models/cimd-check-result-shadow-client.ts +36 -0
  65. package/models/cimd-check-result.ts +84 -0
  66. package/models/index.ts +5 -0
  67. package/models/open-id-configuration.ts +1 -1
  68. package/models/push-enrollment-started.ts +7 -1
  69. package/package.json +1 -1
@@ -56,8 +56,6 @@ const AuthorizationApiAxiosParamCreator = function (configuration) {
56
56
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
57
57
  const localVarHeaderParameter = {};
58
58
  const localVarQueryParameter = {};
59
- // authentication ApiKeyAuth required
60
- yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-API-Key", configuration);
61
59
  // authentication BearerAuth required
62
60
  // http bearer authentication required
63
61
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
@@ -90,8 +88,6 @@ const AuthorizationApiAxiosParamCreator = function (configuration) {
90
88
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
91
89
  const localVarHeaderParameter = {};
92
90
  const localVarQueryParameter = {};
93
- // authentication ApiKeyAuth required
94
- yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-API-Key", configuration);
95
91
  // authentication BearerAuth required
96
92
  // http bearer authentication required
97
93
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
@@ -442,8 +438,6 @@ const AuthorizationApiAxiosParamCreator = function (configuration) {
442
438
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
443
439
  const localVarHeaderParameter = {};
444
440
  const localVarQueryParameter = {};
445
- // authentication ApiKeyAuth required
446
- yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-API-Key", configuration);
447
441
  // authentication BearerAuth required
448
442
  // http bearer authentication required
449
443
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
@@ -484,8 +478,6 @@ const AuthorizationApiAxiosParamCreator = function (configuration) {
484
478
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
485
479
  const localVarHeaderParameter = {};
486
480
  const localVarQueryParameter = {};
487
- // authentication ApiKeyAuth required
488
- yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-API-Key", configuration);
489
481
  // authentication BearerAuth required
490
482
  // http bearer authentication required
491
483
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
@@ -519,8 +511,6 @@ const AuthorizationApiAxiosParamCreator = function (configuration) {
519
511
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
520
512
  const localVarHeaderParameter = {};
521
513
  const localVarQueryParameter = {};
522
- // authentication ApiKeyAuth required
523
- yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-API-Key", configuration);
524
514
  // authentication BearerAuth required
525
515
  // http bearer authentication required
526
516
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
@@ -536,7 +526,7 @@ const AuthorizationApiAxiosParamCreator = function (configuration) {
536
526
  };
537
527
  }),
538
528
  /**
539
- * GET /api/v1/authz/permissions
529
+ * GET /api/v1/authz/permissions Inventory endpoint: a bearer access token needs the `authz:read` scope (the check endpoints stay open to any authenticated token).
540
530
  * @summary List the caller\'s effective permissions
541
531
  * @param {*} [options] Override http request option.
542
532
  * @throws {RequiredError}
@@ -598,8 +588,6 @@ const AuthorizationApiAxiosParamCreator = function (configuration) {
598
588
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
599
589
  const localVarHeaderParameter = {};
600
590
  const localVarQueryParameter = {};
601
- // authentication ApiKeyAuth required
602
- yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-API-Key", configuration);
603
591
  // authentication BearerAuth required
604
592
  // http bearer authentication required
605
593
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
@@ -640,8 +628,6 @@ const AuthorizationApiAxiosParamCreator = function (configuration) {
640
628
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
641
629
  const localVarHeaderParameter = {};
642
630
  const localVarQueryParameter = {};
643
- // authentication ApiKeyAuth required
644
- yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-API-Key", configuration);
645
631
  // authentication BearerAuth required
646
632
  // http bearer authentication required
647
633
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
@@ -901,7 +887,7 @@ const AuthorizationApiFp = function (configuration) {
901
887
  });
902
888
  },
903
889
  /**
904
- * GET /api/v1/authz/permissions
890
+ * GET /api/v1/authz/permissions Inventory endpoint: a bearer access token needs the `authz:read` scope (the check endpoints stay open to any authenticated token).
905
891
  * @summary List the caller\'s effective permissions
906
892
  * @param {*} [options] Override http request option.
907
893
  * @throws {RequiredError}
@@ -1106,7 +1092,7 @@ const AuthorizationApiFactory = function (configuration, basePath, axios) {
1106
1092
  return localVarFp.listAttributeDefinitions(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
1107
1093
  },
1108
1094
  /**
1109
- * GET /api/v1/authz/permissions
1095
+ * GET /api/v1/authz/permissions Inventory endpoint: a bearer access token needs the `authz:read` scope (the check endpoints stay open to any authenticated token).
1110
1096
  * @summary List the caller\'s effective permissions
1111
1097
  * @param {*} [options] Override http request option.
1112
1098
  * @throws {RequiredError}
@@ -1303,7 +1289,7 @@ class AuthorizationApi extends base_1.BaseAPI {
1303
1289
  return (0, exports.AuthorizationApiFp)(this.configuration).listAttributeDefinitions(requestParameters.orgId, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
1304
1290
  }
1305
1291
  /**
1306
- * GET /api/v1/authz/permissions
1292
+ * GET /api/v1/authz/permissions Inventory endpoint: a bearer access token needs the `authz:read` scope (the check endpoints stay open to any authenticated token).
1307
1293
  * @summary List the caller\'s effective permissions
1308
1294
  * @param {*} [options] Override http request option.
1309
1295
  * @throws {RequiredError}
@@ -12,6 +12,8 @@
12
12
  import type { Configuration } from '../configuration';
13
13
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  import { type RequestArgs, BaseAPI } from '../base';
15
+ import type { AdminClientsCimdCheckRequest } from '../models';
16
+ import type { AdminClientsCimdCheckResponse } from '../models';
15
17
  import type { CreateClientResponse } from '../models';
16
18
  import type { GetClientResponse } from '../models';
17
19
  import type { ListClientScopesResponse } from '../models';
@@ -25,6 +27,15 @@ import type { UpdateClientResponse } from '../models';
25
27
  * @export
26
28
  */
27
29
  export declare const AdminOAuthClientsApiAxiosParamCreator: (configuration?: Configuration) => {
30
+ /**
31
+ * Fetches and validates the metadata document at `client_id` exactly as the authorization server does (SSRF guard, domain allow-list, size and content-type limits, schema rules) and returns the effective client: redirect URIs, grant types and scopes after the organization policy is applied, plus what the document asked for that was dropped. Works even while CIMD is switched off for the organization (`enabled: false`), so a document can be validated before the switch is flipped. Nothing is registered or stored. `refresh: true` discards the cached copy first.
32
+ * @summary Check a Client ID Metadata Document
33
+ * @param {string} orgId
34
+ * @param {AdminClientsCimdCheckRequest} adminClientsCimdCheckRequest
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ adminClientsCimdCheck: (orgId: string, adminClientsCimdCheckRequest: AdminClientsCimdCheckRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
28
39
  /**
29
40
  *
30
41
  * @summary Create an OAuth client
@@ -128,6 +139,15 @@ export declare const AdminOAuthClientsApiAxiosParamCreator: (configuration?: Con
128
139
  * @export
129
140
  */
130
141
  export declare const AdminOAuthClientsApiFp: (configuration?: Configuration) => {
142
+ /**
143
+ * Fetches and validates the metadata document at `client_id` exactly as the authorization server does (SSRF guard, domain allow-list, size and content-type limits, schema rules) and returns the effective client: redirect URIs, grant types and scopes after the organization policy is applied, plus what the document asked for that was dropped. Works even while CIMD is switched off for the organization (`enabled: false`), so a document can be validated before the switch is flipped. Nothing is registered or stored. `refresh: true` discards the cached copy first.
144
+ * @summary Check a Client ID Metadata Document
145
+ * @param {string} orgId
146
+ * @param {AdminClientsCimdCheckRequest} adminClientsCimdCheckRequest
147
+ * @param {*} [options] Override http request option.
148
+ * @throws {RequiredError}
149
+ */
150
+ adminClientsCimdCheck(orgId: string, adminClientsCimdCheckRequest: AdminClientsCimdCheckRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminClientsCimdCheckResponse>>;
131
151
  /**
132
152
  *
133
153
  * @summary Create an OAuth client
@@ -231,6 +251,14 @@ export declare const AdminOAuthClientsApiFp: (configuration?: Configuration) =>
231
251
  * @export
232
252
  */
233
253
  export declare const AdminOAuthClientsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
254
+ /**
255
+ * Fetches and validates the metadata document at `client_id` exactly as the authorization server does (SSRF guard, domain allow-list, size and content-type limits, schema rules) and returns the effective client: redirect URIs, grant types and scopes after the organization policy is applied, plus what the document asked for that was dropped. Works even while CIMD is switched off for the organization (`enabled: false`), so a document can be validated before the switch is flipped. Nothing is registered or stored. `refresh: true` discards the cached copy first.
256
+ * @summary Check a Client ID Metadata Document
257
+ * @param {AdminOAuthClientsApiAdminClientsCimdCheckRequest} requestParameters Request parameters.
258
+ * @param {*} [options] Override http request option.
259
+ * @throws {RequiredError}
260
+ */
261
+ adminClientsCimdCheck(requestParameters: AdminOAuthClientsApiAdminClientsCimdCheckRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminClientsCimdCheckResponse>;
234
262
  /**
235
263
  *
236
264
  * @summary Create an OAuth client
@@ -326,6 +354,15 @@ export declare const AdminOAuthClientsApiFactory: (configuration?: Configuration
326
354
  * @interface AdminOAuthClientsApi
327
355
  */
328
356
  export interface AdminOAuthClientsApiInterface {
357
+ /**
358
+ * Fetches and validates the metadata document at `client_id` exactly as the authorization server does (SSRF guard, domain allow-list, size and content-type limits, schema rules) and returns the effective client: redirect URIs, grant types and scopes after the organization policy is applied, plus what the document asked for that was dropped. Works even while CIMD is switched off for the organization (`enabled: false`), so a document can be validated before the switch is flipped. Nothing is registered or stored. `refresh: true` discards the cached copy first.
359
+ * @summary Check a Client ID Metadata Document
360
+ * @param {AdminOAuthClientsApiAdminClientsCimdCheckRequest} requestParameters Request parameters.
361
+ * @param {*} [options] Override http request option.
362
+ * @throws {RequiredError}
363
+ * @memberof AdminOAuthClientsApiInterface
364
+ */
365
+ adminClientsCimdCheck(requestParameters: AdminOAuthClientsApiAdminClientsCimdCheckRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminClientsCimdCheckResponse>;
329
366
  /**
330
367
  *
331
368
  * @summary Create an OAuth client
@@ -426,6 +463,25 @@ export interface AdminOAuthClientsApiInterface {
426
463
  */
427
464
  updateClient(requestParameters: AdminOAuthClientsApiUpdateClientRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateClientResponse>;
428
465
  }
466
+ /**
467
+ * Request parameters for adminClientsCimdCheck operation in AdminOAuthClientsApi.
468
+ * @export
469
+ * @interface AdminOAuthClientsApiAdminClientsCimdCheckRequest
470
+ */
471
+ export interface AdminOAuthClientsApiAdminClientsCimdCheckRequest {
472
+ /**
473
+ *
474
+ * @type {string}
475
+ * @memberof AdminOAuthClientsApiAdminClientsCimdCheck
476
+ */
477
+ readonly orgId: string;
478
+ /**
479
+ *
480
+ * @type {AdminClientsCimdCheckRequest}
481
+ * @memberof AdminOAuthClientsApiAdminClientsCimdCheck
482
+ */
483
+ readonly adminClientsCimdCheckRequest: AdminClientsCimdCheckRequest;
484
+ }
429
485
  /**
430
486
  * Request parameters for createClient operation in AdminOAuthClientsApi.
431
487
  * @export
@@ -630,6 +686,15 @@ export interface AdminOAuthClientsApiUpdateClientRequest {
630
686
  * @extends {BaseAPI}
631
687
  */
632
688
  export declare class AdminOAuthClientsApi extends BaseAPI implements AdminOAuthClientsApiInterface {
689
+ /**
690
+ * Fetches and validates the metadata document at `client_id` exactly as the authorization server does (SSRF guard, domain allow-list, size and content-type limits, schema rules) and returns the effective client: redirect URIs, grant types and scopes after the organization policy is applied, plus what the document asked for that was dropped. Works even while CIMD is switched off for the organization (`enabled: false`), so a document can be validated before the switch is flipped. Nothing is registered or stored. `refresh: true` discards the cached copy first.
691
+ * @summary Check a Client ID Metadata Document
692
+ * @param {AdminOAuthClientsApiAdminClientsCimdCheckRequest} requestParameters Request parameters.
693
+ * @param {*} [options] Override http request option.
694
+ * @throws {RequiredError}
695
+ * @memberof AdminOAuthClientsApi
696
+ */
697
+ adminClientsCimdCheck(requestParameters: AdminOAuthClientsApiAdminClientsCimdCheckRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminClientsCimdCheckResponse, any, {}>>;
633
698
  /**
634
699
  *
635
700
  * @summary Create an OAuth client
@@ -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
  /**
@@ -32,6 +32,45 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
32
32
  */
33
33
  export const AdminOAuthClientsApiAxiosParamCreator = function (configuration) {
34
34
  return {
35
+ /**
36
+ * Fetches and validates the metadata document at `client_id` exactly as the authorization server does (SSRF guard, domain allow-list, size and content-type limits, schema rules) and returns the effective client: redirect URIs, grant types and scopes after the organization policy is applied, plus what the document asked for that was dropped. Works even while CIMD is switched off for the organization (`enabled: false`), so a document can be validated before the switch is flipped. Nothing is registered or stored. `refresh: true` discards the cached copy first.
37
+ * @summary Check a Client ID Metadata Document
38
+ * @param {string} orgId
39
+ * @param {AdminClientsCimdCheckRequest} adminClientsCimdCheckRequest
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ */
43
+ adminClientsCimdCheck: (orgId_1, adminClientsCimdCheckRequest_1, ...args_1) => __awaiter(this, [orgId_1, adminClientsCimdCheckRequest_1, ...args_1], void 0, function* (orgId, adminClientsCimdCheckRequest, options = {}) {
44
+ // verify required parameter 'orgId' is not null or undefined
45
+ assertParamExists('adminClientsCimdCheck', 'orgId', orgId);
46
+ // verify required parameter 'adminClientsCimdCheckRequest' is not null or undefined
47
+ assertParamExists('adminClientsCimdCheck', 'adminClientsCimdCheckRequest', adminClientsCimdCheckRequest);
48
+ const localVarPath = `/orgs/{orgId}/api/v1/admin/clients/cimd/check`
49
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
50
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
51
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
52
+ let baseOptions;
53
+ if (configuration) {
54
+ baseOptions = configuration.baseOptions;
55
+ }
56
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
57
+ const localVarHeaderParameter = {};
58
+ const localVarQueryParameter = {};
59
+ // authentication ApiKeyAuth required
60
+ yield setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration);
61
+ // authentication BearerAuth required
62
+ // http bearer authentication required
63
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
64
+ localVarHeaderParameter['Content-Type'] = 'application/json';
65
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
66
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
67
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
68
+ localVarRequestOptions.data = serializeDataIfNeeded(adminClientsCimdCheckRequest, localVarRequestOptions, configuration);
69
+ return {
70
+ url: toPathString(localVarUrlObj),
71
+ options: localVarRequestOptions,
72
+ };
73
+ }),
35
74
  /**
36
75
  *
37
76
  * @summary Create an OAuth client
@@ -451,6 +490,23 @@ export const AdminOAuthClientsApiAxiosParamCreator = function (configuration) {
451
490
  export const AdminOAuthClientsApiFp = function (configuration) {
452
491
  const localVarAxiosParamCreator = AdminOAuthClientsApiAxiosParamCreator(configuration);
453
492
  return {
493
+ /**
494
+ * Fetches and validates the metadata document at `client_id` exactly as the authorization server does (SSRF guard, domain allow-list, size and content-type limits, schema rules) and returns the effective client: redirect URIs, grant types and scopes after the organization policy is applied, plus what the document asked for that was dropped. Works even while CIMD is switched off for the organization (`enabled: false`), so a document can be validated before the switch is flipped. Nothing is registered or stored. `refresh: true` discards the cached copy first.
495
+ * @summary Check a Client ID Metadata Document
496
+ * @param {string} orgId
497
+ * @param {AdminClientsCimdCheckRequest} adminClientsCimdCheckRequest
498
+ * @param {*} [options] Override http request option.
499
+ * @throws {RequiredError}
500
+ */
501
+ adminClientsCimdCheck(orgId, adminClientsCimdCheckRequest, options) {
502
+ return __awaiter(this, void 0, void 0, function* () {
503
+ var _a, _b, _c;
504
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.adminClientsCimdCheck(orgId, adminClientsCimdCheckRequest, options);
505
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
506
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminOAuthClientsApi.adminClientsCimdCheck']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
507
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
508
+ });
509
+ },
454
510
  /**
455
511
  *
456
512
  * @summary Create an OAuth client
@@ -645,6 +701,16 @@ export const AdminOAuthClientsApiFp = function (configuration) {
645
701
  export const AdminOAuthClientsApiFactory = function (configuration, basePath, axios) {
646
702
  const localVarFp = AdminOAuthClientsApiFp(configuration);
647
703
  return {
704
+ /**
705
+ * Fetches and validates the metadata document at `client_id` exactly as the authorization server does (SSRF guard, domain allow-list, size and content-type limits, schema rules) and returns the effective client: redirect URIs, grant types and scopes after the organization policy is applied, plus what the document asked for that was dropped. Works even while CIMD is switched off for the organization (`enabled: false`), so a document can be validated before the switch is flipped. Nothing is registered or stored. `refresh: true` discards the cached copy first.
706
+ * @summary Check a Client ID Metadata Document
707
+ * @param {AdminOAuthClientsApiAdminClientsCimdCheckRequest} requestParameters Request parameters.
708
+ * @param {*} [options] Override http request option.
709
+ * @throws {RequiredError}
710
+ */
711
+ adminClientsCimdCheck(requestParameters, options) {
712
+ return localVarFp.adminClientsCimdCheck(requestParameters.orgId, requestParameters.adminClientsCimdCheckRequest, options).then((request) => request(axios, basePath));
713
+ },
648
714
  /**
649
715
  *
650
716
  * @summary Create an OAuth client
@@ -764,6 +830,17 @@ export const AdminOAuthClientsApiFactory = function (configuration, basePath, ax
764
830
  * @extends {BaseAPI}
765
831
  */
766
832
  export class AdminOAuthClientsApi extends BaseAPI {
833
+ /**
834
+ * Fetches and validates the metadata document at `client_id` exactly as the authorization server does (SSRF guard, domain allow-list, size and content-type limits, schema rules) and returns the effective client: redirect URIs, grant types and scopes after the organization policy is applied, plus what the document asked for that was dropped. Works even while CIMD is switched off for the organization (`enabled: false`), so a document can be validated before the switch is flipped. Nothing is registered or stored. `refresh: true` discards the cached copy first.
835
+ * @summary Check a Client ID Metadata Document
836
+ * @param {AdminOAuthClientsApiAdminClientsCimdCheckRequest} requestParameters Request parameters.
837
+ * @param {*} [options] Override http request option.
838
+ * @throws {RequiredError}
839
+ * @memberof AdminOAuthClientsApi
840
+ */
841
+ adminClientsCimdCheck(requestParameters, options) {
842
+ return AdminOAuthClientsApiFp(this.configuration).adminClientsCimdCheck(requestParameters.orgId, requestParameters.adminClientsCimdCheckRequest, options).then((request) => request(this.axios, this.basePath));
843
+ }
767
844
  /**
768
845
  *
769
846
  * @summary Create an OAuth client
@@ -152,7 +152,7 @@ export declare const AuthorizationApiAxiosParamCreator: (configuration?: Configu
152
152
  */
153
153
  listAttributeDefinitions: (orgId: string, type?: ListAttributeDefinitionsType, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
154
154
  /**
155
- * GET /api/v1/authz/permissions
155
+ * GET /api/v1/authz/permissions Inventory endpoint: a bearer access token needs the `authz:read` scope (the check endpoints stay open to any authenticated token).
156
156
  * @summary List the caller\'s effective permissions
157
157
  * @param {*} [options] Override http request option.
158
158
  * @throws {RequiredError}
@@ -303,7 +303,7 @@ export declare const AuthorizationApiFp: (configuration?: Configuration) => {
303
303
  */
304
304
  listAttributeDefinitions(orgId: string, type?: ListAttributeDefinitionsType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAttributeDefinitionsResponse>>;
305
305
  /**
306
- * GET /api/v1/authz/permissions
306
+ * GET /api/v1/authz/permissions Inventory endpoint: a bearer access token needs the `authz:read` scope (the check endpoints stay open to any authenticated token).
307
307
  * @summary List the caller\'s effective permissions
308
308
  * @param {*} [options] Override http request option.
309
309
  * @throws {RequiredError}
@@ -450,7 +450,7 @@ export declare const AuthorizationApiFactory: (configuration?: Configuration, ba
450
450
  */
451
451
  listAttributeDefinitions(requestParameters: AuthorizationApiListAttributeDefinitionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListAttributeDefinitionsResponse>;
452
452
  /**
453
- * GET /api/v1/authz/permissions
453
+ * GET /api/v1/authz/permissions Inventory endpoint: a bearer access token needs the `authz:read` scope (the check endpoints stay open to any authenticated token).
454
454
  * @summary List the caller\'s effective permissions
455
455
  * @param {*} [options] Override http request option.
456
456
  * @throws {RequiredError}
@@ -608,7 +608,7 @@ export interface AuthorizationApiInterface {
608
608
  */
609
609
  listAttributeDefinitions(requestParameters: AuthorizationApiListAttributeDefinitionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListAttributeDefinitionsResponse>;
610
610
  /**
611
- * GET /api/v1/authz/permissions
611
+ * GET /api/v1/authz/permissions Inventory endpoint: a bearer access token needs the `authz:read` scope (the check endpoints stay open to any authenticated token).
612
612
  * @summary List the caller\'s effective permissions
613
613
  * @param {*} [options] Override http request option.
614
614
  * @throws {RequiredError}
@@ -954,7 +954,7 @@ export declare class AuthorizationApi extends BaseAPI implements AuthorizationAp
954
954
  */
955
955
  listAttributeDefinitions(requestParameters: AuthorizationApiListAttributeDefinitionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAttributeDefinitionsResponse, any, {}>>;
956
956
  /**
957
- * GET /api/v1/authz/permissions
957
+ * GET /api/v1/authz/permissions Inventory endpoint: a bearer access token needs the `authz:read` scope (the check endpoints stay open to any authenticated token).
958
958
  * @summary List the caller\'s effective permissions
959
959
  * @param {*} [options] Override http request option.
960
960
  * @throws {RequiredError}
@@ -53,8 +53,6 @@ export const AuthorizationApiAxiosParamCreator = function (configuration) {
53
53
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
54
54
  const localVarHeaderParameter = {};
55
55
  const localVarQueryParameter = {};
56
- // authentication ApiKeyAuth required
57
- yield setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration);
58
56
  // authentication BearerAuth required
59
57
  // http bearer authentication required
60
58
  yield setBearerAuthToObject(localVarHeaderParameter, configuration);
@@ -87,8 +85,6 @@ export const AuthorizationApiAxiosParamCreator = function (configuration) {
87
85
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
88
86
  const localVarHeaderParameter = {};
89
87
  const localVarQueryParameter = {};
90
- // authentication ApiKeyAuth required
91
- yield setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration);
92
88
  // authentication BearerAuth required
93
89
  // http bearer authentication required
94
90
  yield setBearerAuthToObject(localVarHeaderParameter, configuration);
@@ -439,8 +435,6 @@ export const AuthorizationApiAxiosParamCreator = function (configuration) {
439
435
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
440
436
  const localVarHeaderParameter = {};
441
437
  const localVarQueryParameter = {};
442
- // authentication ApiKeyAuth required
443
- yield setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration);
444
438
  // authentication BearerAuth required
445
439
  // http bearer authentication required
446
440
  yield setBearerAuthToObject(localVarHeaderParameter, configuration);
@@ -481,8 +475,6 @@ export const AuthorizationApiAxiosParamCreator = function (configuration) {
481
475
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
482
476
  const localVarHeaderParameter = {};
483
477
  const localVarQueryParameter = {};
484
- // authentication ApiKeyAuth required
485
- yield setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration);
486
478
  // authentication BearerAuth required
487
479
  // http bearer authentication required
488
480
  yield setBearerAuthToObject(localVarHeaderParameter, configuration);
@@ -516,8 +508,6 @@ export const AuthorizationApiAxiosParamCreator = function (configuration) {
516
508
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
517
509
  const localVarHeaderParameter = {};
518
510
  const localVarQueryParameter = {};
519
- // authentication ApiKeyAuth required
520
- yield setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration);
521
511
  // authentication BearerAuth required
522
512
  // http bearer authentication required
523
513
  yield setBearerAuthToObject(localVarHeaderParameter, configuration);
@@ -533,7 +523,7 @@ export const AuthorizationApiAxiosParamCreator = function (configuration) {
533
523
  };
534
524
  }),
535
525
  /**
536
- * GET /api/v1/authz/permissions
526
+ * GET /api/v1/authz/permissions Inventory endpoint: a bearer access token needs the `authz:read` scope (the check endpoints stay open to any authenticated token).
537
527
  * @summary List the caller\'s effective permissions
538
528
  * @param {*} [options] Override http request option.
539
529
  * @throws {RequiredError}
@@ -595,8 +585,6 @@ export const AuthorizationApiAxiosParamCreator = function (configuration) {
595
585
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
596
586
  const localVarHeaderParameter = {};
597
587
  const localVarQueryParameter = {};
598
- // authentication ApiKeyAuth required
599
- yield setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration);
600
588
  // authentication BearerAuth required
601
589
  // http bearer authentication required
602
590
  yield setBearerAuthToObject(localVarHeaderParameter, configuration);
@@ -637,8 +625,6 @@ export const AuthorizationApiAxiosParamCreator = function (configuration) {
637
625
  const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
638
626
  const localVarHeaderParameter = {};
639
627
  const localVarQueryParameter = {};
640
- // authentication ApiKeyAuth required
641
- yield setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration);
642
628
  // authentication BearerAuth required
643
629
  // http bearer authentication required
644
630
  yield setBearerAuthToObject(localVarHeaderParameter, configuration);
@@ -897,7 +883,7 @@ export const AuthorizationApiFp = function (configuration) {
897
883
  });
898
884
  },
899
885
  /**
900
- * GET /api/v1/authz/permissions
886
+ * GET /api/v1/authz/permissions Inventory endpoint: a bearer access token needs the `authz:read` scope (the check endpoints stay open to any authenticated token).
901
887
  * @summary List the caller\'s effective permissions
902
888
  * @param {*} [options] Override http request option.
903
889
  * @throws {RequiredError}
@@ -1101,7 +1087,7 @@ export const AuthorizationApiFactory = function (configuration, basePath, axios)
1101
1087
  return localVarFp.listAttributeDefinitions(requestParameters.orgId, requestParameters.type, options).then((request) => request(axios, basePath));
1102
1088
  },
1103
1089
  /**
1104
- * GET /api/v1/authz/permissions
1090
+ * GET /api/v1/authz/permissions Inventory endpoint: a bearer access token needs the `authz:read` scope (the check endpoints stay open to any authenticated token).
1105
1091
  * @summary List the caller\'s effective permissions
1106
1092
  * @param {*} [options] Override http request option.
1107
1093
  * @throws {RequiredError}
@@ -1297,7 +1283,7 @@ export class AuthorizationApi extends BaseAPI {
1297
1283
  return AuthorizationApiFp(this.configuration).listAttributeDefinitions(requestParameters.orgId, requestParameters.type, options).then((request) => request(this.axios, this.basePath));
1298
1284
  }
1299
1285
  /**
1300
- * GET /api/v1/authz/permissions
1286
+ * GET /api/v1/authz/permissions Inventory endpoint: a bearer access token needs the `authz:read` scope (the check endpoints stay open to any authenticated token).
1301
1287
  * @summary List the caller\'s effective permissions
1302
1288
  * @param {*} [options] Override http request option.
1303
1289
  * @throws {RequiredError}
@@ -0,0 +1,30 @@
1
+ /**
2
+ * LumoAuth API
3
+ * LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: sdk@lumoauth.dev
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface AdminClientsCimdCheckRequest
16
+ */
17
+ export interface AdminClientsCimdCheckRequest {
18
+ /**
19
+ * The Client Identifier URL (https, with a path).
20
+ * @type {string}
21
+ * @memberof AdminClientsCimdCheckRequest
22
+ */
23
+ 'client_id': string;
24
+ /**
25
+ * Ignore the cached document and fetch it again.
26
+ * @type {boolean}
27
+ * @memberof AdminClientsCimdCheckRequest
28
+ */
29
+ 'refresh'?: boolean;
30
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LumoAuth API
5
+ * LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: sdk@lumoauth.dev
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,25 @@
1
+ /**
2
+ * LumoAuth API
3
+ * LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: sdk@lumoauth.dev
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { CimdCheckResult } from './cimd-check-result';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface AdminClientsCimdCheckResponse
17
+ */
18
+ export interface AdminClientsCimdCheckResponse {
19
+ /**
20
+ *
21
+ * @type {CimdCheckResult}
22
+ * @memberof AdminClientsCimdCheckResponse
23
+ */
24
+ 'data'?: CimdCheckResult;
25
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LumoAuth API
5
+ * LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ * Contact: sdk@lumoauth.dev
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -146,7 +146,7 @@ export interface AuthenticationSettings {
146
146
  */
147
147
  'dynamic_client_registration_enabled'?: boolean;
148
148
  /**
149
- *
149
+ * Accept Client ID Metadata Documents (an https URL as client_id). On by default on every plan; set false to opt the organization out.
150
150
  * @type {boolean}
151
151
  * @memberof AuthenticationSettings
152
152
  */
@@ -220,7 +220,7 @@ export interface AuthorizationServerMetadata {
220
220
  */
221
221
  'entity_profiles_supported'?: Array<string>;
222
222
  /**
223
- * Only when CIMD is enabled for the organization.
223
+ * Present (true) unless the organization switched Client ID Metadata Documents off.
224
224
  * @type {boolean}
225
225
  * @memberof AuthorizationServerMetadata
226
226
  */