@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
package/dist/models/index.js
CHANGED
|
@@ -72,6 +72,8 @@ __exportStar(require("./admin-audit-logs-stats-response-data-period"), exports);
|
|
|
72
72
|
__exportStar(require("./admin-client-tokens-revoke-all-response"), exports);
|
|
73
73
|
__exportStar(require("./admin-clients-cimd-check-request"), exports);
|
|
74
74
|
__exportStar(require("./admin-clients-cimd-check-response"), exports);
|
|
75
|
+
__exportStar(require("./admin-clients-get-branding-response"), exports);
|
|
76
|
+
__exportStar(require("./admin-clients-get-branding-response-data"), exports);
|
|
75
77
|
__exportStar(require("./admin-email-templates-list-response"), exports);
|
|
76
78
|
__exportStar(require("./admin-email-templates-preview-response"), exports);
|
|
77
79
|
__exportStar(require("./admin-email-templates-variables-response"), exports);
|
|
@@ -329,6 +331,7 @@ __exportStar(require("./organization-role"), exports);
|
|
|
329
331
|
__exportStar(require("./pagination-meta"), exports);
|
|
330
332
|
__exportStar(require("./par-response"), exports);
|
|
331
333
|
__exportStar(require("./passkey-enrollment-started"), exports);
|
|
334
|
+
__exportStar(require("./patch-admin-clients-update-branding-response"), exports);
|
|
332
335
|
__exportStar(require("./permission"), exports);
|
|
333
336
|
__exportStar(require("./protected-resource-list"), exports);
|
|
334
337
|
__exportStar(require("./protected-resource-metadata"), exports);
|
|
@@ -337,6 +340,8 @@ __exportStar(require("./put-abac-attributes-update-response"), exports);
|
|
|
337
340
|
__exportStar(require("./put-abac-policies-update-response"), exports);
|
|
338
341
|
__exportStar(require("./put-admin-agents-update-request"), exports);
|
|
339
342
|
__exportStar(require("./put-admin-agents-update-response"), exports);
|
|
343
|
+
__exportStar(require("./put-admin-clients-update-branding-request"), exports);
|
|
344
|
+
__exportStar(require("./put-admin-clients-update-branding-response"), exports);
|
|
340
345
|
__exportStar(require("./put-admin-org-members-update-response"), exports);
|
|
341
346
|
__exportStar(require("./put-admin-settings-authentication-update-response"), exports);
|
|
342
347
|
__exportStar(require("./put-admin-settings-branding-update-response"), exports);
|
|
@@ -165,6 +165,12 @@ export interface OpenIdConfiguration {
|
|
|
165
165
|
* @memberof OpenIdConfiguration
|
|
166
166
|
*/
|
|
167
167
|
'ui_locales_supported'?: Array<string>;
|
|
168
|
+
/**
|
|
169
|
+
*
|
|
170
|
+
* @type {Array<string>}
|
|
171
|
+
* @memberof OpenIdConfiguration
|
|
172
|
+
*/
|
|
173
|
+
'prompt_values_supported'?: Array<string>;
|
|
168
174
|
/**
|
|
169
175
|
* The four MFA tier ACR values plus the single-factor urn:lumoauth:acr:pwd (any signed-in session), unless overridden in organization settings.
|
|
170
176
|
* @type {Array<string>}
|
|
@@ -201,12 +207,6 @@ export interface OpenIdConfiguration {
|
|
|
201
207
|
* @memberof OpenIdConfiguration
|
|
202
208
|
*/
|
|
203
209
|
'dpop_signing_alg_values_supported'?: Array<string>;
|
|
204
|
-
/**
|
|
205
|
-
*
|
|
206
|
-
* @type {boolean}
|
|
207
|
-
* @memberof OpenIdConfiguration
|
|
208
|
-
*/
|
|
209
|
-
'tls_client_certificate_bound_access_tokens'?: boolean;
|
|
210
210
|
/**
|
|
211
211
|
*
|
|
212
212
|
* @type {string}
|
|
@@ -0,0 +1,32 @@
|
|
|
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 PatchAdminClientsUpdateBrandingResponse
|
|
16
|
+
*/
|
|
17
|
+
export interface PatchAdminClientsUpdateBrandingResponse {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {{ [key: string]: any; }}
|
|
21
|
+
* @memberof PatchAdminClientsUpdateBrandingResponse
|
|
22
|
+
*/
|
|
23
|
+
'data'?: {
|
|
24
|
+
[key: string]: any;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {Array<string>}
|
|
29
|
+
* @memberof PatchAdminClientsUpdateBrandingResponse
|
|
30
|
+
*/
|
|
31
|
+
'rejected'?: Array<string>;
|
|
32
|
+
}
|
|
@@ -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 });
|
|
@@ -0,0 +1,34 @@
|
|
|
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 PutAdminClientsUpdateBrandingRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface PutAdminClientsUpdateBrandingRequest {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {{ [key: string]: any; }}
|
|
21
|
+
* @memberof PutAdminClientsUpdateBrandingRequest
|
|
22
|
+
*/
|
|
23
|
+
'login'?: {
|
|
24
|
+
[key: string]: any;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {{ [key: string]: any; }}
|
|
29
|
+
* @memberof PutAdminClientsUpdateBrandingRequest
|
|
30
|
+
*/
|
|
31
|
+
'consent'?: {
|
|
32
|
+
[key: string]: any;
|
|
33
|
+
};
|
|
34
|
+
}
|
|
@@ -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 });
|
|
@@ -0,0 +1,32 @@
|
|
|
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 PutAdminClientsUpdateBrandingResponse
|
|
16
|
+
*/
|
|
17
|
+
export interface PutAdminClientsUpdateBrandingResponse {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {{ [key: string]: any; }}
|
|
21
|
+
* @memberof PutAdminClientsUpdateBrandingResponse
|
|
22
|
+
*/
|
|
23
|
+
'data'?: {
|
|
24
|
+
[key: string]: any;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* Keys whose value was refused by validation and not saved
|
|
28
|
+
* @type {Array<string>}
|
|
29
|
+
* @memberof PutAdminClientsUpdateBrandingResponse
|
|
30
|
+
*/
|
|
31
|
+
'rejected'?: Array<string>;
|
|
32
|
+
}
|
|
@@ -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 });
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AdminClientsGetBrandingResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**AdminClientsGetBrandingResponseData**](AdminClientsGetBrandingResponseData.md) | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AdminClientsGetBrandingResponse } from '@lumoauth/api-client';
|
|
14
|
+
|
|
15
|
+
const instance: AdminClientsGetBrandingResponse = {
|
|
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)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# AdminClientsGetBrandingResponseData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**login** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
9
|
+
**consent** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AdminClientsGetBrandingResponseData } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: AdminClientsGetBrandingResponseData = {
|
|
17
|
+
login,
|
|
18
|
+
consent,
|
|
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)
|
package/docs/AdminEmailApi.md
CHANGED
|
@@ -28,10 +28,14 @@ const apiInstance = new AdminEmailApi(configuration);
|
|
|
28
28
|
|
|
29
29
|
let orgId: string; // (default to undefined)
|
|
30
30
|
let type: string; // (default to undefined)
|
|
31
|
+
let locale: string; // (optional) (default to undefined)
|
|
32
|
+
let clientId: string; // (optional) (default to undefined)
|
|
31
33
|
|
|
32
34
|
const { status, data } = await apiInstance.adminEmailTemplatesDelete(
|
|
33
35
|
orgId,
|
|
34
|
-
type
|
|
36
|
+
type,
|
|
37
|
+
locale,
|
|
38
|
+
clientId
|
|
35
39
|
);
|
|
36
40
|
```
|
|
37
41
|
|
|
@@ -41,6 +45,8 @@ const { status, data } = await apiInstance.adminEmailTemplatesDelete(
|
|
|
41
45
|
|------------- | ------------- | ------------- | -------------|
|
|
42
46
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
43
47
|
| **type** | [**string**] | | defaults to undefined|
|
|
48
|
+
| **locale** | [**string**] | | (optional) defaults to undefined|
|
|
49
|
+
| **clientId** | [**string**] | | (optional) defaults to undefined|
|
|
44
50
|
|
|
45
51
|
|
|
46
52
|
### Return type
|
|
@@ -82,10 +88,14 @@ const apiInstance = new AdminEmailApi(configuration);
|
|
|
82
88
|
|
|
83
89
|
let orgId: string; // (default to undefined)
|
|
84
90
|
let type: string; // (default to undefined)
|
|
91
|
+
let locale: string; //Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language (optional) (default to undefined)
|
|
92
|
+
let clientId: string; //Application variant (OAuth client_id); omit for the variant used by every application (optional) (default to undefined)
|
|
85
93
|
|
|
86
94
|
const { status, data } = await apiInstance.adminEmailTemplatesGet(
|
|
87
95
|
orgId,
|
|
88
|
-
type
|
|
96
|
+
type,
|
|
97
|
+
locale,
|
|
98
|
+
clientId
|
|
89
99
|
);
|
|
90
100
|
```
|
|
91
101
|
|
|
@@ -95,6 +105,8 @@ const { status, data } = await apiInstance.adminEmailTemplatesGet(
|
|
|
95
105
|
|------------- | ------------- | ------------- | -------------|
|
|
96
106
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
97
107
|
| **type** | [**string**] | | defaults to undefined|
|
|
108
|
+
| **locale** | [**string**] | Language variant (BCP 47, e.g. fr or pt-BR); omit for the variant used in every language | (optional) defaults to undefined|
|
|
109
|
+
| **clientId** | [**string**] | Application variant (OAuth client_id); omit for the variant used by every application | (optional) defaults to undefined|
|
|
98
110
|
|
|
99
111
|
|
|
100
112
|
### Return type
|
|
@@ -226,6 +238,7 @@ const { status, data } = await apiInstance.adminEmailTemplatesPreview(
|
|
|
226
238
|
# **adminEmailTemplatesUpsert**
|
|
227
239
|
> EmailTemplate adminEmailTemplatesUpsert()
|
|
228
240
|
|
|
241
|
+
Body: subject, body_html, and optionally locale (BCP 47) and client_id to save a language- or application-specific version. Mails use the most specific version: application + language, application, language, then the default.
|
|
229
242
|
|
|
230
243
|
### Example
|
|
231
244
|
|
|
@@ -5,6 +5,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**adminClientsCimdCheck**](#adminclientscimdcheck) | **POST** /orgs/{orgId}/api/v1/admin/clients/cimd/check | Check a Client ID Metadata Document|
|
|
8
|
+
|[**adminClientsGetBranding**](#adminclientsgetbranding) | **GET** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Get an OAuth client\'s login and consent page branding|
|
|
8
9
|
|[**createClient**](#createclient) | **POST** /orgs/{orgId}/api/v1/admin/clients | Create an OAuth client|
|
|
9
10
|
|[**deleteClient**](#deleteclient) | **DELETE** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Delete an OAuth client|
|
|
10
11
|
|[**disableClient**](#disableclient) | **POST** /orgs/{orgId}/api/v1/admin/clients/{clientId}/disable | Disable an OAuth client|
|
|
@@ -12,7 +13,9 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
12
13
|
|[**getClient**](#getclient) | **GET** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Get an OAuth client|
|
|
13
14
|
|[**listClientScopes**](#listclientscopes) | **GET** /orgs/{orgId}/api/v1/admin/clients/{clientId}/scopes | List the scopes granted to an OAuth client|
|
|
14
15
|
|[**listClients**](#listclients) | **GET** /orgs/{orgId}/api/v1/admin/clients | List OAuth clients|
|
|
16
|
+
|[**patchAdminClientsUpdateBranding**](#patchadminclientsupdatebranding) | **PATCH** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Change keys of an OAuth client\'s login and/or consent page branding|
|
|
15
17
|
|[**patchClient**](#patchclient) | **PATCH** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Update an OAuth client|
|
|
18
|
+
|[**putAdminClientsUpdateBranding**](#putadminclientsupdatebranding) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Replace an OAuth client\'s login and/or consent page branding|
|
|
16
19
|
|[**rotateClientSecret**](#rotateclientsecret) | **POST** /orgs/{orgId}/api/v1/admin/clients/{clientId}/rotate-secret | Rotate an OAuth client secret|
|
|
17
20
|
|[**setClientScopes**](#setclientscopes) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/scopes | Replace the scopes granted to an OAuth client|
|
|
18
21
|
|[**updateClient**](#updateclient) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Replace an OAuth client|
|
|
@@ -73,6 +76,61 @@ const { status, data } = await apiInstance.adminClientsCimdCheck(
|
|
|
73
76
|
|
|
74
77
|
[[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
78
|
|
|
79
|
+
# **adminClientsGetBranding**
|
|
80
|
+
> AdminClientsGetBrandingResponse adminClientsGetBranding()
|
|
81
|
+
|
|
82
|
+
Login settings use the same keys as the organization branding settings (GET /settings/branding); a missing or null value means \"same as the organization\".
|
|
83
|
+
|
|
84
|
+
### Example
|
|
85
|
+
|
|
86
|
+
```typescript
|
|
87
|
+
import {
|
|
88
|
+
AdminOAuthClientsApi,
|
|
89
|
+
Configuration
|
|
90
|
+
} from '@lumoauth/api-client';
|
|
91
|
+
|
|
92
|
+
const configuration = new Configuration();
|
|
93
|
+
const apiInstance = new AdminOAuthClientsApi(configuration);
|
|
94
|
+
|
|
95
|
+
let orgId: string; // (default to undefined)
|
|
96
|
+
let clientId: string; // (default to undefined)
|
|
97
|
+
|
|
98
|
+
const { status, data } = await apiInstance.adminClientsGetBranding(
|
|
99
|
+
orgId,
|
|
100
|
+
clientId
|
|
101
|
+
);
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Parameters
|
|
105
|
+
|
|
106
|
+
|Name | Type | Description | Notes|
|
|
107
|
+
|------------- | ------------- | ------------- | -------------|
|
|
108
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
109
|
+
| **clientId** | [**string**] | | defaults to undefined|
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
### Return type
|
|
113
|
+
|
|
114
|
+
**AdminClientsGetBrandingResponse**
|
|
115
|
+
|
|
116
|
+
### Authorization
|
|
117
|
+
|
|
118
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
|
119
|
+
|
|
120
|
+
### HTTP request headers
|
|
121
|
+
|
|
122
|
+
- **Content-Type**: Not defined
|
|
123
|
+
- **Accept**: application/json
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
### HTTP response details
|
|
127
|
+
| Status code | Description | Response headers |
|
|
128
|
+
|-------------|-------------|------------------|
|
|
129
|
+
|**200** | Branding of the application | - |
|
|
130
|
+
|**404** | OAuth client not found | - |
|
|
131
|
+
|
|
132
|
+
[[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)
|
|
133
|
+
|
|
76
134
|
# **createClient**
|
|
77
135
|
> CreateClientResponse createClient()
|
|
78
136
|
|
|
@@ -443,6 +501,64 @@ const { status, data } = await apiInstance.listClients(
|
|
|
443
501
|
|
|
444
502
|
[[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)
|
|
445
503
|
|
|
504
|
+
# **patchAdminClientsUpdateBranding**
|
|
505
|
+
> PatchAdminClientsUpdateBrandingResponse patchAdminClientsUpdateBranding()
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
### Example
|
|
509
|
+
|
|
510
|
+
```typescript
|
|
511
|
+
import {
|
|
512
|
+
AdminOAuthClientsApi,
|
|
513
|
+
Configuration,
|
|
514
|
+
AdminClientsGetBrandingResponseData
|
|
515
|
+
} from '@lumoauth/api-client';
|
|
516
|
+
|
|
517
|
+
const configuration = new Configuration();
|
|
518
|
+
const apiInstance = new AdminOAuthClientsApi(configuration);
|
|
519
|
+
|
|
520
|
+
let orgId: string; // (default to undefined)
|
|
521
|
+
let clientId: string; // (default to undefined)
|
|
522
|
+
let adminClientsGetBrandingResponseData: AdminClientsGetBrandingResponseData; // (optional)
|
|
523
|
+
|
|
524
|
+
const { status, data } = await apiInstance.patchAdminClientsUpdateBranding(
|
|
525
|
+
orgId,
|
|
526
|
+
clientId,
|
|
527
|
+
adminClientsGetBrandingResponseData
|
|
528
|
+
);
|
|
529
|
+
```
|
|
530
|
+
|
|
531
|
+
### Parameters
|
|
532
|
+
|
|
533
|
+
|Name | Type | Description | Notes|
|
|
534
|
+
|------------- | ------------- | ------------- | -------------|
|
|
535
|
+
| **adminClientsGetBrandingResponseData** | **AdminClientsGetBrandingResponseData**| | |
|
|
536
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
537
|
+
| **clientId** | [**string**] | | defaults to undefined|
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
### Return type
|
|
541
|
+
|
|
542
|
+
**PatchAdminClientsUpdateBrandingResponse**
|
|
543
|
+
|
|
544
|
+
### Authorization
|
|
545
|
+
|
|
546
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
|
547
|
+
|
|
548
|
+
### HTTP request headers
|
|
549
|
+
|
|
550
|
+
- **Content-Type**: application/json
|
|
551
|
+
- **Accept**: application/json
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
### HTTP response details
|
|
555
|
+
| Status code | Description | Response headers |
|
|
556
|
+
|-------------|-------------|------------------|
|
|
557
|
+
|**200** | Updated branding | - |
|
|
558
|
+
|**404** | OAuth client not found | - |
|
|
559
|
+
|
|
560
|
+
[[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)
|
|
561
|
+
|
|
446
562
|
# **patchClient**
|
|
447
563
|
> UpdateClientResponse patchClient()
|
|
448
564
|
|
|
@@ -497,6 +613,64 @@ const { status, data } = await apiInstance.patchClient(
|
|
|
497
613
|
|
|
498
614
|
[[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)
|
|
499
615
|
|
|
616
|
+
# **putAdminClientsUpdateBranding**
|
|
617
|
+
> PutAdminClientsUpdateBrandingResponse putAdminClientsUpdateBranding()
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
### Example
|
|
621
|
+
|
|
622
|
+
```typescript
|
|
623
|
+
import {
|
|
624
|
+
AdminOAuthClientsApi,
|
|
625
|
+
Configuration,
|
|
626
|
+
PutAdminClientsUpdateBrandingRequest
|
|
627
|
+
} from '@lumoauth/api-client';
|
|
628
|
+
|
|
629
|
+
const configuration = new Configuration();
|
|
630
|
+
const apiInstance = new AdminOAuthClientsApi(configuration);
|
|
631
|
+
|
|
632
|
+
let orgId: string; // (default to undefined)
|
|
633
|
+
let clientId: string; // (default to undefined)
|
|
634
|
+
let putAdminClientsUpdateBrandingRequest: PutAdminClientsUpdateBrandingRequest; // (optional)
|
|
635
|
+
|
|
636
|
+
const { status, data } = await apiInstance.putAdminClientsUpdateBranding(
|
|
637
|
+
orgId,
|
|
638
|
+
clientId,
|
|
639
|
+
putAdminClientsUpdateBrandingRequest
|
|
640
|
+
);
|
|
641
|
+
```
|
|
642
|
+
|
|
643
|
+
### Parameters
|
|
644
|
+
|
|
645
|
+
|Name | Type | Description | Notes|
|
|
646
|
+
|------------- | ------------- | ------------- | -------------|
|
|
647
|
+
| **putAdminClientsUpdateBrandingRequest** | **PutAdminClientsUpdateBrandingRequest**| | |
|
|
648
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
649
|
+
| **clientId** | [**string**] | | defaults to undefined|
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
### Return type
|
|
653
|
+
|
|
654
|
+
**PutAdminClientsUpdateBrandingResponse**
|
|
655
|
+
|
|
656
|
+
### Authorization
|
|
657
|
+
|
|
658
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
|
|
659
|
+
|
|
660
|
+
### HTTP request headers
|
|
661
|
+
|
|
662
|
+
- **Content-Type**: application/json
|
|
663
|
+
- **Accept**: application/json
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
### HTTP response details
|
|
667
|
+
| Status code | Description | Response headers |
|
|
668
|
+
|-------------|-------------|------------------|
|
|
669
|
+
|**200** | Updated branding | - |
|
|
670
|
+
|**404** | OAuth client not found | - |
|
|
671
|
+
|
|
672
|
+
[[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)
|
|
673
|
+
|
|
500
674
|
# **rotateClientSecret**
|
|
501
675
|
> RotateClientSecretResponse rotateClientSecret()
|
|
502
676
|
|
|
@@ -34,7 +34,6 @@ Name | Type | Description | Notes
|
|
|
34
34
|
**pushed_authorization_request_endpoint** | **string** | | [optional] [default to undefined]
|
|
35
35
|
**require_pushed_authorization_requests** | **boolean** | | [optional] [default to undefined]
|
|
36
36
|
**dpop_signing_alg_values_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
37
|
-
**tls_client_certificate_bound_access_tokens** | **boolean** | | [optional] [default to undefined]
|
|
38
37
|
**backchannel_authentication_endpoint** | **string** | | [optional] [default to undefined]
|
|
39
38
|
**backchannel_token_delivery_modes_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
40
39
|
**backchannel_user_code_parameter_supported** | **boolean** | | [optional] [default to undefined]
|
|
@@ -79,7 +78,6 @@ const instance: AuthorizationServerMetadata = {
|
|
|
79
78
|
pushed_authorization_request_endpoint,
|
|
80
79
|
require_pushed_authorization_requests,
|
|
81
80
|
dpop_signing_alg_values_supported,
|
|
82
|
-
tls_client_certificate_bound_access_tokens,
|
|
83
81
|
backchannel_authentication_endpoint,
|
|
84
82
|
backchannel_token_delivery_modes_supported,
|
|
85
83
|
backchannel_user_code_parameter_supported,
|
package/docs/OAuthApi.md
CHANGED
|
@@ -12,7 +12,6 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
12
12
|
|[**getOrgSelection**](#getorgselection) | **GET** /orgs/{orgId}/api/v1/oauth/org-select | Organization selector page|
|
|
13
13
|
|[**introspect**](#introspect) | **POST** /orgs/{orgId}/api/v1/oauth/introspect | Token introspection (RFC 7662)|
|
|
14
14
|
|[**par**](#par) | **POST** /orgs/{orgId}/api/v1/oauth/par | Pushed authorization request (RFC 9126)|
|
|
15
|
-
|[**passkeyLogin**](#passkeylogin) | **GET** /orgs/{orgId}/api/v1/oauth/passkey-login | Passkey login entry point|
|
|
16
15
|
|[**registerClient**](#registerclient) | **POST** /orgs/{orgId}/api/v1/connect/register | Dynamic client registration (RFC 7591 / OIDC DCR)|
|
|
17
16
|
|[**revoke**](#revoke) | **POST** /orgs/{orgId}/api/v1/oauth/revoke | Token revocation (RFC 7009)|
|
|
18
17
|
|[**socialCallback**](#socialcallback) | **GET** /orgs/{orgId}/api/v1/oauth/social/{provider}/callback | Social / enterprise identity-provider callback|
|
|
@@ -20,7 +19,6 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
20
19
|
|[**socialLogin**](#sociallogin) | **GET** /orgs/{orgId}/api/v1/oauth/social/{provider} | Start social / enterprise identity-provider login|
|
|
21
20
|
|[**submitAuthorization**](#submitauthorization) | **POST** /orgs/{orgId}/api/v1/oauth/authorize | OAuth 2.1 / OIDC authorization endpoint (form submission)|
|
|
22
21
|
|[**submitDeviceVerification**](#submitdeviceverification) | **POST** /orgs/{orgId}/api/v1/oauth/device | Submit device verification|
|
|
23
|
-
|[**submitLogin**](#submitlogin) | **POST** /orgs/{orgId}/api/v1/oauth/login/submit | Hosted login form submission|
|
|
24
22
|
|[**submitLoginJson**](#submitloginjson) | **POST** /orgs/{orgId}/api/v1/oauth/login/json | Programmatic (JSON) login for the authorization flow|
|
|
25
23
|
|[**submitOrgSelection**](#submitorgselection) | **POST** /orgs/{orgId}/api/v1/oauth/org-select | Submit organization selection|
|
|
26
24
|
|[**token**](#token) | **POST** /orgs/{orgId}/api/v1/oauth/token | OAuth 2.1 token endpoint|
|
|
@@ -458,57 +456,6 @@ const { status, data } = await apiInstance.par(
|
|
|
458
456
|
|
|
459
457
|
[[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)
|
|
460
458
|
|
|
461
|
-
# **passkeyLogin**
|
|
462
|
-
> passkeyLogin()
|
|
463
|
-
|
|
464
|
-
Placeholder: flashes an informational message and redirects to the hosted login page. Not a JSON API.
|
|
465
|
-
|
|
466
|
-
### Example
|
|
467
|
-
|
|
468
|
-
```typescript
|
|
469
|
-
import {
|
|
470
|
-
OAuthApi,
|
|
471
|
-
Configuration
|
|
472
|
-
} from '@lumoauth/api-client';
|
|
473
|
-
|
|
474
|
-
const configuration = new Configuration();
|
|
475
|
-
const apiInstance = new OAuthApi(configuration);
|
|
476
|
-
|
|
477
|
-
let orgId: string; // (default to undefined)
|
|
478
|
-
|
|
479
|
-
const { status, data } = await apiInstance.passkeyLogin(
|
|
480
|
-
orgId
|
|
481
|
-
);
|
|
482
|
-
```
|
|
483
|
-
|
|
484
|
-
### Parameters
|
|
485
|
-
|
|
486
|
-
|Name | Type | Description | Notes|
|
|
487
|
-
|------------- | ------------- | ------------- | -------------|
|
|
488
|
-
| **orgId** | [**string**] | | defaults to undefined|
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
### Return type
|
|
492
|
-
|
|
493
|
-
void (empty response body)
|
|
494
|
-
|
|
495
|
-
### Authorization
|
|
496
|
-
|
|
497
|
-
No authorization required
|
|
498
|
-
|
|
499
|
-
### HTTP request headers
|
|
500
|
-
|
|
501
|
-
- **Content-Type**: Not defined
|
|
502
|
-
- **Accept**: Not defined
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
### HTTP response details
|
|
506
|
-
| Status code | Description | Response headers |
|
|
507
|
-
|-------------|-------------|------------------|
|
|
508
|
-
|**302** | Redirect to the hosted login page. | * Location - <br> |
|
|
509
|
-
|
|
510
|
-
[[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)
|
|
511
|
-
|
|
512
459
|
# **registerClient**
|
|
513
460
|
> RegisterClientResponse registerClient()
|
|
514
461
|
|
|
@@ -888,58 +835,6 @@ No authorization required
|
|
|
888
835
|
|
|
889
836
|
[[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)
|
|
890
837
|
|
|
891
|
-
# **submitLogin**
|
|
892
|
-
> submitLogin()
|
|
893
|
-
|
|
894
|
-
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.
|
|
895
|
-
|
|
896
|
-
### Example
|
|
897
|
-
|
|
898
|
-
```typescript
|
|
899
|
-
import {
|
|
900
|
-
OAuthApi,
|
|
901
|
-
Configuration
|
|
902
|
-
} from '@lumoauth/api-client';
|
|
903
|
-
|
|
904
|
-
const configuration = new Configuration();
|
|
905
|
-
const apiInstance = new OAuthApi(configuration);
|
|
906
|
-
|
|
907
|
-
let orgId: string; // (default to undefined)
|
|
908
|
-
|
|
909
|
-
const { status, data } = await apiInstance.submitLogin(
|
|
910
|
-
orgId
|
|
911
|
-
);
|
|
912
|
-
```
|
|
913
|
-
|
|
914
|
-
### Parameters
|
|
915
|
-
|
|
916
|
-
|Name | Type | Description | Notes|
|
|
917
|
-
|------------- | ------------- | ------------- | -------------|
|
|
918
|
-
| **orgId** | [**string**] | | defaults to undefined|
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
### Return type
|
|
922
|
-
|
|
923
|
-
void (empty response body)
|
|
924
|
-
|
|
925
|
-
### Authorization
|
|
926
|
-
|
|
927
|
-
No authorization required
|
|
928
|
-
|
|
929
|
-
### HTTP request headers
|
|
930
|
-
|
|
931
|
-
- **Content-Type**: Not defined
|
|
932
|
-
- **Accept**: Not defined
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
### HTTP response details
|
|
936
|
-
| Status code | Description | Response headers |
|
|
937
|
-
|-------------|-------------|------------------|
|
|
938
|
-
|**302** | Redirect to /oauth/authorize with the original client_id, redirect_uri, state, scope, PKCE and nonce parameters. | * Location - <br> |
|
|
939
|
-
|**404** | Unknown or inactive organization. | - |
|
|
940
|
-
|
|
941
|
-
[[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)
|
|
942
|
-
|
|
943
838
|
# **submitLoginJson**
|
|
944
839
|
> SubmitLoginJsonResponse submitLoginJson()
|
|
945
840
|
|