@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
|
@@ -37,11 +37,12 @@ Name | Type | Description | Notes
|
|
|
37
37
|
**backchannel_authentication_endpoint** | **string** | | [optional] [default to undefined]
|
|
38
38
|
**backchannel_token_delivery_modes_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
39
39
|
**backchannel_user_code_parameter_supported** | **boolean** | | [optional] [default to undefined]
|
|
40
|
+
**resource_indicators_supported** | **boolean** | | [optional] [default to undefined]
|
|
40
41
|
**entity_profiles_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
41
42
|
**client_id_metadata_document_supported** | **boolean** | Present (true) unless the organization switched Client ID Metadata Documents off. | [optional] [default to undefined]
|
|
42
43
|
**authorization_grant_profiles_supported** | **Array<string>** | Only when the organization accepts ID-JAGs. | [optional] [default to undefined]
|
|
43
|
-
**op_policy_uri** | **string** | Only when
|
|
44
|
-
**op_tos_uri** | **string** | Only when
|
|
44
|
+
**op_policy_uri** | **string** | The Privacy policy URL of the organization\'s login page settings. Only when it is set. | [optional] [default to undefined]
|
|
45
|
+
**op_tos_uri** | **string** | The Terms of service URL of the organization\'s login page settings. Only when it is set. | [optional] [default to undefined]
|
|
45
46
|
|
|
46
47
|
## Example
|
|
47
48
|
|
|
@@ -81,6 +82,7 @@ const instance: AuthorizationServerMetadata = {
|
|
|
81
82
|
backchannel_authentication_endpoint,
|
|
82
83
|
backchannel_token_delivery_modes_supported,
|
|
83
84
|
backchannel_user_code_parameter_supported,
|
|
85
|
+
resource_indicators_supported,
|
|
84
86
|
entity_profiles_supported,
|
|
85
87
|
client_id_metadata_document_supported,
|
|
86
88
|
authorization_grant_profiles_supported,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# CheckEmailFirstRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**email** | **string** | The address that was typed. | [default to undefined]
|
|
9
|
+
**client_id** | **string** | Client ID of an active application of the organization. | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { CheckEmailFirstRequest } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: CheckEmailFirstRequest = {
|
|
17
|
+
email,
|
|
18
|
+
client_id,
|
|
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,26 @@
|
|
|
1
|
+
# CheckEmailFirstResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**exists** | **boolean** | Always `true`. The answer never says whether the address has an account. | [default to undefined]
|
|
9
|
+
**magic_link_enabled** | **boolean** | The organization offers sign-in links. | [default to undefined]
|
|
10
|
+
**passkey_enabled** | **boolean** | The organization offers passkey sign-in. | [default to undefined]
|
|
11
|
+
**password_enabled** | **boolean** | The organization accepts passwords at sign-in. | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { CheckEmailFirstResponse } from '@lumoauth/api-client';
|
|
17
|
+
|
|
18
|
+
const instance: CheckEmailFirstResponse = {
|
|
19
|
+
exists,
|
|
20
|
+
magic_link_enabled,
|
|
21
|
+
passkey_enabled,
|
|
22
|
+
password_enabled,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[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,31 @@
|
|
|
1
|
+
# EmailSenderSettings
|
|
2
|
+
|
|
3
|
+
Who sends the organization\'s mail. The values are those of the organization\'s own mail provider (set up in the portal). Without a provider, or while it is switched off, mail is sent by LumoAuth with LumoAuth\'s sender.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**sender** | **string** | Who sends the mail now: `provider` while the organization\'s own mail provider is switched on, else `platform`. | [optional] [readonly] [default to undefined]
|
|
10
|
+
**provider** | **string** | The mail provider that is set up (ses, sendgrid, mailgun, resend, postmark, smtp), or null. | [optional] [readonly] [default to undefined]
|
|
11
|
+
**enabled** | **boolean** | Whether the mail provider is switched on. | [optional] [readonly] [default to undefined]
|
|
12
|
+
**fromEmail** | **string** | From address of mail that the provider sends. It must be a sender that is verified at the provider. | [optional] [default to undefined]
|
|
13
|
+
**fromName** | **string** | From name of mail that the provider sends. | [optional] [default to undefined]
|
|
14
|
+
**replyToEmail** | **string** | Reply-To address of mail that the provider sends. | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { EmailSenderSettings } from '@lumoauth/api-client';
|
|
20
|
+
|
|
21
|
+
const instance: EmailSenderSettings = {
|
|
22
|
+
sender,
|
|
23
|
+
provider,
|
|
24
|
+
enabled,
|
|
25
|
+
fromEmail,
|
|
26
|
+
fromName,
|
|
27
|
+
replyToEmail,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[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/GetMeResponse.md
CHANGED
|
@@ -12,6 +12,9 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**mfa_enabled** | **boolean** | | [optional] [default to undefined]
|
|
13
13
|
**roles** | **Array<string>** | | [optional] [default to undefined]
|
|
14
14
|
**capabilities** | **Array<string>** | | [optional] [default to undefined]
|
|
15
|
+
**scopes** | **Array<string>** | Agents only: the OAuth scope values that the agent may request for this organization\'s API, as RFC 7591 defines a client\'s registered scope. They are its capabilities, each a scope token (RFC 6749 section 3.3). | [optional] [default to undefined]
|
|
16
|
+
**scope** | **Array<string>** | Agents only: the scope of the presented token. | [optional] [default to undefined]
|
|
17
|
+
**scope_narrowed** | **boolean** | Agents only: true when the token scope leaves out one of the agent\'s capabilities. | [optional] [default to undefined]
|
|
15
18
|
**tenant** | [**GroupRef**](GroupRef.md) | | [optional] [default to undefined]
|
|
16
19
|
|
|
17
20
|
## Example
|
|
@@ -27,6 +30,9 @@ const instance: GetMeResponse = {
|
|
|
27
30
|
mfa_enabled,
|
|
28
31
|
roles,
|
|
29
32
|
capabilities,
|
|
33
|
+
scopes,
|
|
34
|
+
scope,
|
|
35
|
+
scope_narrowed,
|
|
30
36
|
tenant,
|
|
31
37
|
};
|
|
32
38
|
```
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**status** | **string** |
|
|
8
|
+
**status** | **string** | `no_authorization_required` for an MCP server that checks no token (Public or stdio): there is nothing to challenge, with or without a token. | [default to undefined]
|
|
9
9
|
**server** | **string** | MCP server display name. | [default to undefined]
|
|
10
10
|
**server_id** | **string** | | [default to undefined]
|
|
11
11
|
|
package/docs/IdentityApi.md
CHANGED
|
@@ -54,8 +54,8 @@ const { status, data } = await apiInstance.getMe(
|
|
|
54
54
|
| Status code | Description | Response headers |
|
|
55
55
|
|-------------|-------------|------------------|
|
|
56
56
|
|**200** | The authenticated principal | - |
|
|
57
|
-
|**401** |
|
|
58
|
-
|**404** |
|
|
57
|
+
|**401** | No credential, an invalid credential, or a credential of another organization | - |
|
|
58
|
+
|**404** | Organization not found | - |
|
|
59
59
|
|
|
60
60
|
[[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)
|
|
61
61
|
|
|
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**iss** | **string** | Issuer identifier of this organization. | [optional] [default to undefined]
|
|
18
18
|
**aud** | [**IntrospectResponseAud**](IntrospectResponseAud.md) | | [optional] [default to undefined]
|
|
19
19
|
**jti** | **string** | JWT id (JWT tokens only). | [optional] [default to undefined]
|
|
20
|
+
**act** | **object** | RFC 8693 actor of a delegated access token (token exchange, or a redeemed identity assertion), with earlier actors nested under `act`. JWT and opaque tokens. | [optional] [default to undefined]
|
|
20
21
|
|
|
21
22
|
## Example
|
|
22
23
|
|
|
@@ -36,6 +37,7 @@ const instance: IntrospectResponse = {
|
|
|
36
37
|
iss,
|
|
37
38
|
aud,
|
|
38
39
|
jti,
|
|
40
|
+
act,
|
|
39
41
|
};
|
|
40
42
|
```
|
|
41
43
|
|
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**code** | **string** | Authorization code to exchange (request_type=code). | [optional] [default to undefined]
|
|
12
12
|
**auth_token** | **string** | Upstream auth token to exchange (request_type=exchange). | [optional] [default to undefined]
|
|
13
13
|
**refresh_token** | **string** | Refresh token to redeem (request_type=refresh). | [optional] [default to undefined]
|
|
14
|
+
**scope** | **string** | request_type=refresh only: optional space-delimited scopes that narrow the refreshed token. Must be a subset of the refresh grant and of the resource token scope (invalid_scope otherwise). Ignored for request_type=auth, where the resource token names the scope. | [optional] [default to undefined]
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
@@ -24,6 +25,7 @@ const instance: IssueAgentTokenRequest = {
|
|
|
24
25
|
code,
|
|
25
26
|
auth_token,
|
|
26
27
|
refresh_token,
|
|
28
|
+
scope,
|
|
27
29
|
};
|
|
28
30
|
```
|
|
29
31
|
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**data** | [**Array<User>**](User.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: ListUsersResponse = {
|
|
|
18
19
|
data,
|
|
19
20
|
meta,
|
|
20
21
|
pagination,
|
|
22
|
+
resourceType,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
package/docs/McpApi.md
CHANGED
|
@@ -63,8 +63,7 @@ No authorization required
|
|
|
63
63
|
| Status code | Description | Response headers |
|
|
64
64
|
|-------------|-------------|------------------|
|
|
65
65
|
|**200** | Protected resource metadata. scopes_supported only when the server declares scopes; the dpop_* members only when the server requires DPoP-bound tokens. Any additional admin-supplied metadata fields are merged in (they can never override resource, authorization_servers, bearer_methods_supported or scopes_supported). | - |
|
|
66
|
-
|**
|
|
67
|
-
|**404** | not_found — unknown organization, or unknown / inactive MCP server. | - |
|
|
66
|
+
|**404** | not_found — unknown organization, unknown / inactive MCP server, or an MCP server that checks no token (Public or stdio): such a server has no protected resource metadata. | - |
|
|
68
67
|
|
|
69
68
|
[[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)
|
|
70
69
|
|
|
@@ -171,7 +170,7 @@ const { status, data } = await apiInstance.getServer(
|
|
|
171
170
|
| Status code | Description | Response headers |
|
|
172
171
|
|-------------|-------------|------------------|
|
|
173
172
|
|**200** | A single MCP server with discovery metadata. | - |
|
|
174
|
-
|**403** | Caller lacks the
|
|
173
|
+
|**403** | Caller lacks the agents.view permission. | - |
|
|
175
174
|
|**404** | Tenant or MCP server not found. | - |
|
|
176
175
|
|
|
177
176
|
[[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)
|
|
@@ -226,7 +225,7 @@ const { status, data } = await apiInstance.getServerChallenge(
|
|
|
226
225
|
### HTTP response details
|
|
227
226
|
| Status code | Description | Response headers |
|
|
228
227
|
|-------------|-------------|------------------|
|
|
229
|
-
|**200** | The access token is valid for this MCP server. | - |
|
|
228
|
+
|**200** | The access token is valid for this MCP server, or the server checks no token. | - |
|
|
230
229
|
|**401** | unauthorized / invalid_token with the MCP WWW-Authenticate challenge (resource_metadata, and scope when the server includes it). | * WWW-Authenticate - <br> |
|
|
231
230
|
|**403** | insufficient_scope — the token lacks required scopes (listed in scope and in WWW-Authenticate). | * WWW-Authenticate - <br> |
|
|
232
231
|
|**404** | not_found — unknown organization, or unknown / inactive MCP server. | - |
|
|
@@ -282,7 +281,7 @@ const { status, data } = await apiInstance.listServers(
|
|
|
282
281
|
| Status code | Description | Response headers |
|
|
283
282
|
|-------------|-------------|------------------|
|
|
284
283
|
|**200** | List of active MCP servers for the tenant. | - |
|
|
285
|
-
|**403** | Caller lacks the
|
|
284
|
+
|**403** | Caller lacks the agents.view permission. | - |
|
|
286
285
|
|**404** | Tenant not found. | - |
|
|
287
286
|
|
|
288
287
|
[[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)
|
|
@@ -400,7 +399,7 @@ const { status, data } = await apiInstance.postServerChallenge(
|
|
|
400
399
|
### HTTP response details
|
|
401
400
|
| Status code | Description | Response headers |
|
|
402
401
|
|-------------|-------------|------------------|
|
|
403
|
-
|**200** | The access token is valid for this MCP server. | - |
|
|
402
|
+
|**200** | The access token is valid for this MCP server, or the server checks no token. | - |
|
|
404
403
|
|**401** | unauthorized / invalid_token with the MCP WWW-Authenticate challenge (resource_metadata, and scope when the server includes it). | * WWW-Authenticate - <br> |
|
|
405
404
|
|**403** | insufficient_scope — the token lacks required scopes (listed in scope and in WWW-Authenticate). | * WWW-Authenticate - <br> |
|
|
406
405
|
|**404** | not_found — unknown organization, or unknown / inactive MCP server. | - |
|
package/docs/OAuthApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**authorize**](#authorize) | **GET** /orgs/{orgId}/api/v1/oauth/authorize | OAuth 2.1 / OIDC authorization endpoint|
|
|
8
8
|
|[**backchannelAuthorize**](#backchannelauthorize) | **POST** /orgs/{orgId}/api/v1/oauth/bc-authorize | CIBA backchannel authentication request|
|
|
9
|
+
|[**checkEmailFirst**](#checkemailfirst) | **POST** /orgs/{orgId}/api/v1/oauth/check-email | Sign-in methods for an email-first form|
|
|
9
10
|
|[**deviceAuthorization**](#deviceauthorization) | **POST** /orgs/{orgId}/api/v1/oauth/device_authorization | Device authorization request (RFC 8628)|
|
|
10
11
|
|[**getClientConfiguration**](#getclientconfiguration) | **GET** /orgs/{orgId}/api/v1/connect/register/{clientId} | Read a dynamically registered client (RFC 7592 / OIDC DCR §4)|
|
|
11
12
|
|[**getDeviceVerification**](#getdeviceverification) | **GET** /orgs/{orgId}/api/v1/oauth/device | Device verification page (RFC 8628 §3.3)|
|
|
@@ -75,7 +76,7 @@ No authorization required
|
|
|
75
76
|
|**303** | Authorization response delivered to the client\'s redirect_uri in the query (default) or fragment, carrying code, state and iss (or error / error_description) — JARM modes carry a single response JWT. A session_state cookie accompanies successful responses. | * Location - <br> |
|
|
76
77
|
|**302** | Interstitial redirect: to the hosted login page, a social identity provider, the MFA / step-up challenge, the organization selector, or to logout for prompt=login. | * Location - <br> |
|
|
77
78
|
|**400** | HTML error page for malformed requests (unknown client, unregistered redirect_uri, invalid request object, …). | - |
|
|
78
|
-
|**429** | too_many_requests (JSON). | - |
|
|
79
|
+
|**429** | too_many_requests (JSON); Retry-After names the seconds to wait. | - |
|
|
79
80
|
|
|
80
81
|
[[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)
|
|
81
82
|
|
|
@@ -130,7 +131,66 @@ const { status, data } = await apiInstance.backchannelAuthorize(
|
|
|
130
131
|
|**400** | invalid_request, unauthorized_client (CIBA not enabled for the client or plan), invalid_scope, missing_user_code / invalid_user_code or invalid_authorization_details. | - |
|
|
131
132
|
|**401** | invalid_client — client authentication failed. | - |
|
|
132
133
|
|**403** | unauthorized_client (agent_id named but not authenticated by that agent) or access_denied. | - |
|
|
133
|
-
|**429** | too_many_requests, or slow_down when the target user already has too many pending requests. | - |
|
|
134
|
+
|**429** | too_many_requests (rate limit exceeded; Retry-After names the seconds to wait), or slow_down when the target user already has too many pending requests. | - |
|
|
135
|
+
|
|
136
|
+
[[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)
|
|
137
|
+
|
|
138
|
+
# **checkEmailFirst**
|
|
139
|
+
> CheckEmailFirstResponse checkEmailFirst(checkEmailFirstRequest)
|
|
140
|
+
|
|
141
|
+
For applications that render their own sign-in form. Returns the sign-in methods that the organization offers, so that the form can show the next step after an address was typed. The answer does not depend on the address: `exists` is always `true`, and a known address and a new one get the same answer. Takes no credential and signs nobody in. A browser request must come from one of the allowed origins of the application named by `client_id`.
|
|
142
|
+
|
|
143
|
+
### Example
|
|
144
|
+
|
|
145
|
+
```typescript
|
|
146
|
+
import {
|
|
147
|
+
OAuthApi,
|
|
148
|
+
Configuration,
|
|
149
|
+
CheckEmailFirstRequest
|
|
150
|
+
} from '@lumoauth/api-client';
|
|
151
|
+
|
|
152
|
+
const configuration = new Configuration();
|
|
153
|
+
const apiInstance = new OAuthApi(configuration);
|
|
154
|
+
|
|
155
|
+
let orgId: string; // (default to undefined)
|
|
156
|
+
let checkEmailFirstRequest: CheckEmailFirstRequest; //
|
|
157
|
+
|
|
158
|
+
const { status, data } = await apiInstance.checkEmailFirst(
|
|
159
|
+
orgId,
|
|
160
|
+
checkEmailFirstRequest
|
|
161
|
+
);
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Parameters
|
|
165
|
+
|
|
166
|
+
|Name | Type | Description | Notes|
|
|
167
|
+
|------------- | ------------- | ------------- | -------------|
|
|
168
|
+
| **checkEmailFirstRequest** | **CheckEmailFirstRequest**| | |
|
|
169
|
+
| **orgId** | [**string**] | | defaults to undefined|
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
### Return type
|
|
173
|
+
|
|
174
|
+
**CheckEmailFirstResponse**
|
|
175
|
+
|
|
176
|
+
### Authorization
|
|
177
|
+
|
|
178
|
+
No authorization required
|
|
179
|
+
|
|
180
|
+
### HTTP request headers
|
|
181
|
+
|
|
182
|
+
- **Content-Type**: application/json
|
|
183
|
+
- **Accept**: application/json
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
### HTTP response details
|
|
187
|
+
| Status code | Description | Response headers |
|
|
188
|
+
|-------------|-------------|------------------|
|
|
189
|
+
|**200** | The organization\'s sign-in methods. The same for every address. | - |
|
|
190
|
+
|**400** | `{\"error\": …, \"message\": …}` with error `invalid_request` or `invalid_client`. | - |
|
|
191
|
+
|**403** | `{\"error\":\"origin_not_allowed\"}`: the page that made the request is not one of the application\'s allowed origins. | - |
|
|
192
|
+
|**404** | `{\"error\":\"not_found\"}` for an unknown organization. | - |
|
|
193
|
+
|**429** | `{\"error\":\"rate_limited\"}`; Retry-After names the seconds to wait. | - |
|
|
134
194
|
|
|
135
195
|
[[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)
|
|
136
196
|
|
|
@@ -184,7 +244,7 @@ const { status, data } = await apiInstance.deviceAuthorization(
|
|
|
184
244
|
|**200** | Device authorization response (RFC 8628 §3.2). | - |
|
|
185
245
|
|**400** | invalid_request (client_id missing), invalid_client (unknown / inactive client), unauthorized_client (grant not allowed) or invalid_scope. | - |
|
|
186
246
|
|**401** | invalid_client — a confidential client failed to authenticate. | - |
|
|
187
|
-
|**429** | too_many_requests — rate limit exceeded. | - |
|
|
247
|
+
|**429** | too_many_requests — rate limit exceeded; Retry-After names the seconds to wait. | - |
|
|
188
248
|
|
|
189
249
|
[[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)
|
|
190
250
|
|
|
@@ -292,7 +352,7 @@ No authorization required
|
|
|
292
352
|
|-------------|-------------|------------------|
|
|
293
353
|
|**200** | HTML page: code entry form (with inline validation errors), the device consent page, or the success / denied / error result page. | - |
|
|
294
354
|
|**302** | Redirect to the hosted login page when no user session exists; the browser returns here after sign-in. | * Location - <br> |
|
|
295
|
-
|**429** | HTML error page — too many attempts. | - |
|
|
355
|
+
|**429** | HTML error page — too many attempts (Retry-After header). | - |
|
|
296
356
|
|
|
297
357
|
[[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)
|
|
298
358
|
|
|
@@ -399,7 +459,7 @@ const { status, data } = await apiInstance.introspect(
|
|
|
399
459
|
|**200** | Introspection response (RFC 7662 §2.2). An inactive, expired, revoked or unknown token yields only {\"active\": false}. For an active token the optional members are present when known: username only for user-bound tokens; iss/aud only for tokens bound to a client; nbf/jti only for JWT access tokens; empty-string values are omitted. | - |
|
|
400
460
|
|**400** | invalid_request — token parameter missing. | - |
|
|
401
461
|
|**401** | invalid_client — client authentication failed. | - |
|
|
402
|
-
|**429** |
|
|
462
|
+
|**429** | too_many_requests — rate limit exceeded; Retry-After names the seconds to wait. | - |
|
|
403
463
|
|
|
404
464
|
[[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)
|
|
405
465
|
|
|
@@ -453,14 +513,14 @@ const { status, data } = await apiInstance.par(
|
|
|
453
513
|
|**201** | Pushed authorization request created (RFC 9126 §2.2). | - |
|
|
454
514
|
|**400** | invalid_request / invalid_target / invalid_request_object, or the organization is unknown. | - |
|
|
455
515
|
|**401** | invalid_client — client authentication failed. | - |
|
|
456
|
-
|**429** | too_many_requests — rate limit exceeded. | - |
|
|
516
|
+
|**429** | too_many_requests — rate limit exceeded; Retry-After names the seconds to wait. | - |
|
|
457
517
|
|
|
458
518
|
[[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)
|
|
459
519
|
|
|
460
520
|
# **registerClient**
|
|
461
521
|
> RegisterClientResponse registerClient()
|
|
462
522
|
|
|
463
|
-
Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it.
|
|
523
|
+
Registers an OAuth client from a JSON metadata document. Authenticated with an initial access token (Authorization: Bearer) or an API key holding admin:clients:register; open registration applies when the organization allows it. Refused with invalid_client_metadata: grant_types other than authorization_code and refresh_token, response_types other than code and none, subject_type other than public, sector_identifier_uri, request_uris, userinfo_signed_response_alg, an id_token_signed_response_alg other than the organization\'s signing algorithm, and every encryption member (id_token_encrypted_response_*, userinfo_encrypted_response_*, request_object_encryption_*, authorization_encrypted_response_*).
|
|
464
524
|
|
|
465
525
|
### Example
|
|
466
526
|
|
|
@@ -508,7 +568,7 @@ const { status, data } = await apiInstance.registerClient(
|
|
|
508
568
|
|**400** | invalid_request (invalid JSON / unknown organization), invalid_client_metadata or invalid_redirect_uri. | - |
|
|
509
569
|
|**401** | access_denied — initial access token required or invalid (WWW-Authenticate: Bearer). | - |
|
|
510
570
|
|**403** | access_denied — dynamic registration disabled for this organization, or the API key is not authorized for it. | - |
|
|
511
|
-
|**429** | too_many_requests — rate limit exceeded. | - |
|
|
571
|
+
|**429** | too_many_requests — rate limit exceeded; Retry-After names the seconds to wait. | - |
|
|
512
572
|
|
|
513
573
|
[[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)
|
|
514
574
|
|
|
@@ -621,7 +681,7 @@ const { status, data } = await apiInstance.revoke(
|
|
|
621
681
|
|**200** | Revocation acknowledged — always 200 with an empty JSON object, whether or not the token existed (RFC 7009 §2.2). | - |
|
|
622
682
|
|**400** | invalid_request (token parameter missing) or unsupported_token_type. | - |
|
|
623
683
|
|**401** | invalid_client — client authentication failed. | - |
|
|
624
|
-
|**429** | too_many_requests — rate limit exceeded. | - |
|
|
684
|
+
|**429** | too_many_requests — rate limit exceeded; Retry-After names the seconds to wait. | - |
|
|
625
685
|
|
|
626
686
|
[[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)
|
|
627
687
|
|
|
@@ -838,7 +898,7 @@ No authorization required
|
|
|
838
898
|
|**303** | Authorization response delivered to the client\'s redirect_uri in the query (default) or fragment, carrying code, state and iss (or error / error_description) — JARM modes carry a single response JWT. A session_state cookie accompanies successful responses. | * Location - <br> |
|
|
839
899
|
|**302** | Interstitial redirect: to the hosted login page, a social identity provider, the MFA / step-up challenge, the organization selector, or to logout for prompt=login. | * Location - <br> |
|
|
840
900
|
|**400** | HTML error page for malformed requests (unknown client, unregistered redirect_uri, invalid request object, …). | - |
|
|
841
|
-
|**429** | too_many_requests (JSON). | - |
|
|
901
|
+
|**429** | too_many_requests (JSON); Retry-After names the seconds to wait. | - |
|
|
842
902
|
|
|
843
903
|
[[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)
|
|
844
904
|
|
|
@@ -891,7 +951,7 @@ No authorization required
|
|
|
891
951
|
|-------------|-------------|------------------|
|
|
892
952
|
|**200** | HTML page: code entry form (with inline validation errors), the device consent page, or the success / denied / error result page. | - |
|
|
893
953
|
|**302** | Redirect to the hosted login page when no user session exists; the browser returns here after sign-in. | * Location - <br> |
|
|
894
|
-
|**429** | HTML error page — too many attempts. | - |
|
|
954
|
+
|**429** | HTML error page — too many attempts (Retry-After header). | - |
|
|
895
955
|
|
|
896
956
|
[[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)
|
|
897
957
|
|
|
@@ -1055,7 +1115,7 @@ const { status, data } = await apiInstance.token(
|
|
|
1055
1115
|
|**400** | invalid_request / invalid_grant / unsupported_grant_type / invalid_scope (RFC 6749 §5.2). | - |
|
|
1056
1116
|
|**401** | invalid_client — client authentication failed. | - |
|
|
1057
1117
|
|**403** | plan_limit_reached — the month\'s included machine-to-machine tokens or active agents are used on a plan without overage; error_description says which. | - |
|
|
1058
|
-
|**429** | too_many_requests — rate limit exceeded. | - |
|
|
1118
|
+
|**429** | too_many_requests — rate limit exceeded; Retry-After names the seconds to wait. | - |
|
|
1059
1119
|
|
|
1060
1120
|
[[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)
|
|
1061
1121
|
|
package/docs/OAuthScope.md
CHANGED
|
@@ -7,8 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **number** | | [optional] [default to undefined]
|
|
9
9
|
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**description** | **string** |
|
|
11
|
-
**isDefault** | **boolean** | | [optional] [default to undefined]
|
|
10
|
+
**description** | **string** | Shown to users on the consent page next to the scope name. | [optional] [default to undefined]
|
|
12
11
|
**isSystem** | **boolean** | | [optional] [default to undefined]
|
|
13
12
|
**createdAt** | **string** | | [optional] [default to undefined]
|
|
14
13
|
|
|
@@ -21,7 +20,6 @@ const instance: OAuthScope = {
|
|
|
21
20
|
id,
|
|
22
21
|
name,
|
|
23
22
|
description,
|
|
24
|
-
isDefault,
|
|
25
23
|
isSystem,
|
|
26
24
|
createdAt,
|
|
27
25
|
};
|
package/docs/OIDCApi.md
CHANGED
|
@@ -214,9 +214,9 @@ const { status, data } = await apiInstance.userinfo(
|
|
|
214
214
|
### HTTP response details
|
|
215
215
|
| Status code | Description | Response headers |
|
|
216
216
|
|-------------|-------------|------------------|
|
|
217
|
-
|**200** | Claims for the token\'s principal. The shape depends on the identity type: a user token yields standard OIDC claims gated by scope (profile, email, phone, address), roles only when the client enabled the roles claim, plus tenant — null-valued claims are omitted; an agent token (no openid scope needed: an agent is not an End-User and reads only its own record) yields sub=agent_<id>, name, agent_id, workload_identity, capabilities, budget_policy, tenant, identity_type=agent
|
|
217
|
+
|**200** | Claims for the token\'s principal. The shape depends on the identity type: a user token yields standard OIDC claims gated by scope (profile, email, phone, address), roles only when the client enabled the roles claim, plus tenant — null-valued claims are omitted; an agent token (no openid scope needed: an agent is not an End-User and reads only its own record) yields sub=agent_<id>, name, agent_id, workload_identity, capabilities, budget_policy, tenant, identity_type=agent. A token from the client credentials grant of an OAuth client names neither and is refused with 401 invalid_token, as a JWT and as an opaque token. Sent with Cache-Control: no-store. | - |
|
|
218
218
|
|**400** | invalid_request — Authorization header missing or malformed. | - |
|
|
219
|
-
|**401** | invalid_token (invalid, expired,
|
|
219
|
+
|**401** | invalid_token (invalid, expired, wrong DPoP binding, or a client credentials token, which names no user) or invalid_dpop_proof. | - |
|
|
220
220
|
|**403** | insufficient_scope — the openid scope is required. | - |
|
|
221
221
|
|
|
222
222
|
[[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)
|
|
@@ -268,9 +268,9 @@ const { status, data } = await apiInstance.userinfoPost(
|
|
|
268
268
|
### HTTP response details
|
|
269
269
|
| Status code | Description | Response headers |
|
|
270
270
|
|-------------|-------------|------------------|
|
|
271
|
-
|**200** | Claims for the token\'s principal. The shape depends on the identity type: a user token yields standard OIDC claims gated by scope (profile, email, phone, address), roles only when the client enabled the roles claim, plus tenant — null-valued claims are omitted; an agent token (no openid scope needed: an agent is not an End-User and reads only its own record) yields sub=agent_<id>, name, agent_id, workload_identity, capabilities, budget_policy, tenant, identity_type=agent
|
|
271
|
+
|**200** | Claims for the token\'s principal. The shape depends on the identity type: a user token yields standard OIDC claims gated by scope (profile, email, phone, address), roles only when the client enabled the roles claim, plus tenant — null-valued claims are omitted; an agent token (no openid scope needed: an agent is not an End-User and reads only its own record) yields sub=agent_<id>, name, agent_id, workload_identity, capabilities, budget_policy, tenant, identity_type=agent. A token from the client credentials grant of an OAuth client names neither and is refused with 401 invalid_token, as a JWT and as an opaque token. Sent with Cache-Control: no-store. | - |
|
|
272
272
|
|**400** | invalid_request — Authorization header missing or malformed. | - |
|
|
273
|
-
|**401** | invalid_token (invalid, expired,
|
|
273
|
+
|**401** | invalid_token (invalid, expired, wrong DPoP binding, or a client credentials token, which names no user) or invalid_dpop_proof. | - |
|
|
274
274
|
|**403** | insufficient_scope — the openid scope is required. | - |
|
|
275
275
|
|
|
276
276
|
[[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)
|
|
@@ -31,7 +31,7 @@ Name | Type | Description | Notes
|
|
|
31
31
|
**request_object_signing_alg_values_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
32
32
|
**ui_locales_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
33
33
|
**prompt_values_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
34
|
-
**acr_values_supported** | **Array<string>** | The four MFA tier ACR values plus the single-factor urn:lumoauth:acr:pwd (any signed-in session)
|
|
34
|
+
**acr_values_supported** | **Array<string>** | The four MFA tier ACR values plus the single-factor urn:lumoauth:acr:pwd (any signed-in session). The list is the same for every organization. | [optional] [default to undefined]
|
|
35
35
|
**code_challenge_methods_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
36
36
|
**authorization_response_iss_parameter_supported** | **boolean** | | [optional] [default to undefined]
|
|
37
37
|
**pushed_authorization_request_endpoint** | **string** | | [optional] [default to undefined]
|
|
@@ -55,8 +55,8 @@ Name | Type | Description | Notes
|
|
|
55
55
|
**entity_profiles_supported** | **Array<string>** | | [optional] [default to undefined]
|
|
56
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<string>** | Only when the organization accepts ID-JAGs. | [optional] [default to undefined]
|
|
58
|
-
**op_policy_uri** | **string** | Only when
|
|
59
|
-
**op_tos_uri** | **string** | Only when
|
|
58
|
+
**op_policy_uri** | **string** | The Privacy policy URL of the organization\'s login page settings. Only when it is set. | [optional] [default to undefined]
|
|
59
|
+
**op_tos_uri** | **string** | The Terms of service URL of the organization\'s login page settings. Only when it is set. | [optional] [default to undefined]
|
|
60
60
|
|
|
61
61
|
## Example
|
|
62
62
|
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**data** | [**BrandingSettings**](BrandingSettings.md) | | [optional] [default to undefined]
|
|
9
|
+
**rejected** | **Array<string>** | Keys whose value was refused by validation and not saved. | [optional] [default to undefined]
|
|
9
10
|
**message** | **string** | | [optional] [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
@@ -15,6 +16,7 @@ import { PutAdminSettingsBrandingUpdateResponse } from '@lumoauth/api-client';
|
|
|
15
16
|
|
|
16
17
|
const instance: PutAdminSettingsBrandingUpdateResponse = {
|
|
17
18
|
data,
|
|
19
|
+
rejected,
|
|
18
20
|
message,
|
|
19
21
|
};
|
|
20
22
|
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# PutAdminSettingsEmailUpdateRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**fromEmail** | **string** | From address. It must be a sender that is verified at the mail provider. | [optional] [default to undefined]
|
|
9
|
+
**fromName** | **string** | From name: one line. null or an empty string clears it. | [optional] [default to undefined]
|
|
10
|
+
**replyToEmail** | **string** | Reply-To address. null or an empty string clears it. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { PutAdminSettingsEmailUpdateRequest } from '@lumoauth/api-client';
|
|
16
|
+
|
|
17
|
+
const instance: PutAdminSettingsEmailUpdateRequest = {
|
|
18
|
+
fromEmail,
|
|
19
|
+
fromName,
|
|
20
|
+
replyToEmail,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**data** | **
|
|
8
|
+
**data** | [**EmailSenderSettings**](EmailSenderSettings.md) | | [optional] [default to undefined]
|
|
9
9
|
**message** | **string** | | [optional] [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PutAdminSettingsGeneralUpdateRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | Name of the organization: one line, 1 to 255 characters. Aliases: tenantName, display_name, displayName. | [optional] [default to undefined]
|
|
9
|
+
**locale** | **string** | Default language of the hosted pages: en, es, fr, de, pt_BR (pt-BR is accepted too), it, nl, ja or ar. A change also needs the branding.edit permission. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PutAdminSettingsGeneralUpdateRequest } from '@lumoauth/api-client';
|
|
15
|
+
|
|
16
|
+
const instance: PutAdminSettingsGeneralUpdateRequest = {
|
|
17
|
+
name,
|
|
18
|
+
locale,
|
|
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)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# PutAdminSettingsGeneralUpdateResponseData
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
name, displayName (the same value) and locale, 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
|
|
|
@@ -8,7 +8,6 @@ Name | Type | Description | Notes
|
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**name** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**displayName** | **string** | | [optional] [default to undefined]
|
|
11
|
-
**timezone** | **string** | | [optional] [default to undefined]
|
|
12
11
|
**locale** | **string** | | [optional] [default to undefined]
|
|
13
12
|
|
|
14
13
|
## Example
|
|
@@ -19,7 +18,6 @@ import { PutAdminSettingsGeneralUpdateResponseData } from '@lumoauth/api-client'
|
|
|
19
18
|
const instance: PutAdminSettingsGeneralUpdateResponseData = {
|
|
20
19
|
name,
|
|
21
20
|
displayName,
|
|
22
|
-
timezone,
|
|
23
21
|
locale,
|
|
24
22
|
};
|
|
25
23
|
```
|
|
@@ -22,16 +22,12 @@ Name | Type | Description | Notes
|
|
|
22
22
|
**logo_uri** | **string** | | [optional] [default to undefined]
|
|
23
23
|
**policy_uri** | **string** | | [optional] [default to undefined]
|
|
24
24
|
**tos_uri** | **string** | | [optional] [default to undefined]
|
|
25
|
-
**sector_identifier_uri** | **string** | | [optional] [default to undefined]
|
|
26
|
-
**subject_type** | **string** | Only when not \"public\". | [optional] [default to undefined]
|
|
27
25
|
**jwks_uri** | **string** | | [optional] [default to undefined]
|
|
28
26
|
**jwks** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
|
29
27
|
**post_logout_redirect_uris** | **Array<string>** | | [optional] [default to undefined]
|
|
30
28
|
**initiate_login_uri** | **string** | | [optional] [default to undefined]
|
|
31
|
-
**request_uris** | **Array<string>** | | [optional] [default to undefined]
|
|
32
29
|
**scope** | **string** | Space-separated registered scopes. | [optional] [default to undefined]
|
|
33
30
|
**id_token_signed_response_alg** | **string** | Only when not RS256. | [optional] [default to undefined]
|
|
34
|
-
**userinfo_signed_response_alg** | **string** | | [optional] [default to undefined]
|
|
35
31
|
**request_object_signing_alg** | **string** | | [optional] [default to undefined]
|
|
36
32
|
**token_endpoint_auth_signing_alg** | **string** | | [optional] [default to undefined]
|
|
37
33
|
**default_max_age** | **number** | | [optional] [default to undefined]
|
|
@@ -66,16 +62,12 @@ const instance: RegisterClientResponse = {
|
|
|
66
62
|
logo_uri,
|
|
67
63
|
policy_uri,
|
|
68
64
|
tos_uri,
|
|
69
|
-
sector_identifier_uri,
|
|
70
|
-
subject_type,
|
|
71
65
|
jwks_uri,
|
|
72
66
|
jwks,
|
|
73
67
|
post_logout_redirect_uris,
|
|
74
68
|
initiate_login_uri,
|
|
75
|
-
request_uris,
|
|
76
69
|
scope,
|
|
77
70
|
id_token_signed_response_alg,
|
|
78
|
-
userinfo_signed_response_alg,
|
|
79
71
|
request_object_signing_alg,
|
|
80
72
|
token_endpoint_auth_signing_alg,
|
|
81
73
|
default_max_age,
|