@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
@@ -0,0 +1,76 @@
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 { CimdCheckResultEffective } from './cimd-check-result-effective';
13
+ import type { CimdCheckResultShadowClient } from './cimd-check-result-shadow-client';
14
+ /**
15
+ * Result of POST /admin/clients/cimd/check — how the authorization server sees a Client ID Metadata Document.
16
+ * @export
17
+ * @interface CimdCheckResult
18
+ */
19
+ export interface CimdCheckResult {
20
+ /**
21
+ * true when the document is valid and would be accepted (subject to `enabled`).
22
+ * @type {boolean}
23
+ * @memberof CimdCheckResult
24
+ */
25
+ 'ok'?: boolean;
26
+ /**
27
+ *
28
+ * @type {string}
29
+ * @memberof CimdCheckResult
30
+ */
31
+ 'client_id'?: string;
32
+ /**
33
+ * Whether CIMD is currently on for this organization (switch + plan).
34
+ * @type {boolean}
35
+ * @memberof CimdCheckResult
36
+ */
37
+ 'enabled'?: boolean;
38
+ /**
39
+ * Stable failure code when ok is false (client_id_mismatch, invalid_redirect_uri, domain_not_allowed, http_status_404, …).
40
+ * @type {string}
41
+ * @memberof CimdCheckResult
42
+ */
43
+ 'reason'?: string | null;
44
+ /**
45
+ * Developer-facing explanation of `reason`.
46
+ * @type {string}
47
+ * @memberof CimdCheckResult
48
+ */
49
+ 'message'?: string | null;
50
+ /**
51
+ *
52
+ * @type {Array<string>}
53
+ * @memberof CimdCheckResult
54
+ */
55
+ 'warnings'?: Array<string>;
56
+ /**
57
+ * The metadata document as fetched.
58
+ * @type {{ [key: string]: any; }}
59
+ * @memberof CimdCheckResult
60
+ */
61
+ 'document'?: {
62
+ [key: string]: any;
63
+ } | null;
64
+ /**
65
+ *
66
+ * @type {CimdCheckResultEffective}
67
+ * @memberof CimdCheckResult
68
+ */
69
+ 'effective'?: CimdCheckResultEffective | null;
70
+ /**
71
+ *
72
+ * @type {CimdCheckResultShadowClient}
73
+ * @memberof CimdCheckResult
74
+ */
75
+ 'shadow_client'?: CimdCheckResultShadowClient | null;
76
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LumoAuth API
6
+ * LumoAuth REST API — authentication, authorization, agent registry, MCP server authorization, and tenant administration. Multi-tenant: most paths are scoped under `/orgs/{orgId}/api/v1/...`.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: sdk@lumoauth.dev
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -54,6 +54,8 @@ export * from './admin-audit-logs-stats-response';
54
54
  export * from './admin-audit-logs-stats-response-data';
55
55
  export * from './admin-audit-logs-stats-response-data-period';
56
56
  export * from './admin-client-tokens-revoke-all-response';
57
+ export * from './admin-clients-cimd-check-request';
58
+ export * from './admin-clients-cimd-check-response';
57
59
  export * from './admin-email-templates-list-response';
58
60
  export * from './admin-email-templates-preview-response';
59
61
  export * from './admin-email-templates-variables-response';
@@ -186,6 +188,9 @@ export * from './check-permission-response';
186
188
  export * from './check-permissions-bulk-response';
187
189
  export * from './check-relation-response';
188
190
  export * from './check-relation-scoped-response';
191
+ export * from './cimd-check-result';
192
+ export * from './cimd-check-result-effective';
193
+ export * from './cimd-check-result-shadow-client';
189
194
  export * from './complete-task-response';
190
195
  export * from './create-approval-request';
191
196
  export * from './create-approval-response';
@@ -70,6 +70,8 @@ __exportStar(require("./admin-audit-logs-stats-response"), exports);
70
70
  __exportStar(require("./admin-audit-logs-stats-response-data"), exports);
71
71
  __exportStar(require("./admin-audit-logs-stats-response-data-period"), exports);
72
72
  __exportStar(require("./admin-client-tokens-revoke-all-response"), exports);
73
+ __exportStar(require("./admin-clients-cimd-check-request"), exports);
74
+ __exportStar(require("./admin-clients-cimd-check-response"), exports);
73
75
  __exportStar(require("./admin-email-templates-list-response"), exports);
74
76
  __exportStar(require("./admin-email-templates-preview-response"), exports);
75
77
  __exportStar(require("./admin-email-templates-variables-response"), exports);
@@ -202,6 +204,9 @@ __exportStar(require("./check-permission-response"), exports);
202
204
  __exportStar(require("./check-permissions-bulk-response"), exports);
203
205
  __exportStar(require("./check-relation-response"), exports);
204
206
  __exportStar(require("./check-relation-scoped-response"), exports);
207
+ __exportStar(require("./cimd-check-result"), exports);
208
+ __exportStar(require("./cimd-check-result-effective"), exports);
209
+ __exportStar(require("./cimd-check-result-shadow-client"), exports);
205
210
  __exportStar(require("./complete-task-response"), exports);
206
211
  __exportStar(require("./create-approval-request"), exports);
207
212
  __exportStar(require("./create-approval-response"), exports);
@@ -304,7 +304,7 @@ export interface OpenIdConfiguration {
304
304
  */
305
305
  'entity_profiles_supported'?: Array<string>;
306
306
  /**
307
- * Only when CIMD is enabled for the organization.
307
+ * Present (true) unless the organization switched Client ID Metadata Documents off.
308
308
  * @type {boolean}
309
309
  * @memberof OpenIdConfiguration
310
310
  */
@@ -34,11 +34,17 @@ export interface PushEnrollmentStarted {
34
34
  */
35
35
  'qr_data_uri'?: string;
36
36
  /**
37
- *
37
+ * https://<server>/push-auth/enroll?d=… — an Android App Link / iOS Universal Link that opens the authenticator app on a phone (falls back to a help page without it).
38
38
  * @type {string}
39
39
  * @memberof PushEnrollmentStarted
40
40
  */
41
41
  'deep_link'?: string;
42
+ /**
43
+ * Same link as an intent:// URL pinned to the Android app package, for pages served from this host (Chrome keeps same-site App Links in the browser). Null when the deployment has not configured the package.
44
+ * @type {string}
45
+ * @memberof PushEnrollmentStarted
46
+ */
47
+ 'deep_link_android'?: string | null;
42
48
  /**
43
49
  *
44
50
  * @type {string}
@@ -0,0 +1,22 @@
1
+ # AdminClientsCimdCheckRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **client_id** | **string** | The Client Identifier URL (https, with a path). | [default to undefined]
9
+ **refresh** | **boolean** | Ignore the cached document and fetch it again. | [optional] [default to false]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { AdminClientsCimdCheckRequest } from '@lumoauth/api-client';
15
+
16
+ const instance: AdminClientsCimdCheckRequest = {
17
+ client_id,
18
+ refresh,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # AdminClientsCimdCheckResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **data** | [**CimdCheckResult**](CimdCheckResult.md) | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { AdminClientsCimdCheckResponse } from '@lumoauth/api-client';
14
+
15
+ const instance: AdminClientsCimdCheckResponse = {
16
+ data,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -4,6 +4,7 @@ All URIs are relative to *https://app.lumoauth.dev*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**adminClientsCimdCheck**](#adminclientscimdcheck) | **POST** /orgs/{orgId}/api/v1/admin/clients/cimd/check | Check a Client ID Metadata Document|
7
8
  |[**createClient**](#createclient) | **POST** /orgs/{orgId}/api/v1/admin/clients | Create an OAuth client|
8
9
  |[**deleteClient**](#deleteclient) | **DELETE** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Delete an OAuth client|
9
10
  |[**disableClient**](#disableclient) | **POST** /orgs/{orgId}/api/v1/admin/clients/{clientId}/disable | Disable an OAuth client|
@@ -16,6 +17,62 @@ All URIs are relative to *https://app.lumoauth.dev*
16
17
  |[**setClientScopes**](#setclientscopes) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/scopes | Replace the scopes granted to an OAuth client|
17
18
  |[**updateClient**](#updateclient) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Replace an OAuth client|
18
19
 
20
+ # **adminClientsCimdCheck**
21
+ > AdminClientsCimdCheckResponse adminClientsCimdCheck(adminClientsCimdCheckRequest)
22
+
23
+ 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.
24
+
25
+ ### Example
26
+
27
+ ```typescript
28
+ import {
29
+ AdminOAuthClientsApi,
30
+ Configuration,
31
+ AdminClientsCimdCheckRequest
32
+ } from '@lumoauth/api-client';
33
+
34
+ const configuration = new Configuration();
35
+ const apiInstance = new AdminOAuthClientsApi(configuration);
36
+
37
+ let orgId: string; // (default to undefined)
38
+ let adminClientsCimdCheckRequest: AdminClientsCimdCheckRequest; //
39
+
40
+ const { status, data } = await apiInstance.adminClientsCimdCheck(
41
+ orgId,
42
+ adminClientsCimdCheckRequest
43
+ );
44
+ ```
45
+
46
+ ### Parameters
47
+
48
+ |Name | Type | Description | Notes|
49
+ |------------- | ------------- | ------------- | -------------|
50
+ | **adminClientsCimdCheckRequest** | **AdminClientsCimdCheckRequest**| | |
51
+ | **orgId** | [**string**] | | defaults to undefined|
52
+
53
+
54
+ ### Return type
55
+
56
+ **AdminClientsCimdCheckResponse**
57
+
58
+ ### Authorization
59
+
60
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
61
+
62
+ ### HTTP request headers
63
+
64
+ - **Content-Type**: application/json
65
+ - **Accept**: application/json
66
+
67
+
68
+ ### HTTP response details
69
+ | Status code | Description | Response headers |
70
+ |-------------|-------------|------------------|
71
+ |**200** | Check result (ok&#x3D;false is still 200: the document was reachable for inspection but rejected) | - |
72
+ |**422** | validation_error: client_id missing | - |
73
+
74
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
75
+
19
76
  # **createClient**
20
77
  > CreateClientResponse createClient()
21
78
 
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
26
26
  **session_timeout** | **number** | Seconds. | [optional] [default to undefined]
27
27
  **encrypt_client_secrets** | **boolean** | | [optional] [default to undefined]
28
28
  **dynamic_client_registration_enabled** | **boolean** | | [optional] [default to undefined]
29
- **cimd_enabled** | **boolean** | | [optional] [default to undefined]
29
+ **cimd_enabled** | **boolean** | Accept Client ID Metadata Documents (an https URL as client_id). On by default on every plan; set false to opt the organization out. | [optional] [default to true]
30
30
  **cimd_allowed_domains** | **Array&lt;string&gt;** | | [optional] [default to undefined]
31
31
  **cimd_localhost_redirect_policy** | **string** | | [optional] [default to undefined]
32
32
  **xaa_idp_enabled** | **boolean** | | [optional] [default to undefined]
@@ -59,7 +59,7 @@ const { status, data } = await apiInstance.checkAbac(
59
59
 
60
60
  ### Authorization
61
61
 
62
- [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
62
+ [BearerAuth](../README.md#BearerAuth)
63
63
 
64
64
  ### HTTP request headers
65
65
 
@@ -110,7 +110,7 @@ const { status, data } = await apiInstance.checkAbacBulk(
110
110
 
111
111
  ### Authorization
112
112
 
113
- [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
113
+ [BearerAuth](../README.md#BearerAuth)
114
114
 
115
115
  ### HTTP request headers
116
116
 
@@ -630,7 +630,7 @@ const { status, data } = await apiInstance.getMyAttributes(
630
630
 
631
631
  ### Authorization
632
632
 
633
- [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
633
+ [BearerAuth](../README.md#BearerAuth)
634
634
 
635
635
  ### HTTP request headers
636
636
 
@@ -687,7 +687,7 @@ const { status, data } = await apiInstance.getResourceAttributes(
687
687
 
688
688
  ### Authorization
689
689
 
690
- [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
690
+ [BearerAuth](../README.md#BearerAuth)
691
691
 
692
692
  ### HTTP request headers
693
693
 
@@ -741,7 +741,7 @@ const { status, data } = await apiInstance.listAttributeDefinitions(
741
741
 
742
742
  ### Authorization
743
743
 
744
- [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
744
+ [BearerAuth](../README.md#BearerAuth)
745
745
 
746
746
  ### HTTP request headers
747
747
 
@@ -759,7 +759,7 @@ const { status, data } = await apiInstance.listAttributeDefinitions(
759
759
  # **listPermissions**
760
760
  > ListPermissionsResponse listPermissions()
761
761
 
762
- GET /api/v1/authz/permissions
762
+ 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).
763
763
 
764
764
  ### Example
765
765
 
@@ -845,7 +845,7 @@ const { status, data } = await apiInstance.setResourceAttribute(
845
845
 
846
846
  ### Authorization
847
847
 
848
- [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
848
+ [BearerAuth](../README.md#BearerAuth)
849
849
 
850
850
  ### HTTP request headers
851
851
 
@@ -902,7 +902,7 @@ const { status, data } = await apiInstance.setUserAttribute(
902
902
 
903
903
  ### Authorization
904
904
 
905
- [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
905
+ [BearerAuth](../README.md#BearerAuth)
906
906
 
907
907
  ### HTTP request headers
908
908
 
@@ -39,7 +39,7 @@ Name | Type | Description | Notes
39
39
  **backchannel_token_delivery_modes_supported** | **Array&lt;string&gt;** | | [optional] [default to undefined]
40
40
  **backchannel_user_code_parameter_supported** | **boolean** | | [optional] [default to undefined]
41
41
  **entity_profiles_supported** | **Array&lt;string&gt;** | | [optional] [default to undefined]
42
- **client_id_metadata_document_supported** | **boolean** | Only when CIMD is enabled for the organization. | [optional] [default to undefined]
42
+ **client_id_metadata_document_supported** | **boolean** | Present (true) unless the organization switched Client ID Metadata Documents off. | [optional] [default to undefined]
43
43
  **authorization_grant_profiles_supported** | **Array&lt;string&gt;** | Only when the organization accepts ID-JAGs. | [optional] [default to undefined]
44
44
  **op_policy_uri** | **string** | Only when configured. | [optional] [default to undefined]
45
45
  **op_tos_uri** | **string** | Only when configured. | [optional] [default to undefined]
@@ -0,0 +1,37 @@
1
+ # CimdCheckResult
2
+
3
+ Result of POST /admin/clients/cimd/check — how the authorization server sees a Client ID Metadata Document.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **ok** | **boolean** | true when the document is valid and would be accepted (subject to &#x60;enabled&#x60;). | [optional] [default to undefined]
10
+ **client_id** | **string** | | [optional] [default to undefined]
11
+ **enabled** | **boolean** | Whether CIMD is currently on for this organization (switch + plan). | [optional] [default to undefined]
12
+ **reason** | **string** | Stable failure code when ok is false (client_id_mismatch, invalid_redirect_uri, domain_not_allowed, http_status_404, …). | [optional] [default to undefined]
13
+ **message** | **string** | Developer-facing explanation of &#x60;reason&#x60;. | [optional] [default to undefined]
14
+ **warnings** | **Array&lt;string&gt;** | | [optional] [default to undefined]
15
+ **document** | **{ [key: string]: any; }** | The metadata document as fetched. | [optional] [default to undefined]
16
+ **effective** | [**CimdCheckResultEffective**](CimdCheckResultEffective.md) | | [optional] [default to undefined]
17
+ **shadow_client** | [**CimdCheckResultShadowClient**](CimdCheckResultShadowClient.md) | | [optional] [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { CimdCheckResult } from '@lumoauth/api-client';
23
+
24
+ const instance: CimdCheckResult = {
25
+ ok,
26
+ client_id,
27
+ enabled,
28
+ reason,
29
+ message,
30
+ warnings,
31
+ document,
32
+ effective,
33
+ shadow_client,
34
+ };
35
+ ```
36
+
37
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,45 @@
1
+ # CimdCheckResultEffective
2
+
3
+ The client LumoAuth derives from the document after organization policy.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **client_name** | **string** | | [optional] [default to undefined]
10
+ **application_type** | **string** | | [optional] [default to undefined]
11
+ **token_endpoint_auth_method** | **string** | | [optional] [default to undefined]
12
+ **public_client** | **boolean** | | [optional] [default to undefined]
13
+ **pkce_required** | **boolean** | | [optional] [default to undefined]
14
+ **redirect_uris** | **Array&lt;string&gt;** | | [optional] [default to undefined]
15
+ **dropped_redirect_uris** | **Array&lt;string&gt;** | Loopback URIs removed by the organization\&#39;s localhost policy. | [optional] [default to undefined]
16
+ **grant_types** | **Array&lt;string&gt;** | | [optional] [default to undefined]
17
+ **scopes** | **Array&lt;string&gt;** | | [optional] [default to undefined]
18
+ **dropped_scopes** | **Array&lt;string&gt;** | Scopes the document asked for that are neither identity scopes nor on the organization\&#39;s cimd_allowed_scopes list. | [optional] [default to undefined]
19
+ **logo_uri** | **string** | | [optional] [default to undefined]
20
+ **client_uri** | **string** | | [optional] [default to undefined]
21
+ **has_loopback_redirect** | **boolean** | | [optional] [default to undefined]
22
+
23
+ ## Example
24
+
25
+ ```typescript
26
+ import { CimdCheckResultEffective } from '@lumoauth/api-client';
27
+
28
+ const instance: CimdCheckResultEffective = {
29
+ client_name,
30
+ application_type,
31
+ token_endpoint_auth_method,
32
+ public_client,
33
+ pkce_required,
34
+ redirect_uris,
35
+ dropped_redirect_uris,
36
+ grant_types,
37
+ scopes,
38
+ dropped_scopes,
39
+ logo_uri,
40
+ client_uri,
41
+ has_loopback_redirect,
42
+ };
43
+ ```
44
+
45
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,23 @@
1
+ # CimdCheckResultShadowClient
2
+
3
+ Present when this organization has already resolved the client at least once.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | | [optional] [default to undefined]
10
+ **last_fetched_at** | **string** | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { CimdCheckResultShadowClient } from '@lumoauth/api-client';
16
+
17
+ const instance: CimdCheckResultShadowClient = {
18
+ id,
19
+ last_fetched_at,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -15,7 +15,8 @@ Name | Type | Description | Notes
15
15
  **masked_phone** | **string** | | [optional] [default to undefined]
16
16
  **resend_after** | **number** | Seconds until a new code may be requested | [optional] [default to undefined]
17
17
  **masked_email** | **string** | | [optional] [default to undefined]
18
- **deep_link** | **string** | | [optional] [default to undefined]
18
+ **deep_link** | **string** | https://&lt;server&gt;/push-auth/enroll?d&#x3D;… — an Android App Link / iOS Universal Link that opens the authenticator app on a phone (falls back to a help page without it). | [optional] [default to undefined]
19
+ **deep_link_android** | **string** | Same link as an intent:// URL pinned to the Android app package, for pages served from this host (Chrome keeps same-site App Links in the browser). Null when the deployment has not configured the package. | [optional] [default to undefined]
19
20
  **activation_code** | **string** | | [optional] [default to undefined]
20
21
  **public_key** | **object** | WebAuthn PublicKeyCredentialCreationOptions | [optional] [default to undefined]
21
22
 
@@ -36,6 +37,7 @@ const instance: EnrollAuthenticator201Response = {
36
37
  resend_after,
37
38
  masked_email,
38
39
  deep_link,
40
+ deep_link_android,
39
41
  activation_code,
40
42
  public_key,
41
43
  };
@@ -53,7 +53,7 @@ Name | Type | Description | Notes
53
53
  **backchannel_user_code_parameter_supported** | **boolean** | | [optional] [default to undefined]
54
54
  **service_documentation** | **string** | | [optional] [default to undefined]
55
55
  **entity_profiles_supported** | **Array&lt;string&gt;** | | [optional] [default to undefined]
56
- **client_id_metadata_document_supported** | **boolean** | Only when CIMD is enabled for the organization. | [optional] [default to undefined]
56
+ **client_id_metadata_document_supported** | **boolean** | Present (true) unless the organization switched Client ID Metadata Documents off. | [optional] [default to undefined]
57
57
  **authorization_grant_profiles_supported** | **Array&lt;string&gt;** | Only when the organization accepts ID-JAGs. | [optional] [default to undefined]
58
58
  **op_policy_uri** | **string** | Only when configured. | [optional] [default to undefined]
59
59
  **op_tos_uri** | **string** | Only when configured. | [optional] [default to undefined]
@@ -8,7 +8,8 @@ Name | Type | Description | Notes
8
8
  **id** | **string** | | [optional] [default to undefined]
9
9
  **state** | **string** | | [optional] [default to undefined]
10
10
  **qr_data_uri** | **string** | | [optional] [default to undefined]
11
- **deep_link** | **string** | | [optional] [default to undefined]
11
+ **deep_link** | **string** | https://&lt;server&gt;/push-auth/enroll?d&#x3D;… — an Android App Link / iOS Universal Link that opens the authenticator app on a phone (falls back to a help page without it). | [optional] [default to undefined]
12
+ **deep_link_android** | **string** | Same link as an intent:// URL pinned to the Android app package, for pages served from this host (Chrome keeps same-site App Links in the browser). Null when the deployment has not configured the package. | [optional] [default to undefined]
12
13
  **activation_code** | **string** | | [optional] [default to undefined]
13
14
  **expires_at** | **string** | | [optional] [default to undefined]
14
15
 
@@ -22,6 +23,7 @@ const instance: PushEnrollmentStarted = {
22
23
  state,
23
24
  qr_data_uri,
24
25
  deep_link,
26
+ deep_link_android,
25
27
  activation_code,
26
28
  expires_at,
27
29
  };
@@ -56,7 +56,7 @@ No authorization required
56
56
  ### HTTP response details
57
57
  | Status code | Description | Response headers |
58
58
  |-------------|-------------|------------------|
59
- |**200** | Authorization server metadata. Conditional members: client_id_metadata_document_supported (CIMD opted in), authorization_grant_profiles_supported and the jwt-bearer grant (Cross App Access resource role), op_policy_uri / op_tos_uri (organization settings). | - |
59
+ |**200** | Authorization server metadata. Conditional members: client_id_metadata_document_supported (CIMD on, the default), authorization_grant_profiles_supported and the jwt-bearer grant (Cross App Access resource role), op_policy_uri / op_tos_uri (organization settings). | - |
60
60
  |**404** | invalid_tenant — unknown or inactive organization. | - |
61
61
 
62
62
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
@@ -160,7 +160,7 @@ No authorization required
160
160
  ### HTTP response details
161
161
  | Status code | Description | Response headers |
162
162
  |-------------|-------------|------------------|
163
- |**200** | OpenID Provider metadata. Conditional members: client_id_metadata_document_supported (CIMD opted in), authorization_grant_profiles_supported and the jwt-bearer grant (Cross App Access resource role), op_policy_uri / op_tos_uri and a tenant acr_values_supported override (organization settings). | - |
163
+ |**200** | OpenID Provider metadata. Conditional members: client_id_metadata_document_supported (CIMD on, the default), authorization_grant_profiles_supported and the jwt-bearer grant (Cross App Access resource role), op_policy_uri / op_tos_uri and a tenant acr_values_supported override (organization settings). | - |
164
164
  |**404** | invalid_tenant — unknown or inactive organization. | - |
165
165
 
166
166
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
@@ -0,0 +1,36 @@
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
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface AdminClientsCimdCheckRequest
21
+ */
22
+ export interface AdminClientsCimdCheckRequest {
23
+ /**
24
+ * The Client Identifier URL (https, with a path).
25
+ * @type {string}
26
+ * @memberof AdminClientsCimdCheckRequest
27
+ */
28
+ 'client_id': string;
29
+ /**
30
+ * Ignore the cached document and fetch it again.
31
+ * @type {boolean}
32
+ * @memberof AdminClientsCimdCheckRequest
33
+ */
34
+ 'refresh'?: boolean;
35
+ }
36
+
@@ -0,0 +1,33 @@
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
+
15
+
16
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { CimdCheckResult } from './cimd-check-result';
19
+
20
+ /**
21
+ *
22
+ * @export
23
+ * @interface AdminClientsCimdCheckResponse
24
+ */
25
+ export interface AdminClientsCimdCheckResponse {
26
+ /**
27
+ *
28
+ * @type {CimdCheckResult}
29
+ * @memberof AdminClientsCimdCheckResponse
30
+ */
31
+ 'data'?: CimdCheckResult;
32
+ }
33
+
@@ -158,7 +158,7 @@ export interface AuthenticationSettings {
158
158
  */
159
159
  'dynamic_client_registration_enabled'?: boolean;
160
160
  /**
161
- *
161
+ * Accept Client ID Metadata Documents (an https URL as client_id). On by default on every plan; set false to opt the organization out.
162
162
  * @type {boolean}
163
163
  * @memberof AuthenticationSettings
164
164
  */
@@ -225,7 +225,7 @@ export interface AuthorizationServerMetadata {
225
225
  */
226
226
  'entity_profiles_supported'?: Array<string>;
227
227
  /**
228
- * Only when CIMD is enabled for the organization.
228
+ * Present (true) unless the organization switched Client ID Metadata Documents off.
229
229
  * @type {boolean}
230
230
  * @memberof AuthorizationServerMetadata
231
231
  */