@lumoauth/api-client 1.4.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 +24 -2
- package/README.md +20 -6
- package/api/admin-abac-api.ts +18 -5
- package/api/admin-agents-api.ts +86 -15
- 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-mcp-api.ts +5 -5
- package/api/admin-mfa-api.ts +10 -10
- package/api/admin-oauth-clients-api.ts +20 -20
- package/api/admin-roles-api.ts +20 -20
- package/api/admin-sandbox-api.ts +5 -5
- package/api/admin-settings-api.ts +112 -60
- package/api/admin-users-api.ts +347 -57
- package/api/admin-webhooks-api.ts +25 -25
- package/api/agents-api.ts +5 -5
- package/api/authorization-api.ts +20 -20
- package/api/oauth-api.ts +227 -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 +58 -6
- package/dist/api/admin-agents-api.js +55 -16
- 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-mcp-api.d.ts +5 -5
- package/dist/api/admin-mcp-api.js +4 -4
- 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 +20 -20
- package/dist/api/admin-oauth-clients-api.js +16 -16
- package/dist/api/admin-roles-api.d.ts +20 -20
- package/dist/api/admin-roles-api.js +16 -16
- package/dist/api/admin-sandbox-api.d.ts +5 -5
- package/dist/api/admin-sandbox-api.js +4 -4
- 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 +228 -48
- package/dist/api/admin-users-api.js +206 -48
- package/dist/api/admin-webhooks-api.d.ts +25 -25
- package/dist/api/admin-webhooks-api.js +20 -20
- 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 +135 -5
- package/dist/api/oauth-api.js +148 -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 +58 -6
- package/dist/esm/api/admin-agents-api.js +54 -15
- 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-mcp-api.d.ts +5 -5
- package/dist/esm/api/admin-mcp-api.js +4 -4
- 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 +20 -20
- package/dist/esm/api/admin-oauth-clients-api.js +16 -16
- 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-sandbox-api.d.ts +5 -5
- package/dist/esm/api/admin-sandbox-api.js +4 -4
- 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 +228 -48
- package/dist/esm/api/admin-users-api.js +205 -47
- package/dist/esm/api/admin-webhooks-api.d.ts +25 -25
- package/dist/esm/api/admin-webhooks-api.js +20 -20
- 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 +135 -5
- package/dist/esm/api/oauth-api.js +149 -5
- 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-agents-agents-rotate-key-request.d.ts +30 -0
- package/dist/esm/models/admin-agents-agents-rotate-key-response.d.ts +6 -0
- package/dist/esm/models/admin-agents-create-request.d.ts +8 -0
- package/dist/esm/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
- package/dist/esm/models/admin-audit-logs-retention-response-data.d.ts +21 -3
- package/dist/esm/models/admin-groups-list-response.d.ts +6 -0
- package/dist/esm/models/admin-identities-link-request.d.ts +8 -1
- package/dist/esm/models/admin-identities-link-request.js +1 -0
- package/dist/esm/models/admin-identities-list-response-data-bindings-item.d.ts +7 -0
- package/dist/esm/models/admin-identities-list-response-data-bindings-item.js +1 -0
- package/dist/esm/models/admin-mcp-servers-list-response.d.ts +8 -3
- package/dist/esm/models/admin-sandbox-spawn-response-data.d.ts +18 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data.js +14 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data1.d.ts +24 -0
- package/dist/esm/models/admin-sandbox-spawn-response-data1.js +14 -0
- package/dist/esm/models/admin-sandbox-spawn-response.d.ts +3 -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/admin-users-restore-response.js +14 -0
- package/dist/esm/models/admin-webhooks-delivery-replay-response-data.d.ts +48 -0
- package/dist/esm/models/admin-webhooks-delivery-replay-response-data.js +14 -0
- package/dist/esm/models/admin-webhooks-delivery-replay-response.d.ts +3 -3
- package/dist/esm/models/admin-webhooks-test-response.d.ts +6 -0
- 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-identity.d.ts +1 -1
- package/dist/esm/models/attest-response.d.ts +2 -2
- package/dist/esm/models/audit-log-entry.d.ts +1 -1
- package/dist/esm/models/authentication-settings-password-policy.d.ts +25 -1
- package/dist/esm/models/authentication-settings-password-rotation-policy.d.ts +1 -13
- package/dist/esm/models/authentication-settings.d.ts +13 -15
- package/dist/esm/models/authentication-settings.js +11 -0
- 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-approval-status-response-approved-by.d.ts +2 -2
- 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 +12 -1
- package/dist/esm/models/index.js +12 -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-permissions-response-permissions-item.d.ts +1 -1
- package/dist/esm/models/list-users-response.d.ts +6 -0
- package/dist/esm/models/oauth-client-secret-issued.d.ts +1 -1
- package/dist/esm/models/oauth-client.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/push-enrollment-started.d.ts +1 -1
- package/dist/esm/models/put-admin-agents-update-request.d.ts +8 -0
- 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/request-magic-link-request.d.ts +42 -0
- package/dist/esm/models/request-magic-link-request.js +14 -0
- package/dist/esm/models/request-magic-link-response.d.ts +31 -0
- package/dist/esm/models/request-magic-link-response.js +21 -0
- package/dist/esm/models/scim-settings-inbound-protected-attributes.d.ts +2 -9
- package/dist/esm/models/scim-settings-inbound.d.ts +0 -8
- package/dist/esm/models/scim-settings-outbound.d.ts +2 -10
- 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-agents-agents-rotate-key-request.d.ts +30 -0
- package/dist/models/admin-agents-agents-rotate-key-response.d.ts +6 -0
- package/dist/models/admin-agents-create-request.d.ts +8 -0
- package/dist/models/admin-analytics-dashboard-response-data-audit.d.ts +1 -1
- package/dist/models/admin-audit-logs-retention-response-data.d.ts +21 -3
- package/dist/models/admin-groups-list-response.d.ts +6 -0
- package/dist/models/admin-identities-link-request.d.ts +8 -1
- package/dist/models/admin-identities-link-request.js +1 -0
- package/dist/models/admin-identities-list-response-data-bindings-item.d.ts +7 -0
- package/dist/models/admin-identities-list-response-data-bindings-item.js +1 -0
- package/dist/models/admin-mcp-servers-list-response.d.ts +8 -3
- package/dist/models/admin-sandbox-spawn-response-data.d.ts +18 -0
- package/dist/models/admin-sandbox-spawn-response-data.js +15 -0
- package/dist/models/admin-sandbox-spawn-response-data1.d.ts +24 -0
- package/dist/models/admin-sandbox-spawn-response-data1.js +15 -0
- package/dist/models/admin-sandbox-spawn-response.d.ts +3 -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/admin-users-restore-response.js +15 -0
- package/dist/models/admin-webhooks-delivery-replay-response-data.d.ts +48 -0
- package/dist/models/admin-webhooks-delivery-replay-response-data.js +15 -0
- package/dist/models/admin-webhooks-delivery-replay-response.d.ts +3 -3
- package/dist/models/admin-webhooks-test-response.d.ts +6 -0
- package/dist/models/ask-response.d.ts +15 -0
- package/dist/models/ask-response.js +11 -0
- package/dist/models/attest-response-identity.d.ts +1 -1
- package/dist/models/attest-response.d.ts +2 -2
- package/dist/models/audit-log-entry.d.ts +1 -1
- package/dist/models/authentication-settings-password-policy.d.ts +25 -1
- package/dist/models/authentication-settings-password-rotation-policy.d.ts +1 -13
- package/dist/models/authentication-settings.d.ts +13 -15
- package/dist/models/authentication-settings.js +12 -1
- 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-approval-status-response-approved-by.d.ts +2 -2
- 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 +12 -1
- package/dist/models/index.js +12 -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-permissions-response-permissions-item.d.ts +1 -1
- package/dist/models/list-users-response.d.ts +6 -0
- package/dist/models/oauth-client-secret-issued.d.ts +1 -1
- package/dist/models/oauth-client.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/push-enrollment-started.d.ts +1 -1
- package/dist/models/put-admin-agents-update-request.d.ts +8 -0
- 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/request-magic-link-request.d.ts +42 -0
- package/dist/models/request-magic-link-request.js +15 -0
- package/dist/models/request-magic-link-response.d.ts +31 -0
- package/dist/models/request-magic-link-response.js +24 -0
- package/dist/models/scim-settings-inbound-protected-attributes.d.ts +2 -9
- package/dist/models/scim-settings-inbound.d.ts +0 -8
- package/dist/models/scim-settings-outbound.d.ts +2 -10
- 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/AAuthApi.md +1 -1
- package/docs/AbacAttributeDefinition.md +2 -0
- package/docs/AbacPolicy.md +3 -1
- package/docs/AdminAbacApi.md +14 -9
- package/docs/AdminAgentsAgentsRotateKeyRequest.md +22 -0
- package/docs/AdminAgentsAgentsRotateKeyResponse.md +2 -0
- package/docs/AdminAgentsApi.md +27 -9
- package/docs/AdminAgentsCreateRequest.md +2 -0
- package/docs/AdminAnalyticsDashboardResponseDataAudit.md +1 -1
- package/docs/AdminAuditLogsApi.md +3 -0
- package/docs/AdminAuditLogsRetentionResponseData.md +9 -3
- package/docs/AdminEmailApi.md +3 -0
- package/docs/AdminGroupsApi.md +3 -0
- package/docs/AdminGroupsListResponse.md +2 -0
- package/docs/AdminIdentitiesLinkRequest.md +3 -1
- package/docs/AdminIdentitiesListResponseDataBindingsItem.md +2 -0
- package/docs/AdminMcpApi.md +2 -1
- package/docs/AdminMcpServersListResponse.md +3 -1
- package/docs/AdminMfaApi.md +4 -2
- package/docs/AdminOAuthClientsApi.md +5 -3
- package/docs/AdminOrganizationsApi.md +13 -5
- package/docs/AdminRolesApi.md +10 -0
- package/docs/AdminSandboxApi.md +3 -1
- package/docs/AdminSandboxSpawnResponse.md +1 -1
- package/docs/AdminSandboxSpawnResponseData.md +32 -0
- package/docs/AdminSandboxSpawnResponseData1.md +20 -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 +112 -10
- package/docs/AdminUsersRestoreResponse.md +22 -0
- package/docs/AdminWebhooksApi.md +7 -5
- package/docs/AdminWebhooksDeliveryReplayResponse.md +1 -1
- package/docs/AdminWebhooksDeliveryReplayResponseData.md +28 -0
- package/docs/AdminWebhooksTestResponse.md +2 -0
- package/docs/AgentsApi.md +8 -5
- package/docs/AskResponse.md +2 -0
- package/docs/AttestResponse.md +1 -1
- package/docs/AttestResponseIdentity.md +1 -1
- package/docs/AuditLogEntry.md +1 -1
- package/docs/AuthenticationSettings.md +2 -6
- package/docs/AuthenticationSettingsPasswordPolicy.md +9 -0
- package/docs/AuthenticationSettingsPasswordRotationPolicy.md +1 -4
- package/docs/AuthorizationApi.md +5 -5
- package/docs/AuthorizationServerMetadata.md +4 -2
- package/docs/CheckEmailFirstRequest.md +22 -0
- package/docs/CheckEmailFirstResponse.md +26 -0
- package/docs/CreateClientResponseData.md +3 -1
- package/docs/EmailSenderSettings.md +31 -0
- package/docs/EnrollAuthenticator201Response.md +1 -1
- package/docs/GetApprovalStatusResponseApprovedBy.md +1 -1
- 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/JitApi.md +3 -3
- package/docs/ListPermissionsResponsePermissionsItem.md +1 -1
- package/docs/ListUsersResponse.md +2 -0
- package/docs/McpApi.md +5 -6
- package/docs/OAuthApi.md +135 -14
- package/docs/OAuthClient.md +2 -0
- package/docs/OAuthClientSecretIssued.md +1 -1
- package/docs/OAuthScope.md +1 -3
- package/docs/OIDCApi.md +4 -4
- package/docs/OpenIdConfiguration.md +3 -3
- package/docs/PushEnrollmentStarted.md +1 -1
- package/docs/PutAdminAgentsUpdateRequest.md +2 -0
- 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/RequestMagicLinkRequest.md +26 -0
- package/docs/RequestMagicLinkResponse.md +20 -0
- package/docs/ScimSettingsInbound.md +0 -2
- package/docs/ScimSettingsInboundProtectedAttributes.md +3 -5
- package/docs/ScimSettingsOutbound.md +2 -4
- package/docs/SocialLoginProvider.md +1 -1
- package/docs/SsfApi.md +2 -0
- package/docs/TokenVaultApi.md +2 -2
- 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-agents-agents-rotate-key-request.ts +36 -0
- package/models/admin-agents-agents-rotate-key-response.ts +6 -0
- package/models/admin-agents-create-request.ts +6 -0
- package/models/admin-analytics-dashboard-response-data-audit.ts +1 -1
- package/models/admin-audit-logs-retention-response-data.ts +21 -3
- package/models/admin-groups-list-response.ts +6 -0
- package/models/admin-identities-link-request.ts +8 -1
- package/models/admin-identities-list-response-data-bindings-item.ts +7 -0
- package/models/admin-mcp-servers-list-response.ts +8 -5
- package/models/admin-sandbox-spawn-response-data.ts +29 -0
- package/models/admin-sandbox-spawn-response-data1.ts +30 -0
- package/models/admin-sandbox-spawn-response.ts +3 -3
- 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/admin-webhooks-delivery-replay-response-data.ts +54 -0
- package/models/admin-webhooks-delivery-replay-response.ts +3 -3
- package/models/admin-webhooks-test-response.ts +6 -0
- package/models/ask-response.ts +17 -0
- package/models/attest-response-identity.ts +1 -1
- package/models/attest-response.ts +2 -2
- package/models/audit-log-entry.ts +1 -1
- package/models/authentication-settings-password-policy.ts +25 -1
- package/models/authentication-settings-password-rotation-policy.ts +1 -13
- package/models/authentication-settings.ts +13 -15
- 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-approval-status-response-approved-by.ts +2 -2
- package/models/get-me-response.ts +18 -0
- package/models/get-server-challenge-response.ts +3 -2
- package/models/index.ts +12 -1
- package/models/introspect-response.ts +6 -0
- package/models/issue-agent-token-request.ts +6 -0
- package/models/list-permissions-response-permissions-item.ts +1 -1
- package/models/list-users-response.ts +6 -0
- package/models/oauth-client-secret-issued.ts +1 -1
- package/models/oauth-client.ts +6 -0
- package/models/oauth-scope.ts +1 -7
- package/models/open-id-configuration.ts +3 -3
- package/models/push-enrollment-started.ts +1 -1
- package/models/put-admin-agents-update-request.ts +6 -0
- 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/request-magic-link-request.ts +48 -0
- package/models/request-magic-link-response.ts +39 -0
- package/models/scim-settings-inbound-protected-attributes.ts +2 -10
- package/models/scim-settings-inbound.ts +0 -6
- package/models/scim-settings-outbound.ts +2 -8
- 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-agents-agents-rotate-key-request.js} +0 -0
- /package/dist/models/{admin-mcp-servers-list-response-meta.js → admin-agents-agents-rotate-key-request.js} +0 -0
package/docs/AdminAgentsApi.md
CHANGED
|
@@ -199,7 +199,8 @@ const { status, data } = await apiInstance.adminAgentsAgentsEnable(
|
|
|
199
199
|
```typescript
|
|
200
200
|
import {
|
|
201
201
|
AdminAgentsApi,
|
|
202
|
-
Configuration
|
|
202
|
+
Configuration,
|
|
203
|
+
AdminAgentsAgentsRotateKeyRequest
|
|
203
204
|
} from '@lumoauth/api-client';
|
|
204
205
|
|
|
205
206
|
const configuration = new Configuration();
|
|
@@ -207,10 +208,12 @@ const apiInstance = new AdminAgentsApi(configuration);
|
|
|
207
208
|
|
|
208
209
|
let orgId: string; // (default to undefined)
|
|
209
210
|
let agentId: string; // (default to undefined)
|
|
211
|
+
let adminAgentsAgentsRotateKeyRequest: AdminAgentsAgentsRotateKeyRequest; //Optional lifetime of the new API key. Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days). (optional)
|
|
210
212
|
|
|
211
213
|
const { status, data } = await apiInstance.adminAgentsAgentsRotateKey(
|
|
212
214
|
orgId,
|
|
213
|
-
agentId
|
|
215
|
+
agentId,
|
|
216
|
+
adminAgentsAgentsRotateKeyRequest
|
|
214
217
|
);
|
|
215
218
|
```
|
|
216
219
|
|
|
@@ -218,6 +221,7 @@ const { status, data } = await apiInstance.adminAgentsAgentsRotateKey(
|
|
|
218
221
|
|
|
219
222
|
|Name | Type | Description | Notes|
|
|
220
223
|
|------------- | ------------- | ------------- | -------------|
|
|
224
|
+
| **adminAgentsAgentsRotateKeyRequest** | **AdminAgentsAgentsRotateKeyRequest**| Optional lifetime of the new API key. Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days). | |
|
|
221
225
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
222
226
|
| **agentId** | [**string**] | | defaults to undefined|
|
|
223
227
|
|
|
@@ -232,7 +236,7 @@ const { status, data } = await apiInstance.adminAgentsAgentsRotateKey(
|
|
|
232
236
|
|
|
233
237
|
### HTTP request headers
|
|
234
238
|
|
|
235
|
-
- **Content-Type**:
|
|
239
|
+
- **Content-Type**: application/json
|
|
236
240
|
- **Accept**: application/json
|
|
237
241
|
|
|
238
242
|
|
|
@@ -240,6 +244,7 @@ const { status, data } = await apiInstance.adminAgentsAgentsRotateKey(
|
|
|
240
244
|
| Status code | Description | Response headers |
|
|
241
245
|
|-------------|-------------|------------------|
|
|
242
246
|
|**200** | API key rotated. The new key is returned ONCE and cannot be retrieved again. | - |
|
|
247
|
+
|**400** | The agent does not authenticate with an API key (identity type other than api_key), or the lifetime is invalid. | - |
|
|
243
248
|
|**401** | Authentication required. | - |
|
|
244
249
|
|**403** | Admin privileges required. | - |
|
|
245
250
|
|**404** | Tenant or agent not found. | - |
|
|
@@ -297,7 +302,7 @@ const { status, data } = await apiInstance.adminAgentsCreate(
|
|
|
297
302
|
| Status code | Description | Response headers |
|
|
298
303
|
|-------------|-------------|------------------|
|
|
299
304
|
|**201** | Agent created. The generated credential/secret is returned ONCE and cannot be retrieved again. | - |
|
|
300
|
-
|**400** | Missing required field: name. | - |
|
|
305
|
+
|**400** | Missing required field: name, or an invalid budgetPolicy (unknown key, or a value that is not a number greater than zero). | - |
|
|
301
306
|
|**401** | Authentication required. | - |
|
|
302
307
|
|**403** | Admin privileges required. | - |
|
|
303
308
|
|**404** | Tenant not found. | - |
|
|
@@ -470,10 +475,11 @@ const { status, data } = await apiInstance.adminAgentsGenerateToken(
|
|
|
470
475
|
| Status code | Description | Response headers |
|
|
471
476
|
|-------------|-------------|------------------|
|
|
472
477
|
|**200** | A generated agent token. The token value is returned ONCE. | - |
|
|
473
|
-
|**400** | Inactive agent, requested scopes outside the agent\'s capabilities, a resource that is not an active MCP server of this organization, or expiresIn above 3600 without a resource. | - |
|
|
478
|
+
|**400** | Inactive agent, an agent that only takes DPoP-bound tokens (a minted token cannot be bound to its key), requested scopes outside the agent\'s capabilities, a resource that is not an active MCP server of this organization, or expiresIn above 3600 without a resource. | - |
|
|
474
479
|
|**401** | Authentication required. | - |
|
|
475
480
|
|**403** | Admin privileges required. | - |
|
|
476
481
|
|**404** | Tenant or agent not found. | - |
|
|
482
|
+
|**429** | budget_exceeded: the agent budget is spent. A token mint counts as one call. Retry-After holds the seconds until the spent window starts again. | - |
|
|
477
483
|
|
|
478
484
|
[[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)
|
|
479
485
|
|
|
@@ -605,9 +611,13 @@ const configuration = new Configuration();
|
|
|
605
611
|
const apiInstance = new AdminAgentsApi(configuration);
|
|
606
612
|
|
|
607
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')
|
|
608
616
|
|
|
609
617
|
const { status, data } = await apiInstance.adminAgentsList(
|
|
610
|
-
orgId
|
|
618
|
+
orgId,
|
|
619
|
+
sortBy,
|
|
620
|
+
sortDir
|
|
611
621
|
);
|
|
612
622
|
```
|
|
613
623
|
|
|
@@ -616,6 +626,8 @@ const { status, data } = await apiInstance.adminAgentsList(
|
|
|
616
626
|
|Name | Type | Description | Notes|
|
|
617
627
|
|------------- | ------------- | ------------- | -------------|
|
|
618
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'|
|
|
619
631
|
|
|
620
632
|
|
|
621
633
|
### Return type
|
|
@@ -769,7 +781,8 @@ const { status, data } = await apiInstance.adminAgentsRevokeKey(
|
|
|
769
781
|
```typescript
|
|
770
782
|
import {
|
|
771
783
|
AdminAgentsApi,
|
|
772
|
-
Configuration
|
|
784
|
+
Configuration,
|
|
785
|
+
AdminAgentsAgentsRotateKeyRequest
|
|
773
786
|
} from '@lumoauth/api-client';
|
|
774
787
|
|
|
775
788
|
const configuration = new Configuration();
|
|
@@ -777,10 +790,12 @@ const apiInstance = new AdminAgentsApi(configuration);
|
|
|
777
790
|
|
|
778
791
|
let orgId: string; // (default to undefined)
|
|
779
792
|
let agentId: string; // (default to undefined)
|
|
793
|
+
let adminAgentsAgentsRotateKeyRequest: AdminAgentsAgentsRotateKeyRequest; //For an api_key agent, the optional lifetime of the new key (ignored for a client secret). Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days). (optional)
|
|
780
794
|
|
|
781
795
|
const { status, data } = await apiInstance.adminAgentsRotateCredentials(
|
|
782
796
|
orgId,
|
|
783
|
-
agentId
|
|
797
|
+
agentId,
|
|
798
|
+
adminAgentsAgentsRotateKeyRequest
|
|
784
799
|
);
|
|
785
800
|
```
|
|
786
801
|
|
|
@@ -788,6 +803,7 @@ const { status, data } = await apiInstance.adminAgentsRotateCredentials(
|
|
|
788
803
|
|
|
789
804
|
|Name | Type | Description | Notes|
|
|
790
805
|
|------------- | ------------- | ------------- | -------------|
|
|
806
|
+
| **adminAgentsAgentsRotateKeyRequest** | **AdminAgentsAgentsRotateKeyRequest**| For an api_key agent, the optional lifetime of the new key (ignored for a client secret). Without either field the current expiry date is kept, unless it has already passed (then the new key gets 180 days). | |
|
|
791
807
|
| **orgId** | [**string**] | | defaults to undefined|
|
|
792
808
|
| **agentId** | [**string**] | | defaults to undefined|
|
|
793
809
|
|
|
@@ -802,7 +818,7 @@ const { status, data } = await apiInstance.adminAgentsRotateCredentials(
|
|
|
802
818
|
|
|
803
819
|
### HTTP request headers
|
|
804
820
|
|
|
805
|
-
- **Content-Type**:
|
|
821
|
+
- **Content-Type**: application/json
|
|
806
822
|
- **Accept**: application/json
|
|
807
823
|
|
|
808
824
|
|
|
@@ -932,6 +948,7 @@ const { status, data } = await apiInstance.patchAdminAgentsUpdate(
|
|
|
932
948
|
| Status code | Description | Response headers |
|
|
933
949
|
|-------------|-------------|------------------|
|
|
934
950
|
|**200** | Agent updated. | - |
|
|
951
|
+
|**400** | Invalid budgetPolicy: an unknown key, or a value that is not a number greater than zero. | - |
|
|
935
952
|
|**401** | Authentication required. | - |
|
|
936
953
|
|**403** | Admin privileges required. | - |
|
|
937
954
|
|**404** | Tenant or agent not found. | - |
|
|
@@ -992,6 +1009,7 @@ const { status, data } = await apiInstance.putAdminAgentsUpdate(
|
|
|
992
1009
|
| Status code | Description | Response headers |
|
|
993
1010
|
|-------------|-------------|------------------|
|
|
994
1011
|
|**200** | Agent updated. | - |
|
|
1012
|
+
|**400** | Invalid budgetPolicy: an unknown key, or a value that is not a number greater than zero. | - |
|
|
995
1013
|
|**401** | Authentication required. | - |
|
|
996
1014
|
|**403** | Admin privileges required. | - |
|
|
997
1015
|
|**404** | Tenant or agent not found. | - |
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**name** | **string** | Required. Human-readable agent name. | [optional] [default to undefined]
|
|
9
9
|
**description** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**capabilities** | **Array<string>** | | [optional] [default to undefined]
|
|
11
|
+
**budgetPolicy** | **{ [key: string]: any; }** | The agent budget. Keys: max_api_calls_per_hour, max_api_calls_per_day, max_tokens_per_hour, max_tokens_per_day (whole numbers), max_cost_per_day_usd, max_cost_per_month_usd, hard_limit (USD), max_steps, timeout_seconds (whole numbers, read by the agent from UserInfo), and the gateway-only max_cost_usd, monthly_usd, max_budget (USD). Each value must be greater than zero; an unknown key or an invalid value is refused with 400. Leave it out for an agent without a budget. | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ const instance: AdminAgentsCreateRequest = {
|
|
|
18
19
|
name,
|
|
19
20
|
description,
|
|
20
21
|
capabilities,
|
|
22
|
+
budgetPolicy,
|
|
21
23
|
};
|
|
22
24
|
```
|
|
23
25
|
|
|
@@ -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
|
|
|
@@ -5,9 +5,12 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**retentionDays** | **number** |
|
|
9
|
-
**autoDelete** | **boolean** |
|
|
10
|
-
**planLimitDays** | **number** |
|
|
8
|
+
**retentionDays** | **number** | The organization\'s own period, between minRetentionDays and maxRetentionDays. It applies while data retention is on and autoDelete is not false. | [optional] [default to undefined]
|
|
9
|
+
**autoDelete** | **boolean** | false switches the organization\'s own period off; the plan\'s period still applies | [optional] [default to undefined]
|
|
10
|
+
**planLimitDays** | **number** | The plan\'s period: older entries are not returned and are deleted. null when the plan has no limit. | [optional] [default to undefined]
|
|
11
|
+
**effectiveRetentionDays** | **number** | How long entries are kept now; null when nothing is deleted | [optional] [default to undefined]
|
|
12
|
+
**minRetentionDays** | **number** | | [optional] [default to undefined]
|
|
13
|
+
**maxRetentionDays** | **number** | | [optional] [default to undefined]
|
|
11
14
|
|
|
12
15
|
## Example
|
|
13
16
|
|
|
@@ -18,6 +21,9 @@ const instance: AdminAuditLogsRetentionResponseData = {
|
|
|
18
21
|
retentionDays,
|
|
19
22
|
autoDelete,
|
|
20
23
|
planLimitDays,
|
|
24
|
+
effectiveRetentionDays,
|
|
25
|
+
minRetentionDays,
|
|
26
|
+
maxRetentionDays,
|
|
21
27
|
};
|
|
22
28
|
```
|
|
23
29
|
|
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,7 +6,8 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**type** | **string** | | [default to undefined]
|
|
9
|
-
**idp_id** | **number** | SAML IdP config id (type=saml) | [optional] [default to undefined]
|
|
9
|
+
**idp_id** | **number** | SAML IdP config id (type=saml) or OpenID Connect connection id (type=oidc) | [optional] [default to undefined]
|
|
10
|
+
**subject** | **string** | Subject the OpenID Connect provider issues for this user (type=oidc) | [optional] [default to undefined]
|
|
10
11
|
**name_id** | **string** | NameID the IdP asserts for this user (type=saml) | [optional] [default to undefined]
|
|
11
12
|
**ldap_config_id** | **number** | LDAP directory id (type=ldap) | [optional] [default to undefined]
|
|
12
13
|
**dn** | **string** | Distinguished name (type=ldap); omitted = look up | [optional] [default to undefined]
|
|
@@ -20,6 +21,7 @@ import { AdminIdentitiesLinkRequest } from '@lumoauth/api-client';
|
|
|
20
21
|
const instance: AdminIdentitiesLinkRequest = {
|
|
21
22
|
type,
|
|
22
23
|
idp_id,
|
|
24
|
+
subject,
|
|
23
25
|
name_id,
|
|
24
26
|
ldap_config_id,
|
|
25
27
|
dn,
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**type** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**idp_id** | **number** | | [optional] [default to undefined]
|
|
10
10
|
**name_id** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**subject** | **string** | | [optional] [default to undefined]
|
|
11
12
|
**legacy** | **boolean** | | [optional] [default to undefined]
|
|
12
13
|
**ldap_config_id** | **number** | | [optional] [default to undefined]
|
|
13
14
|
**dn** | **string** | | [optional] [default to undefined]
|
|
@@ -22,6 +23,7 @@ const instance: AdminIdentitiesListResponseDataBindingsItem = {
|
|
|
22
23
|
type,
|
|
23
24
|
idp_id,
|
|
24
25
|
name_id,
|
|
26
|
+
subject,
|
|
25
27
|
legacy,
|
|
26
28
|
ldap_config_id,
|
|
27
29
|
dn,
|
package/docs/AdminMcpApi.md
CHANGED
|
@@ -12,7 +12,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
12
12
|
# **adminMcpServersCreate**
|
|
13
13
|
> AdminMcpServersCreateResponse adminMcpServersCreate()
|
|
14
14
|
|
|
15
|
-
Body:
|
|
15
|
+
Body: name (required) — display name resource_uri (required) — RFC 8707 canonical URI: https:// (http:// only for loopback), no fragment, no user info, not a LumoAuth host, unique per organization after normalisation (same rules as the portal) endpoint_url (optional) — actual MCP endpoint description (optional) scopes_supported (optional) — array OR space/comma-separated string; omnibus scopes, offline_access and admin/scim scopes are refused (422) basic_scopes (optional) — subset of scopes_supported advertised in the 401 challenge and Protected Resource Metadata; no wildcards transport (optional) — defaults to \"http_streamable\" (\"http_sse\" is deprecated in MCP 2026-07-28) auth_mode (optional) — defaults to \"oauth\" token_lifetime (optional, default 3600) — 60..86400, else 422 tool_authorizer_client_ids (optional) — the MCP server\'s own OAuth clients that may call the per-tool authorization endpoint allowed_client_ids (optional) — array of this organization\'s OAuth client ids; unknown ids are a 422 (never persisted as policy) require_pkce (optional, default true) require_resource_param (optional, default true) require_dpop (optional, default false) — RFC 9449 sender-constrained tokens only scope_descriptions (optional) — object scope => text for scopes in scopes_supported (portal and consent page only), 200 characters each A server that is not OAuth-protected (auth_mode \"none\" or transport \"stdio\") is stored with the three require_* switches off. Fields that cannot be configured (include_scope_in_challenge, bearer_methods_supported) are refused with 400 so that a caller is never told a value was stored.
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
|
|
@@ -57,6 +57,7 @@ const { status, data } = await apiInstance.adminMcpServersCreate(
|
|
|
57
57
|
| Status code | Description | Response headers |
|
|
58
58
|
|-------------|-------------|------------------|
|
|
59
59
|
|**201** | MCP server created | - |
|
|
60
|
+
|**400** | Invalid resource_uri, or a field that cannot be set (include_scope_in_challenge, bearer_methods_supported) | - |
|
|
60
61
|
|**409** | An MCP server with this resource_uri already exists | - |
|
|
61
62
|
|**422** | validation_error | - |
|
|
62
63
|
|
|
@@ -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
|
|
|
@@ -18,7 +18,7 @@ All URIs are relative to *https://app.lumoauth.dev*
|
|
|
18
18
|
|[**putAdminClientsUpdateBranding**](#putadminclientsupdatebranding) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/branding | Replace an OAuth client\'s login and/or consent page branding|
|
|
19
19
|
|[**rotateClientSecret**](#rotateclientsecret) | **POST** /orgs/{orgId}/api/v1/admin/clients/{clientId}/rotate-secret | Rotate an OAuth client secret|
|
|
20
20
|
|[**setClientScopes**](#setclientscopes) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId}/scopes | Replace the scopes granted to an OAuth client|
|
|
21
|
-
|[**updateClient**](#updateclient) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId} |
|
|
21
|
+
|[**updateClient**](#updateclient) | **PUT** /orgs/{orgId}/api/v1/admin/clients/{clientId} | Update an OAuth client (same as PATCH: only the fields that are sent change)|
|
|
22
22
|
|
|
23
23
|
# **adminClientsCimdCheck**
|
|
24
24
|
> AdminClientsCimdCheckResponse adminClientsCimdCheck(adminClientsCimdCheckRequest)
|
|
@@ -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
|
|
|
@@ -177,7 +177,7 @@ const { status, data } = await apiInstance.createClient(
|
|
|
177
177
|
### HTTP response details
|
|
178
178
|
| Status code | Description | Response headers |
|
|
179
179
|
|-------------|-------------|------------------|
|
|
180
|
-
|**201** | Created
|
|
180
|
+
|**201** | Created. For a confidential client the plaintext secret is included once and never shown again; a public client (isConfidential false) has no secret and the field is absent | - |
|
|
181
181
|
|
|
182
182
|
[[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)
|
|
183
183
|
|
|
@@ -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
|
|
package/docs/AdminSandboxApi.md
CHANGED
|
@@ -115,6 +115,7 @@ const { status, data } = await apiInstance.adminSandboxList(
|
|
|
115
115
|
# **adminSandboxSpawn**
|
|
116
116
|
> AdminSandboxSpawnResponse adminSandboxSpawn()
|
|
117
117
|
|
|
118
|
+
Creates a sandbox organization with its own signing key, the Tenant Admin role, a Starter App client and one API key that holds every Admin API scope. The API key is returned only in this response and expires with the sandbox. Use it as `X-API-Key` on `/orgs/{sandbox slug}/api/v1/admin/...`. No user who can sign in is created: add users with the key. The sandbox uses the plan of the organization that created it and cannot create sandboxes itself.
|
|
118
119
|
|
|
119
120
|
### Example
|
|
120
121
|
|
|
@@ -162,7 +163,8 @@ const { status, data } = await apiInstance.adminSandboxSpawn(
|
|
|
162
163
|
### HTTP response details
|
|
163
164
|
| Status code | Description | Response headers |
|
|
164
165
|
|-------------|-------------|------------------|
|
|
165
|
-
|**201** | Sandbox created | - |
|
|
166
|
+
|**201** | Sandbox created. `data.api_key` is shown only once. | - |
|
|
167
|
+
|**403** | The organization lacks the Developer sandboxes add-on (`feature_not_in_plan`), or it is itself a sandbox | - |
|
|
166
168
|
|**429** | Per-owner active-sandbox cap reached | - |
|
|
167
169
|
|
|
168
170
|
[[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)
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**data** | [**
|
|
8
|
+
**data** | [**AdminSandboxSpawnResponseData**](AdminSandboxSpawnResponseData.md) | | [optional] [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# AdminSandboxSpawnResponseData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**slug** | **string** | | [default to undefined]
|
|
9
|
+
**name** | **string** | | [default to undefined]
|
|
10
|
+
**created_at** | **string** | | [default to undefined]
|
|
11
|
+
**expires_at** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**owner_email** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**spawned_from** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**api_key** | **string** | API key of the sandbox, with every Admin API scope. Shown only in this response; it expires with the sandbox. | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { AdminSandboxSpawnResponseData } from '@lumoauth/api-client';
|
|
20
|
+
|
|
21
|
+
const instance: AdminSandboxSpawnResponseData = {
|
|
22
|
+
slug,
|
|
23
|
+
name,
|
|
24
|
+
created_at,
|
|
25
|
+
expires_at,
|
|
26
|
+
owner_email,
|
|
27
|
+
spawned_from,
|
|
28
|
+
api_key,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AdminSandboxSpawnResponseData1
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**api_key** | **string** | API key of the sandbox, with every Admin API scope. Shown only in this response; it expires with the sandbox. | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { AdminSandboxSpawnResponseData1 } from '@lumoauth/api-client';
|
|
14
|
+
|
|
15
|
+
const instance: AdminSandboxSpawnResponseData1 = {
|
|
16
|
+
api_key,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|