@lumoauth/api-client 1.5.0 → 1.6.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 +12 -2
- package/README.md +10 -3
- package/api/admin-abac-api.ts +18 -5
- package/api/admin-agents-api.ts +50 -5
- package/api/admin-audit-logs-api.ts +15 -15
- package/api/admin-email-api.ts +15 -15
- package/api/admin-groups-api.ts +15 -15
- package/api/admin-mfa-api.ts +10 -10
- package/api/admin-oauth-clients-api.ts +15 -15
- package/api/admin-roles-api.ts +20 -20
- package/api/admin-settings-api.ts +112 -60
- package/api/admin-users-api.ts +320 -31
- package/api/agents-api.ts +5 -5
- package/api/authorization-api.ts +20 -20
- package/api/oauth-api.ts +116 -5
- package/api/ssf-api.ts +10 -10
- package/dist/api/admin-abac-api.d.ts +10 -2
- package/dist/api/admin-abac-api.js +10 -5
- package/dist/api/admin-agents-api.d.ts +37 -2
- package/dist/api/admin-agents-api.js +37 -6
- package/dist/api/admin-audit-logs-api.d.ts +15 -15
- package/dist/api/admin-audit-logs-api.js +12 -12
- package/dist/api/admin-email-api.d.ts +15 -15
- package/dist/api/admin-email-api.js +12 -12
- package/dist/api/admin-groups-api.d.ts +15 -15
- package/dist/api/admin-groups-api.js +12 -12
- package/dist/api/admin-mfa-api.d.ts +10 -10
- package/dist/api/admin-mfa-api.js +8 -8
- package/dist/api/admin-oauth-clients-api.d.ts +15 -15
- package/dist/api/admin-oauth-clients-api.js +12 -12
- package/dist/api/admin-roles-api.d.ts +20 -20
- package/dist/api/admin-roles-api.js +16 -16
- package/dist/api/admin-settings-api.d.ts +82 -48
- package/dist/api/admin-settings-api.js +68 -52
- package/dist/api/admin-users-api.d.ts +201 -22
- package/dist/api/admin-users-api.js +185 -28
- package/dist/api/agents-api.d.ts +5 -5
- package/dist/api/agents-api.js +4 -4
- package/dist/api/authorization-api.d.ts +20 -20
- package/dist/api/authorization-api.js +16 -16
- package/dist/api/oauth-api.d.ts +70 -5
- package/dist/api/oauth-api.js +76 -4
- package/dist/api/ssf-api.d.ts +10 -10
- package/dist/api/ssf-api.js +8 -8
- package/dist/esm/api/admin-abac-api.d.ts +10 -2
- package/dist/esm/api/admin-abac-api.js +10 -5
- package/dist/esm/api/admin-agents-api.d.ts +37 -2
- package/dist/esm/api/admin-agents-api.js +36 -5
- package/dist/esm/api/admin-audit-logs-api.d.ts +15 -15
- package/dist/esm/api/admin-audit-logs-api.js +12 -12
- package/dist/esm/api/admin-email-api.d.ts +15 -15
- package/dist/esm/api/admin-email-api.js +12 -12
- package/dist/esm/api/admin-groups-api.d.ts +15 -15
- package/dist/esm/api/admin-groups-api.js +12 -12
- package/dist/esm/api/admin-mfa-api.d.ts +10 -10
- package/dist/esm/api/admin-mfa-api.js +8 -8
- package/dist/esm/api/admin-oauth-clients-api.d.ts +15 -15
- package/dist/esm/api/admin-oauth-clients-api.js +12 -12
- package/dist/esm/api/admin-roles-api.d.ts +20 -20
- package/dist/esm/api/admin-roles-api.js +16 -16
- package/dist/esm/api/admin-settings-api.d.ts +82 -48
- package/dist/esm/api/admin-settings-api.js +69 -53
- package/dist/esm/api/admin-users-api.d.ts +201 -22
- package/dist/esm/api/admin-users-api.js +184 -27
- package/dist/esm/api/agents-api.d.ts +5 -5
- package/dist/esm/api/agents-api.js +4 -4
- package/dist/esm/api/authorization-api.d.ts +20 -20
- package/dist/esm/api/authorization-api.js +16 -16
- package/dist/esm/api/oauth-api.d.ts +70 -5
- package/dist/esm/api/oauth-api.js +76 -4
- package/dist/esm/api/ssf-api.d.ts +10 -10
- package/dist/esm/api/ssf-api.js +8 -8
- package/dist/esm/models/abac-attribute-definition.d.ts +6 -0
- package/dist/esm/models/abac-policy.d.ts +7 -1
- package/dist/esm/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
- package/dist/esm/models/admin-groups-list-response.d.ts +6 -0
- package/dist/esm/models/admin-mcp-servers-list-response.d.ts +8 -3
- package/dist/esm/models/admin-settings-all-response-data-general.d.ts +13 -1
- package/dist/esm/models/admin-settings-all-response-data.d.ts +4 -5
- package/dist/esm/models/admin-settings-email-get-response.d.ts +4 -5
- package/dist/esm/models/admin-settings-general-get-response-data.d.ts +4 -10
- package/dist/esm/models/{admin-mcp-servers-list-response-meta.d.ts → admin-users-restore-response.d.ts} +9 -14
- package/dist/esm/models/ask-response.d.ts +15 -0
- package/dist/esm/models/ask-response.js +10 -1
- package/dist/esm/models/attest-response.d.ts +2 -2
- package/dist/esm/models/authorization-server-metadata.d.ts +8 -2
- package/dist/esm/models/check-email-first-request.d.ts +30 -0
- package/dist/esm/models/check-email-first-request.js +14 -0
- package/dist/esm/models/check-email-first-response.d.ts +42 -0
- package/dist/esm/models/check-email-first-response.js +14 -0
- package/dist/esm/models/email-sender-settings.d.ts +62 -0
- package/dist/esm/models/email-sender-settings.js +22 -0
- package/dist/esm/models/get-me-response.d.ts +18 -0
- package/dist/esm/models/get-server-challenge-response.d.ts +3 -2
- package/dist/esm/models/get-server-challenge-response.js +1 -0
- package/dist/esm/models/index.d.ts +6 -1
- package/dist/esm/models/index.js +6 -1
- package/dist/esm/models/introspect-response.d.ts +6 -0
- package/dist/esm/models/issue-agent-token-request.d.ts +6 -0
- package/dist/esm/models/list-users-response.d.ts +6 -0
- package/dist/esm/models/oauth-scope.d.ts +1 -7
- package/dist/esm/models/open-id-configuration.d.ts +3 -3
- package/dist/esm/models/put-admin-settings-branding-update-response.d.ts +6 -0
- package/dist/esm/models/put-admin-settings-email-update-request.d.ts +36 -0
- package/dist/esm/models/put-admin-settings-email-update-request.js +14 -0
- package/dist/esm/models/put-admin-settings-email-update-response.d.ts +4 -5
- package/dist/esm/models/put-admin-settings-general-update-request.d.ts +30 -0
- package/dist/esm/models/put-admin-settings-general-update-request.js +14 -0
- package/dist/esm/models/put-admin-settings-general-update-response-data.d.ts +1 -7
- package/dist/esm/models/register-client-response.d.ts +0 -24
- package/dist/esm/models/registered-client-metadata.d.ts +0 -24
- package/dist/esm/models/social-login-provider.d.ts +2 -1
- package/dist/esm/models/user.d.ts +12 -0
- package/dist/esm/models/userinfo-response.d.ts +4 -12
- package/dist/esm/models/userinfo-response.js +0 -2
- package/dist/models/abac-attribute-definition.d.ts +6 -0
- package/dist/models/abac-policy.d.ts +7 -1
- package/dist/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
- package/dist/models/admin-groups-list-response.d.ts +6 -0
- package/dist/models/admin-mcp-servers-list-response.d.ts +8 -3
- package/dist/models/admin-settings-all-response-data-general.d.ts +13 -1
- package/dist/models/admin-settings-all-response-data.d.ts +4 -5
- package/dist/models/admin-settings-email-get-response.d.ts +4 -5
- package/dist/models/admin-settings-general-get-response-data.d.ts +4 -10
- package/dist/models/{admin-mcp-servers-list-response-meta.d.ts → admin-users-restore-response.d.ts} +9 -14
- package/dist/models/ask-response.d.ts +15 -0
- package/dist/models/ask-response.js +11 -0
- package/dist/models/attest-response.d.ts +2 -2
- package/dist/models/authorization-server-metadata.d.ts +8 -2
- package/dist/models/check-email-first-request.d.ts +30 -0
- package/dist/models/check-email-first-request.js +15 -0
- package/dist/models/check-email-first-response.d.ts +42 -0
- package/dist/models/check-email-first-response.js +15 -0
- package/dist/models/email-sender-settings.d.ts +62 -0
- package/dist/models/email-sender-settings.js +25 -0
- package/dist/models/get-me-response.d.ts +18 -0
- package/dist/models/get-server-challenge-response.d.ts +3 -2
- package/dist/models/get-server-challenge-response.js +1 -0
- package/dist/models/index.d.ts +6 -1
- package/dist/models/index.js +6 -1
- package/dist/models/introspect-response.d.ts +6 -0
- package/dist/models/issue-agent-token-request.d.ts +6 -0
- package/dist/models/list-users-response.d.ts +6 -0
- package/dist/models/oauth-scope.d.ts +1 -7
- package/dist/models/open-id-configuration.d.ts +3 -3
- package/dist/models/put-admin-settings-branding-update-response.d.ts +6 -0
- package/dist/models/put-admin-settings-email-update-request.d.ts +36 -0
- package/dist/models/put-admin-settings-email-update-request.js +15 -0
- package/dist/models/put-admin-settings-email-update-response.d.ts +4 -5
- package/dist/models/put-admin-settings-general-update-request.d.ts +30 -0
- package/dist/models/put-admin-settings-general-update-request.js +15 -0
- package/dist/models/put-admin-settings-general-update-response-data.d.ts +1 -7
- package/dist/models/register-client-response.d.ts +0 -24
- package/dist/models/registered-client-metadata.d.ts +0 -24
- package/dist/models/social-login-provider.d.ts +2 -1
- package/dist/models/user.d.ts +12 -0
- package/dist/models/userinfo-response.d.ts +4 -12
- package/dist/models/userinfo-response.js +0 -2
- package/docs/AbacAttributeDefinition.md +2 -0
- package/docs/AbacPolicy.md +3 -1
- package/docs/AdminAbacApi.md +14 -9
- package/docs/AdminAgentsApi.md +7 -1
- package/docs/AdminAnalyticsDashboardResponseDataAudit.md +1 -1
- package/docs/AdminAuditLogsApi.md +3 -0
- package/docs/AdminEmailApi.md +3 -0
- package/docs/AdminGroupsApi.md +3 -0
- package/docs/AdminGroupsListResponse.md +2 -0
- package/docs/AdminMcpServersListResponse.md +3 -1
- package/docs/AdminMfaApi.md +4 -2
- package/docs/AdminOAuthClientsApi.md +3 -1
- package/docs/AdminOrganizationsApi.md +13 -5
- package/docs/AdminRolesApi.md +10 -0
- package/docs/AdminSettingsAllResponseData.md +1 -1
- package/docs/AdminSettingsAllResponseDataGeneral.md +5 -1
- package/docs/AdminSettingsApi.md +54 -12
- package/docs/AdminSettingsEmailGetResponse.md +1 -1
- package/docs/AdminSettingsGeneralGetResponseData.md +4 -6
- package/docs/AdminUsersApi.md +104 -2
- package/docs/AdminUsersRestoreResponse.md +22 -0
- package/docs/AgentsApi.md +2 -2
- package/docs/AskResponse.md +2 -0
- package/docs/AttestResponse.md +1 -1
- package/docs/AuthorizationApi.md +4 -4
- package/docs/AuthorizationServerMetadata.md +4 -2
- package/docs/CheckEmailFirstRequest.md +22 -0
- package/docs/CheckEmailFirstResponse.md +26 -0
- package/docs/EmailSenderSettings.md +31 -0
- package/docs/GetMeResponse.md +6 -0
- package/docs/GetServerChallengeResponse.md +1 -1
- package/docs/IdentityApi.md +2 -2
- package/docs/IntrospectResponse.md +2 -0
- package/docs/IssueAgentTokenRequest.md +2 -0
- package/docs/ListUsersResponse.md +2 -0
- package/docs/McpApi.md +5 -6
- package/docs/OAuthApi.md +72 -12
- package/docs/OAuthScope.md +1 -3
- package/docs/OIDCApi.md +4 -4
- package/docs/OpenIdConfiguration.md +3 -3
- package/docs/PutAdminSettingsBrandingUpdateResponse.md +2 -0
- package/docs/PutAdminSettingsEmailUpdateRequest.md +24 -0
- package/docs/PutAdminSettingsEmailUpdateResponse.md +1 -1
- package/docs/PutAdminSettingsGeneralUpdateRequest.md +22 -0
- package/docs/PutAdminSettingsGeneralUpdateResponseData.md +1 -3
- package/docs/RegisterClientResponse.md +0 -8
- package/docs/RegisteredClientMetadata.md +0 -8
- package/docs/SocialLoginProvider.md +1 -1
- package/docs/SsfApi.md +2 -0
- package/docs/User.md +4 -0
- package/docs/UserinfoResponse.md +3 -5
- package/docs/WellKnownApi.md +2 -2
- package/models/abac-attribute-definition.ts +6 -0
- package/models/abac-policy.ts +7 -1
- package/models/admin-analytics-dashboard-response-data-audit.ts +1 -1
- package/models/admin-groups-list-response.ts +6 -0
- package/models/admin-mcp-servers-list-response.ts +8 -5
- package/models/admin-settings-all-response-data-general.ts +13 -1
- package/models/admin-settings-all-response-data.ts +6 -3
- package/models/admin-settings-email-get-response.ts +6 -3
- package/models/admin-settings-general-get-response-data.ts +4 -10
- package/models/{admin-mcp-servers-list-response-meta.ts → admin-users-restore-response.ts} +11 -14
- package/models/ask-response.ts +17 -0
- package/models/attest-response.ts +2 -2
- package/models/authorization-server-metadata.ts +8 -2
- package/models/check-email-first-request.ts +36 -0
- package/models/check-email-first-response.ts +48 -0
- package/models/email-sender-settings.ts +70 -0
- package/models/get-me-response.ts +18 -0
- package/models/get-server-challenge-response.ts +3 -2
- package/models/index.ts +6 -1
- package/models/introspect-response.ts +6 -0
- package/models/issue-agent-token-request.ts +6 -0
- package/models/list-users-response.ts +6 -0
- package/models/oauth-scope.ts +1 -7
- package/models/open-id-configuration.ts +3 -3
- package/models/put-admin-settings-branding-update-response.ts +6 -0
- package/models/put-admin-settings-email-update-request.ts +42 -0
- package/models/put-admin-settings-email-update-response.ts +6 -3
- package/models/put-admin-settings-general-update-request.ts +36 -0
- package/models/put-admin-settings-general-update-response-data.ts +1 -7
- package/models/register-client-response.ts +0 -24
- package/models/registered-client-metadata.ts +0 -24
- package/models/social-login-provider.ts +2 -1
- package/models/user.ts +12 -0
- package/models/userinfo-response.ts +4 -12
- package/package.json +1 -1
- package/docs/AdminMcpServersListResponseMeta.md +0 -24
- /package/dist/esm/models/{admin-mcp-servers-list-response-meta.js → admin-users-restore-response.js} +0 -0
- /package/dist/models/{admin-mcp-servers-list-response-meta.js → admin-users-restore-response.js} +0 -0
package/docs/AdminAgentsApi.md
CHANGED
|
@@ -611,9 +611,13 @@ const configuration = new Configuration();
|
|
|
611
611
|
const apiInstance = new AdminAgentsApi(configuration);
|
|
612
612
|
|
|
613
613
|
let orgId: string; // (default to undefined)
|
|
614
|
+
let sortBy: 'name' | 'agentId' | 'status' | 'createdAt' | 'lastUsedAt'; //Sort field. Default: name. Another value is ignored. (optional) (default to undefined)
|
|
615
|
+
let sortDir: 'ASC' | 'DESC'; //Sort direction, used with sortBy. (optional) (default to 'ASC')
|
|
614
616
|
|
|
615
617
|
const { status, data } = await apiInstance.adminAgentsList(
|
|
616
|
-
orgId
|
|
618
|
+
orgId,
|
|
619
|
+
sortBy,
|
|
620
|
+
sortDir
|
|
617
621
|
);
|
|
618
622
|
```
|
|
619
623
|
|
|
@@ -622,6 +626,8 @@ const { status, data } = await apiInstance.adminAgentsList(
|
|
|
622
626
|
|Name | Type | Description | Notes|
|
|
623
627
|
|------------- | ------------- | ------------- | -------------|
|
|
624
628
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
629
|
+
| **sortBy** | [**'name' | 'agentId' | 'status' | 'createdAt' | 'lastUsedAt'**]**Array<'name' | 'agentId' | 'status' | 'createdAt' | 'lastUsedAt'>** | Sort field. Default: name. Another value is ignored. | (optional) defaults to undefined|
|
|
630
|
+
| **sortDir** | [**'ASC' | 'DESC'**]**Array<'ASC' | 'DESC'>** | Sort direction, used with sortBy. | (optional) defaults to 'ASC'|
|
|
625
631
|
|
|
626
632
|
|
|
627
633
|
### Return type
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**eventsLast7Days** | **number** |
|
|
8
|
+
**eventsLast7Days** | **number** | Audit events of the last 7 days, or of the audit retention period of the plan when that is shorter. | [optional] [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -66,6 +66,7 @@ const { status, data } = await apiInstance.adminAuditLogsActions(
|
|
|
66
66
|
# **adminAuditLogsExport**
|
|
67
67
|
> string adminAuditLogsExport()
|
|
68
68
|
|
|
69
|
+
Needs `audit.export` and `audit.view`, as the export on the portal\'s audit log page does.
|
|
69
70
|
|
|
70
71
|
### Example
|
|
71
72
|
|
|
@@ -320,6 +321,7 @@ const { status, data } = await apiInstance.adminAuditLogsStats(
|
|
|
320
321
|
# **patchAdminAuditLogsRetentionUpdate**
|
|
321
322
|
> AdminAuditLogsRetentionResponse patchAdminAuditLogsRetentionUpdate()
|
|
322
323
|
|
|
324
|
+
Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
323
325
|
|
|
324
326
|
### Example
|
|
325
327
|
|
|
@@ -370,6 +372,7 @@ const { status, data } = await apiInstance.patchAdminAuditLogsRetentionUpdate(
|
|
|
370
372
|
# **putAdminAuditLogsRetentionUpdate**
|
|
371
373
|
> AdminAuditLogsRetentionResponse putAdminAuditLogsRetentionUpdate()
|
|
372
374
|
|
|
375
|
+
Needs `settings.manage` and `gdpr.manage`, as the GDPR settings page in the portal does.
|
|
373
376
|
|
|
374
377
|
### Example
|
|
375
378
|
|
package/docs/AdminEmailApi.md
CHANGED
|
@@ -74,6 +74,7 @@ const { status, data } = await apiInstance.adminEmailTemplatesDelete(
|
|
|
74
74
|
# **adminEmailTemplatesGet**
|
|
75
75
|
> EmailTemplate adminEmailTemplatesGet()
|
|
76
76
|
|
|
77
|
+
Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
77
78
|
|
|
78
79
|
### Example
|
|
79
80
|
|
|
@@ -134,6 +135,7 @@ const { status, data } = await apiInstance.adminEmailTemplatesGet(
|
|
|
134
135
|
# **adminEmailTemplatesList**
|
|
135
136
|
> AdminEmailTemplatesListResponse adminEmailTemplatesList()
|
|
136
137
|
|
|
138
|
+
Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
137
139
|
|
|
138
140
|
### Example
|
|
139
141
|
|
|
@@ -294,6 +296,7 @@ const { status, data } = await apiInstance.adminEmailTemplatesUpsert(
|
|
|
294
296
|
# **adminEmailTemplatesVariables**
|
|
295
297
|
> AdminEmailTemplatesVariablesResponse adminEmailTemplatesVariables()
|
|
296
298
|
|
|
299
|
+
Needs `settings.manage` and `users.delete`, as the email template pages in the portal do.
|
|
297
300
|
|
|
298
301
|
### Example
|
|
299
302
|
|
package/docs/AdminGroupsApi.md
CHANGED
|
@@ -74,6 +74,7 @@ const { status, data } = await apiInstance.adminGroupsAddMembers(
|
|
|
74
74
|
# **adminGroupsAddRole**
|
|
75
75
|
> MessageResponse adminGroupsAddRole()
|
|
76
76
|
|
|
77
|
+
A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
|
|
77
78
|
|
|
78
79
|
### Example
|
|
79
80
|
|
|
@@ -127,6 +128,7 @@ const { status, data } = await apiInstance.adminGroupsAddRole(
|
|
|
127
128
|
# **adminGroupsCreate**
|
|
128
129
|
> AdminGroupsCreateResponse adminGroupsCreate()
|
|
129
130
|
|
|
131
|
+
Optional `roles` is a list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left).
|
|
130
132
|
|
|
131
133
|
### Example
|
|
132
134
|
|
|
@@ -551,6 +553,7 @@ const { status, data } = await apiInstance.adminGroupsRemoveRole(
|
|
|
551
553
|
# **adminGroupsUpdateRoles**
|
|
552
554
|
> AdminGroupsCreateResponse adminGroupsUpdateRoles()
|
|
553
555
|
|
|
556
|
+
`roles` is the full list of role slugs. An unknown slug is 400. A role can be given to a group only when it belongs to this organization and the caller holds every permission in it; otherwise the answer is 403 and nothing is stored. The built-in administrator role follows the same rule. When a role opens the admin portal (the built-in one or any role with a portal permission), each active member of the group who is not an administrator yet takes an admin seat (403 `plan_limit_reached` when the plan has too few left). Roles already on the group that the caller could not grant stay on it whatever the list says.
|
|
554
557
|
|
|
555
558
|
### Example
|
|
556
559
|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**data** | [**Array<Group>**](Group.md) | | [optional] [default to undefined]
|
|
9
9
|
**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] [default to undefined]
|
|
10
10
|
**pagination** | [**PaginationMeta**](PaginationMeta.md) | | [optional] [default to undefined]
|
|
11
|
+
**resourceType** | **string** | | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: AdminGroupsListResponse = {
|
|
|
18
19
|
data,
|
|
19
20
|
meta,
|
|
20
21
|
pagination,
|
|
22
|
+
resourceType,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -6,8 +6,9 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**data** | [**Array<McpServer>**](McpServer.md) | | [optional] [default to undefined]
|
|
9
|
-
**meta** | [**
|
|
9
|
+
**meta** | [**PaginationMeta**](PaginationMeta.md) | | [optional] [default to undefined]
|
|
10
10
|
**pagination** | [**PaginationMeta**](PaginationMeta.md) | | [optional] [default to undefined]
|
|
11
|
+
**resourceType** | **string** | | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: AdminMcpServersListResponse = {
|
|
|
18
19
|
data,
|
|
19
20
|
meta,
|
|
20
21
|
pagination,
|
|
22
|
+
resourceType,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
package/docs/AdminMfaApi.md
CHANGED
|
@@ -14,7 +14,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
14
14
|
# **deleteUserAuthenticator**
|
|
15
15
|
> DeleteUserAuthenticatorResponse deleteUserAuthenticator()
|
|
16
16
|
|
|
17
|
-
Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in.
|
|
17
|
+
Revokes a single authenticator (e.g. a lost phone). Trusted devices are revoked and the user is notified. Does not bypass the tenant MFA requirement: the user is prompted to enroll again at next sign-in. A signed-in administrator must have signed in or passed MFA within the last 10 minutes: a Bearer token needs a fresh `auth_time` (otherwise 401 `insufficient_user_authentication`), and an administrator who holds a second factor sends `X-MFA-Challenge` with an approved step_up challenge (otherwise 403 `step_up_required`). Organization API keys are not subject to this check.
|
|
18
18
|
|
|
19
19
|
### Example
|
|
20
20
|
|
|
@@ -65,6 +65,8 @@ const { status, data } = await apiInstance.deleteUserAuthenticator(
|
|
|
65
65
|
| Status code | Description | Response headers |
|
|
66
66
|
|-------------|-------------|------------------|
|
|
67
67
|
|**200** | Removed | - |
|
|
68
|
+
|**401** | insufficient_user_authentication: the access token comes from a sign-in older than 10 minutes | - |
|
|
69
|
+
|**403** | Actor does not outrank the user, or step_up_required | - |
|
|
68
70
|
|**404** | User or authenticator not found | - |
|
|
69
71
|
|
|
70
72
|
[[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)
|
|
@@ -72,7 +74,7 @@ const { status, data } = await apiInstance.deleteUserAuthenticator(
|
|
|
72
74
|
# **getMfaCoverageReport**
|
|
73
75
|
> GetMfaCoverageReportResponse getMfaCoverageReport()
|
|
74
76
|
|
|
75
|
-
Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002).
|
|
77
|
+
Share of users with MFA, by factor type and strongest tier, plus users inside or past the enrollment grace period (POL-002). Needs `users.view` and `settings.view`, as the report on the portal\'s authentication settings page does.
|
|
76
78
|
|
|
77
79
|
### Example
|
|
78
80
|
|
|
@@ -79,7 +79,7 @@ const { status, data } = await apiInstance.adminClientsCimdCheck(
|
|
|
79
79
|
# **adminClientsGetBranding**
|
|
80
80
|
> AdminClientsGetBrandingResponse adminClientsGetBranding()
|
|
81
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\".
|
|
82
|
+
Needs `branding.view` and `clients.view`. 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
83
|
|
|
84
84
|
### Example
|
|
85
85
|
|
|
@@ -504,6 +504,7 @@ const { status, data } = await apiInstance.listClients(
|
|
|
504
504
|
# **patchAdminClientsUpdateBranding**
|
|
505
505
|
> PatchAdminClientsUpdateBrandingResponse patchAdminClientsUpdateBranding()
|
|
506
506
|
|
|
507
|
+
Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
|
|
507
508
|
|
|
508
509
|
### Example
|
|
509
510
|
|
|
@@ -616,6 +617,7 @@ const { status, data } = await apiInstance.patchClient(
|
|
|
616
617
|
# **putAdminClientsUpdateBranding**
|
|
617
618
|
> PutAdminClientsUpdateBrandingResponse putAdminClientsUpdateBranding()
|
|
618
619
|
|
|
620
|
+
Needs `branding.edit` and `clients.edit`, as the Branding tab of the application in the portal does.
|
|
619
621
|
|
|
620
622
|
### Example
|
|
621
623
|
|
|
@@ -75,8 +75,10 @@ const { status, data } = await apiInstance.adminOrgInvitationsCreate(
|
|
|
75
75
|
| Status code | Description | Response headers |
|
|
76
76
|
|-------------|-------------|------------------|
|
|
77
77
|
|**201** | Invitation sent | - |
|
|
78
|
-
|**400** |
|
|
78
|
+
|**400** | A roleId that names no role of this organization, an email that is not an email address, or a message longer than 500 characters | - |
|
|
79
|
+
|**403** | Missing permission, or (`plan_limit_reached`, `limit`: `mau`) the address has no account here and every monthly-active-user place of a plan with a hard cap is used this month | - |
|
|
79
80
|
|**404** | Organization not found | - |
|
|
81
|
+
|**429** | Too many invitations from this organization, or to this address, in the last hour | - |
|
|
80
82
|
|
|
81
83
|
[[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)
|
|
82
84
|
|
|
@@ -187,6 +189,7 @@ const { status, data } = await apiInstance.adminOrgInvitationsResend(
|
|
|
187
189
|
| Status code | Description | Response headers |
|
|
188
190
|
|-------------|-------------|------------------|
|
|
189
191
|
|**200** | Invitation resent | - |
|
|
192
|
+
|**403** | `plan_limit_reached` (`limit`: `mau`): the invited address has no account here and every monthly-active-user place of a plan with a hard cap is used this month | - |
|
|
190
193
|
|**404** | Organization or invitation not found | - |
|
|
191
194
|
|**422** | Unable to resend invitation | - |
|
|
192
195
|
|
|
@@ -466,8 +469,9 @@ const { status, data } = await apiInstance.adminOrgRolesCreate(
|
|
|
466
469
|
| Status code | Description | Response headers |
|
|
467
470
|
|-------------|-------------|------------------|
|
|
468
471
|
|**201** | Role created | - |
|
|
472
|
+
|**400** | Missing name or slug, a slug that is not 2 to 40 lowercase letters, digits, hyphens or underscores, a name longer than 100 characters or a description longer than 1,000 | - |
|
|
469
473
|
|**404** | Organization not found | - |
|
|
470
|
-
|**409** | A role with this
|
|
474
|
+
|**409** | A role with this slug already exists in this organization | - |
|
|
471
475
|
|
|
472
476
|
[[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)
|
|
473
477
|
|
|
@@ -630,7 +634,9 @@ const { status, data } = await apiInstance.adminOrganizationsCreate(
|
|
|
630
634
|
| Status code | Description | Response headers |
|
|
631
635
|
|-------------|-------------|------------------|
|
|
632
636
|
|**201** | Organization created | - |
|
|
633
|
-
|**
|
|
637
|
+
|**400** | name missing, empty or over 100 characters; a slug that does not fit the rule; displayName over 255 characters; logoUrl not an absolute https URL | - |
|
|
638
|
+
|**403** | plan_limit_reached: the plan allows no further customer organization | - |
|
|
639
|
+
|**409** | The slug is taken | - |
|
|
634
640
|
|
|
635
641
|
[[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)
|
|
636
642
|
|
|
@@ -958,8 +964,9 @@ const { status, data } = await apiInstance.patchAdminOrganizationsUpdate(
|
|
|
958
964
|
| Status code | Description | Response headers |
|
|
959
965
|
|-------------|-------------|------------------|
|
|
960
966
|
|**200** | Updated organization | - |
|
|
967
|
+
|**400** | A field that does not fit (see create), or an empty `slug` (leave the field out to keep the slug) | - |
|
|
961
968
|
|**404** | Organization not found | - |
|
|
962
|
-
|**409** |
|
|
969
|
+
|**409** | The slug is taken | - |
|
|
963
970
|
|
|
964
971
|
[[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)
|
|
965
972
|
|
|
@@ -1129,8 +1136,9 @@ const { status, data } = await apiInstance.putAdminOrganizationsUpdate(
|
|
|
1129
1136
|
| Status code | Description | Response headers |
|
|
1130
1137
|
|-------------|-------------|------------------|
|
|
1131
1138
|
|**200** | Updated organization | - |
|
|
1139
|
+
|**400** | A field that does not fit (see create), or an empty `slug` (leave the field out to keep the slug) | - |
|
|
1132
1140
|
|**404** | Organization not found | - |
|
|
1133
|
-
|**409** |
|
|
1141
|
+
|**409** | The slug is taken | - |
|
|
1134
1142
|
|
|
1135
1143
|
[[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)
|
|
1136
1144
|
|
package/docs/AdminRolesApi.md
CHANGED
|
@@ -21,6 +21,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
21
21
|
# **adminRolesAddPermissions**
|
|
22
22
|
> MessageResponse adminRolesAddPermissions()
|
|
23
23
|
|
|
24
|
+
Needs `roles.assign-permissions` and `roles.edit`. Takes `permissionId` or a list `permissionIds`. Every id is judged before anything changes: an unknown id is 400 (`Unknown permission: <id>`), and a permission that the caller does not hold is 403. Either refusal adds nothing. A permission that the role already holds is left as it is. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole request with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
24
25
|
|
|
25
26
|
### Example
|
|
26
27
|
|
|
@@ -68,6 +69,9 @@ const { status, data } = await apiInstance.adminRolesAddPermissions(
|
|
|
68
69
|
| Status code | Description | Response headers |
|
|
69
70
|
|-------------|-------------|------------------|
|
|
70
71
|
|**200** | Added; message reports how many permissions were added | - |
|
|
72
|
+
|**400** | No permissionId / permissionIds, an id that is not a whole number, an unknown id, or a permission reserved for the platform | - |
|
|
73
|
+
|**403** | A permission that the caller does not hold, a system role, or too few admin seats for the holders that the role would make administrators (`plan_limit_reached`) | - |
|
|
74
|
+
|**404** | Role not found | - |
|
|
71
75
|
|
|
72
76
|
[[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)
|
|
73
77
|
|
|
@@ -127,6 +131,7 @@ const { status, data } = await apiInstance.adminRolesAddUser(
|
|
|
127
131
|
# **adminRolesCreate**
|
|
128
132
|
> AdminRolesCreateResponse adminRolesCreate()
|
|
129
133
|
|
|
134
|
+
Optional `permissions` is a list of permission slugs. Giving it needs `roles.assign-permissions` as well as `roles.create`, and every permission must be one that the caller holds; otherwise the answer is 403 and no role is created. An unknown slug is 400.
|
|
130
135
|
|
|
131
136
|
### Example
|
|
132
137
|
|
|
@@ -439,6 +444,7 @@ const { status, data } = await apiInstance.adminRolesList(
|
|
|
439
444
|
# **adminRolesRemovePermission**
|
|
440
445
|
> MessageResponse adminRolesRemovePermission()
|
|
441
446
|
|
|
447
|
+
Needs `roles.assign-permissions` and `roles.edit`.
|
|
442
448
|
|
|
443
449
|
### Example
|
|
444
450
|
|
|
@@ -551,6 +557,7 @@ const { status, data } = await apiInstance.adminRolesRemoveUser(
|
|
|
551
557
|
# **adminRolesUpdatePermissions**
|
|
552
558
|
> AdminRolesCreateResponse adminRolesUpdatePermissions()
|
|
553
559
|
|
|
560
|
+
Needs `roles.assign-permissions` and `roles.edit`. `permissions` is the full list of permission slugs that the role should grant. The whole list is judged before anything changes: an unknown slug is 400 (`Unknown permission: <slug>`), and a permission that the role does not hold yet must be one that the caller holds, otherwise 403. Either refusal changes nothing. Permissions on the role that the caller does not hold are kept, whether or not the list names them. When the role starts to open the admin portal, each active holder that is not an administrator yet takes an admin seat; too few free seats refuse the whole change with 403 `plan_limit_reached`, and `requested` says how many seats it needs.
|
|
554
561
|
|
|
555
562
|
### Example
|
|
556
563
|
|
|
@@ -598,6 +605,9 @@ const { status, data } = await apiInstance.adminRolesUpdatePermissions(
|
|
|
598
605
|
| Status code | Description | Response headers |
|
|
599
606
|
|-------------|-------------|------------------|
|
|
600
607
|
|**200** | Updated role | - |
|
|
608
|
+
|**400** | permissions is missing or not a list, names an unknown slug, or names a permission reserved for the platform | - |
|
|
609
|
+
|**403** | A new permission that the caller does not hold, a system role, or too few admin seats for the holders that the role would make administrators (`plan_limit_reached`) | - |
|
|
610
|
+
|**404** | Role not found | - |
|
|
601
611
|
|
|
602
612
|
[[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)
|
|
603
613
|
|
|
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**authentication** | [**AuthenticationSettings**](AuthenticationSettings.md) | | [optional] [default to undefined]
|
|
10
10
|
**branding** | [**BrandingSettings**](BrandingSettings.md) | | [optional] [default to undefined]
|
|
11
11
|
**security** | [**AdminSettingsAllResponseDataSecurity**](AdminSettingsAllResponseDataSecurity.md) | | [optional] [default to undefined]
|
|
12
|
-
**email** | **
|
|
12
|
+
**email** | [**EmailSenderSettings**](EmailSenderSettings.md) | | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -1,12 +1,14 @@
|
|
|
1
1
|
# AdminSettingsAllResponseDataGeneral
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The organization name (name; displayName is the same value), locale (the default language of the hosted pages), then the stored settings dictionary: any stored key (security, audit_log_retention_days, audit_log_auto_delete, agent_governance, ...) is returned as-is; secret-looking keys are redacted.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**displayName** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**locale** | **string** | | [optional] [default to undefined]
|
|
10
12
|
|
|
11
13
|
## Example
|
|
12
14
|
|
|
@@ -15,6 +17,8 @@ import { AdminSettingsAllResponseDataGeneral } from '@lumoauth/api-client';
|
|
|
15
17
|
|
|
16
18
|
const instance: AdminSettingsAllResponseDataGeneral = {
|
|
17
19
|
name,
|
|
20
|
+
displayName,
|
|
21
|
+
locale,
|
|
18
22
|
};
|
|
19
23
|
```
|
|
20
24
|
|