@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
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.AdminIdentitiesUnlinkType = exports.AdminUsersApi = exports.AdminUsersApiFactory = exports.AdminUsersApiFp = exports.AdminUsersApiAxiosParamCreator = void 0;
|
|
25
|
+
exports.ListUsersSortDir = exports.ListUsersSortBy = exports.AdminIdentitiesUnlinkType = exports.AdminUsersApi = exports.AdminUsersApiFactory = exports.AdminUsersApiFp = exports.AdminUsersApiAxiosParamCreator = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -74,7 +74,7 @@ const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
74
74
|
};
|
|
75
75
|
}),
|
|
76
76
|
/**
|
|
77
|
-
*
|
|
77
|
+
* Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
|
|
78
78
|
* @summary Assign a permission to a user
|
|
79
79
|
* @param {string} orgId
|
|
80
80
|
* @param {string} userId
|
|
@@ -150,7 +150,7 @@ const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
150
150
|
};
|
|
151
151
|
}),
|
|
152
152
|
/**
|
|
153
|
-
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
|
|
153
|
+
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
|
|
154
154
|
* @summary Relink legacy SAML users to an IdP
|
|
155
155
|
* @param {string} orgId
|
|
156
156
|
* @param {AdminIdentitiesLegacySamlRelinkRequest} adminIdentitiesLegacySamlRelinkRequest
|
|
@@ -227,8 +227,8 @@ const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
227
227
|
};
|
|
228
228
|
}),
|
|
229
229
|
/**
|
|
230
|
-
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
231
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
230
|
+
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`), enterprise OpenID Connect binding (`idp_id` + `subject`: the value of the connection\'s user identifier claim; a person can sign in through such a connection only after this link exists) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
231
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
232
232
|
* @param {string} orgId
|
|
233
233
|
* @param {string} userId
|
|
234
234
|
* @param {AdminIdentitiesLinkRequest} adminIdentitiesLinkRequest
|
|
@@ -270,7 +270,7 @@ const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
270
270
|
};
|
|
271
271
|
}),
|
|
272
272
|
/**
|
|
273
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
273
|
+
* SAML (IdP + NameID), enterprise OpenID Connect (connection + subject), LDAP (directory + DN) and social provider links. A SAML link with `legacy: true` stores a bare NameID and is refused at sign-in while the organization has more than one SAML IdP. An OpenID Connect link with `hashed: true` stores a long subject as a hash, so `subject` is null.
|
|
274
274
|
* @summary List a user\'s federated identity links
|
|
275
275
|
* @param {string} orgId
|
|
276
276
|
* @param {string} userId
|
|
@@ -308,8 +308,8 @@ const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
308
308
|
};
|
|
309
309
|
}),
|
|
310
310
|
/**
|
|
311
|
-
* Removes the binding of the given type (`saml`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
312
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
311
|
+
* Removes the binding of the given type (`saml`, `oidc`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
312
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
313
313
|
* @param {AdminIdentitiesUnlinkType} type
|
|
314
314
|
* @param {string} orgId
|
|
315
315
|
* @param {string} userId
|
|
@@ -349,6 +349,44 @@ const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
349
349
|
options: localVarRequestOptions,
|
|
350
350
|
};
|
|
351
351
|
}),
|
|
352
|
+
/**
|
|
353
|
+
* Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
|
|
354
|
+
* @summary Restore a deleted user
|
|
355
|
+
* @param {string} orgId
|
|
356
|
+
* @param {string} userId
|
|
357
|
+
* @param {*} [options] Override http request option.
|
|
358
|
+
* @throws {RequiredError}
|
|
359
|
+
*/
|
|
360
|
+
adminUsersRestore: (orgId_1, userId_1, ...args_1) => __awaiter(this, [orgId_1, userId_1, ...args_1], void 0, function* (orgId, userId, options = {}) {
|
|
361
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
362
|
+
(0, common_1.assertParamExists)('adminUsersRestore', 'orgId', orgId);
|
|
363
|
+
// verify required parameter 'userId' is not null or undefined
|
|
364
|
+
(0, common_1.assertParamExists)('adminUsersRestore', 'userId', userId);
|
|
365
|
+
const localVarPath = `/orgs/{orgId}/api/v1/admin/users/{userId}/restore`
|
|
366
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)))
|
|
367
|
+
.replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
|
|
368
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
369
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
370
|
+
let baseOptions;
|
|
371
|
+
if (configuration) {
|
|
372
|
+
baseOptions = configuration.baseOptions;
|
|
373
|
+
}
|
|
374
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
375
|
+
const localVarHeaderParameter = {};
|
|
376
|
+
const localVarQueryParameter = {};
|
|
377
|
+
// authentication ApiKeyAuth required
|
|
378
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-API-Key", configuration);
|
|
379
|
+
// authentication BearerAuth required
|
|
380
|
+
// http bearer authentication required
|
|
381
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
382
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
383
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
384
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
385
|
+
return {
|
|
386
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
387
|
+
options: localVarRequestOptions,
|
|
388
|
+
};
|
|
389
|
+
}),
|
|
352
390
|
/**
|
|
353
391
|
*
|
|
354
392
|
* @summary Block a user
|
|
@@ -615,10 +653,22 @@ const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
615
653
|
*
|
|
616
654
|
* @summary List users
|
|
617
655
|
* @param {string} orgId
|
|
618
|
-
* @param {
|
|
619
|
-
* @
|
|
620
|
-
|
|
621
|
-
|
|
656
|
+
* @param {number} [page] Page number.
|
|
657
|
+
* @param {number} [limit] Users per page (1 to 100).
|
|
658
|
+
* @param {string} [search] Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used).
|
|
659
|
+
* @param {boolean} [active] Only active (`true`) or inactive (`false`) users.
|
|
660
|
+
* @param {boolean} [blocked] Only blocked (`true`) or not blocked (`false`) users.
|
|
661
|
+
* @param {boolean} [deleted] `true` lists only the users that SCIM deleted (soft-deleted). Without it, or with `false`, the list leaves them out.
|
|
662
|
+
* @param {boolean} [emailVerified] Only users whose email address is verified (`true`) or not (`false`).
|
|
663
|
+
* @param {boolean} [mfaEnabled] Only users with (`true`) or without (`false`) multi-factor authentication.
|
|
664
|
+
* @param {string} [role] Only users who hold the role with this slug.
|
|
665
|
+
* @param {string} [group] Only members of the group with this slug.
|
|
666
|
+
* @param {ListUsersSortBy} [sortBy] Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt.
|
|
667
|
+
* @param {ListUsersSortDir} [sortDir] Sort direction. Used only together with sortBy.
|
|
668
|
+
* @param {*} [options] Override http request option.
|
|
669
|
+
* @throws {RequiredError}
|
|
670
|
+
*/
|
|
671
|
+
listUsers: (orgId_1, page_1, limit_1, search_1, active_1, blocked_1, deleted_1, emailVerified_1, mfaEnabled_1, role_1, group_1, sortBy_1, sortDir_1, ...args_1) => __awaiter(this, [orgId_1, page_1, limit_1, search_1, active_1, blocked_1, deleted_1, emailVerified_1, mfaEnabled_1, role_1, group_1, sortBy_1, sortDir_1, ...args_1], void 0, function* (orgId, page, limit, search, active, blocked, deleted, emailVerified, mfaEnabled, role, group, sortBy, sortDir, options = {}) {
|
|
622
672
|
// verify required parameter 'orgId' is not null or undefined
|
|
623
673
|
(0, common_1.assertParamExists)('listUsers', 'orgId', orgId);
|
|
624
674
|
const localVarPath = `/orgs/{orgId}/api/v1/admin/users`
|
|
@@ -637,6 +687,42 @@ const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
637
687
|
// authentication BearerAuth required
|
|
638
688
|
// http bearer authentication required
|
|
639
689
|
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
690
|
+
if (page !== undefined) {
|
|
691
|
+
localVarQueryParameter['page'] = page;
|
|
692
|
+
}
|
|
693
|
+
if (limit !== undefined) {
|
|
694
|
+
localVarQueryParameter['limit'] = limit;
|
|
695
|
+
}
|
|
696
|
+
if (search !== undefined) {
|
|
697
|
+
localVarQueryParameter['search'] = search;
|
|
698
|
+
}
|
|
699
|
+
if (active !== undefined) {
|
|
700
|
+
localVarQueryParameter['active'] = active;
|
|
701
|
+
}
|
|
702
|
+
if (blocked !== undefined) {
|
|
703
|
+
localVarQueryParameter['blocked'] = blocked;
|
|
704
|
+
}
|
|
705
|
+
if (deleted !== undefined) {
|
|
706
|
+
localVarQueryParameter['deleted'] = deleted;
|
|
707
|
+
}
|
|
708
|
+
if (emailVerified !== undefined) {
|
|
709
|
+
localVarQueryParameter['emailVerified'] = emailVerified;
|
|
710
|
+
}
|
|
711
|
+
if (mfaEnabled !== undefined) {
|
|
712
|
+
localVarQueryParameter['mfaEnabled'] = mfaEnabled;
|
|
713
|
+
}
|
|
714
|
+
if (role !== undefined) {
|
|
715
|
+
localVarQueryParameter['role'] = role;
|
|
716
|
+
}
|
|
717
|
+
if (group !== undefined) {
|
|
718
|
+
localVarQueryParameter['group'] = group;
|
|
719
|
+
}
|
|
720
|
+
if (sortBy !== undefined) {
|
|
721
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
722
|
+
}
|
|
723
|
+
if (sortDir !== undefined) {
|
|
724
|
+
localVarQueryParameter['sortDir'] = sortDir;
|
|
725
|
+
}
|
|
640
726
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
641
727
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
642
728
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -925,7 +1011,7 @@ const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
925
1011
|
};
|
|
926
1012
|
}),
|
|
927
1013
|
/**
|
|
928
|
-
*
|
|
1014
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. 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.
|
|
929
1015
|
* @summary Set a user\'s password
|
|
930
1016
|
* @param {string} orgId
|
|
931
1017
|
* @param {string} userId
|
|
@@ -963,7 +1049,7 @@ const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
963
1049
|
};
|
|
964
1050
|
}),
|
|
965
1051
|
/**
|
|
966
|
-
*
|
|
1052
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. 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.
|
|
967
1053
|
* @summary Set a user\'s password
|
|
968
1054
|
* @param {string} orgId
|
|
969
1055
|
* @param {string} userId
|
|
@@ -1218,7 +1304,7 @@ const AdminUsersApiFp = function (configuration) {
|
|
|
1218
1304
|
});
|
|
1219
1305
|
},
|
|
1220
1306
|
/**
|
|
1221
|
-
*
|
|
1307
|
+
* Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
|
|
1222
1308
|
* @summary Assign a permission to a user
|
|
1223
1309
|
* @param {string} orgId
|
|
1224
1310
|
* @param {string} userId
|
|
@@ -1252,7 +1338,7 @@ const AdminUsersApiFp = function (configuration) {
|
|
|
1252
1338
|
});
|
|
1253
1339
|
},
|
|
1254
1340
|
/**
|
|
1255
|
-
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
|
|
1341
|
+
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
|
|
1256
1342
|
* @summary Relink legacy SAML users to an IdP
|
|
1257
1343
|
* @param {string} orgId
|
|
1258
1344
|
* @param {AdminIdentitiesLegacySamlRelinkRequest} adminIdentitiesLegacySamlRelinkRequest
|
|
@@ -1286,8 +1372,8 @@ const AdminUsersApiFp = function (configuration) {
|
|
|
1286
1372
|
});
|
|
1287
1373
|
},
|
|
1288
1374
|
/**
|
|
1289
|
-
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
1290
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
1375
|
+
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`), enterprise OpenID Connect binding (`idp_id` + `subject`: the value of the connection\'s user identifier claim; a person can sign in through such a connection only after this link exists) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
1376
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
1291
1377
|
* @param {string} orgId
|
|
1292
1378
|
* @param {string} userId
|
|
1293
1379
|
* @param {AdminIdentitiesLinkRequest} adminIdentitiesLinkRequest
|
|
@@ -1304,7 +1390,7 @@ const AdminUsersApiFp = function (configuration) {
|
|
|
1304
1390
|
});
|
|
1305
1391
|
},
|
|
1306
1392
|
/**
|
|
1307
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
1393
|
+
* SAML (IdP + NameID), enterprise OpenID Connect (connection + subject), LDAP (directory + DN) and social provider links. A SAML link with `legacy: true` stores a bare NameID and is refused at sign-in while the organization has more than one SAML IdP. An OpenID Connect link with `hashed: true` stores a long subject as a hash, so `subject` is null.
|
|
1308
1394
|
* @summary List a user\'s federated identity links
|
|
1309
1395
|
* @param {string} orgId
|
|
1310
1396
|
* @param {string} userId
|
|
@@ -1321,8 +1407,8 @@ const AdminUsersApiFp = function (configuration) {
|
|
|
1321
1407
|
});
|
|
1322
1408
|
},
|
|
1323
1409
|
/**
|
|
1324
|
-
* Removes the binding of the given type (`saml`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
1325
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
1410
|
+
* Removes the binding of the given type (`saml`, `oidc`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
1411
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
1326
1412
|
* @param {AdminIdentitiesUnlinkType} type
|
|
1327
1413
|
* @param {string} orgId
|
|
1328
1414
|
* @param {string} userId
|
|
@@ -1338,6 +1424,23 @@ const AdminUsersApiFp = function (configuration) {
|
|
|
1338
1424
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1339
1425
|
});
|
|
1340
1426
|
},
|
|
1427
|
+
/**
|
|
1428
|
+
* Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
|
|
1429
|
+
* @summary Restore a deleted user
|
|
1430
|
+
* @param {string} orgId
|
|
1431
|
+
* @param {string} userId
|
|
1432
|
+
* @param {*} [options] Override http request option.
|
|
1433
|
+
* @throws {RequiredError}
|
|
1434
|
+
*/
|
|
1435
|
+
adminUsersRestore(orgId, userId, options) {
|
|
1436
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1437
|
+
var _a, _b, _c;
|
|
1438
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminUsersRestore(orgId, userId, options);
|
|
1439
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1440
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AdminUsersApi.adminUsersRestore']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1441
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1442
|
+
});
|
|
1443
|
+
},
|
|
1341
1444
|
/**
|
|
1342
1445
|
*
|
|
1343
1446
|
* @summary Block a user
|
|
@@ -1460,13 +1563,25 @@ const AdminUsersApiFp = function (configuration) {
|
|
|
1460
1563
|
*
|
|
1461
1564
|
* @summary List users
|
|
1462
1565
|
* @param {string} orgId
|
|
1463
|
-
* @param {
|
|
1464
|
-
* @
|
|
1465
|
-
|
|
1466
|
-
|
|
1566
|
+
* @param {number} [page] Page number.
|
|
1567
|
+
* @param {number} [limit] Users per page (1 to 100).
|
|
1568
|
+
* @param {string} [search] Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used).
|
|
1569
|
+
* @param {boolean} [active] Only active (`true`) or inactive (`false`) users.
|
|
1570
|
+
* @param {boolean} [blocked] Only blocked (`true`) or not blocked (`false`) users.
|
|
1571
|
+
* @param {boolean} [deleted] `true` lists only the users that SCIM deleted (soft-deleted). Without it, or with `false`, the list leaves them out.
|
|
1572
|
+
* @param {boolean} [emailVerified] Only users whose email address is verified (`true`) or not (`false`).
|
|
1573
|
+
* @param {boolean} [mfaEnabled] Only users with (`true`) or without (`false`) multi-factor authentication.
|
|
1574
|
+
* @param {string} [role] Only users who hold the role with this slug.
|
|
1575
|
+
* @param {string} [group] Only members of the group with this slug.
|
|
1576
|
+
* @param {ListUsersSortBy} [sortBy] Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt.
|
|
1577
|
+
* @param {ListUsersSortDir} [sortDir] Sort direction. Used only together with sortBy.
|
|
1578
|
+
* @param {*} [options] Override http request option.
|
|
1579
|
+
* @throws {RequiredError}
|
|
1580
|
+
*/
|
|
1581
|
+
listUsers(orgId, page, limit, search, active, blocked, deleted, emailVerified, mfaEnabled, role, group, sortBy, sortDir, options) {
|
|
1467
1582
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1468
1583
|
var _a, _b, _c;
|
|
1469
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listUsers(orgId, options);
|
|
1584
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listUsers(orgId, page, limit, search, active, blocked, deleted, emailVerified, mfaEnabled, role, group, sortBy, sortDir, options);
|
|
1470
1585
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1471
1586
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AdminUsersApi.listUsers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1472
1587
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1596,7 +1711,7 @@ const AdminUsersApiFp = function (configuration) {
|
|
|
1596
1711
|
});
|
|
1597
1712
|
},
|
|
1598
1713
|
/**
|
|
1599
|
-
*
|
|
1714
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. 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.
|
|
1600
1715
|
* @summary Set a user\'s password
|
|
1601
1716
|
* @param {string} orgId
|
|
1602
1717
|
* @param {string} userId
|
|
@@ -1613,7 +1728,7 @@ const AdminUsersApiFp = function (configuration) {
|
|
|
1613
1728
|
});
|
|
1614
1729
|
},
|
|
1615
1730
|
/**
|
|
1616
|
-
*
|
|
1731
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. 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.
|
|
1617
1732
|
* @summary Set a user\'s password
|
|
1618
1733
|
* @param {string} orgId
|
|
1619
1734
|
* @param {string} userId
|
|
@@ -1735,7 +1850,7 @@ const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1735
1850
|
return localVarFp.addUserGroup(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1736
1851
|
},
|
|
1737
1852
|
/**
|
|
1738
|
-
*
|
|
1853
|
+
* Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
|
|
1739
1854
|
* @summary Assign a permission to a user
|
|
1740
1855
|
* @param {AdminUsersApiAddUserPermissionRequest} requestParameters Request parameters.
|
|
1741
1856
|
* @param {*} [options] Override http request option.
|
|
@@ -1755,7 +1870,7 @@ const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1755
1870
|
return localVarFp.addUserRole(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1756
1871
|
},
|
|
1757
1872
|
/**
|
|
1758
|
-
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
|
|
1873
|
+
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
|
|
1759
1874
|
* @summary Relink legacy SAML users to an IdP
|
|
1760
1875
|
* @param {AdminUsersApiAdminIdentitiesLegacySamlRelinkRequest} requestParameters Request parameters.
|
|
1761
1876
|
* @param {*} [options] Override http request option.
|
|
@@ -1775,8 +1890,8 @@ const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1775
1890
|
return localVarFp.adminIdentitiesLegacySamlReport(requestParameters.orgId, requestParameters.idpId, options).then((request) => request(axios, basePath));
|
|
1776
1891
|
},
|
|
1777
1892
|
/**
|
|
1778
|
-
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
1779
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
1893
|
+
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`), enterprise OpenID Connect binding (`idp_id` + `subject`: the value of the connection\'s user identifier claim; a person can sign in through such a connection only after this link exists) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
1894
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
1780
1895
|
* @param {AdminUsersApiAdminIdentitiesLinkRequest} requestParameters Request parameters.
|
|
1781
1896
|
* @param {*} [options] Override http request option.
|
|
1782
1897
|
* @throws {RequiredError}
|
|
@@ -1785,7 +1900,7 @@ const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1785
1900
|
return localVarFp.adminIdentitiesLink(requestParameters.orgId, requestParameters.userId, requestParameters.adminIdentitiesLinkRequest, options).then((request) => request(axios, basePath));
|
|
1786
1901
|
},
|
|
1787
1902
|
/**
|
|
1788
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
1903
|
+
* SAML (IdP + NameID), enterprise OpenID Connect (connection + subject), LDAP (directory + DN) and social provider links. A SAML link with `legacy: true` stores a bare NameID and is refused at sign-in while the organization has more than one SAML IdP. An OpenID Connect link with `hashed: true` stores a long subject as a hash, so `subject` is null.
|
|
1789
1904
|
* @summary List a user\'s federated identity links
|
|
1790
1905
|
* @param {AdminUsersApiAdminIdentitiesListRequest} requestParameters Request parameters.
|
|
1791
1906
|
* @param {*} [options] Override http request option.
|
|
@@ -1795,8 +1910,8 @@ const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1795
1910
|
return localVarFp.adminIdentitiesList(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1796
1911
|
},
|
|
1797
1912
|
/**
|
|
1798
|
-
* Removes the binding of the given type (`saml`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
1799
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
1913
|
+
* Removes the binding of the given type (`saml`, `oidc`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
1914
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
1800
1915
|
* @param {AdminUsersApiAdminIdentitiesUnlinkRequest} requestParameters Request parameters.
|
|
1801
1916
|
* @param {*} [options] Override http request option.
|
|
1802
1917
|
* @throws {RequiredError}
|
|
@@ -1804,6 +1919,16 @@ const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1804
1919
|
adminIdentitiesUnlink(requestParameters, options) {
|
|
1805
1920
|
return localVarFp.adminIdentitiesUnlink(requestParameters.type, requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1806
1921
|
},
|
|
1922
|
+
/**
|
|
1923
|
+
* Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
|
|
1924
|
+
* @summary Restore a deleted user
|
|
1925
|
+
* @param {AdminUsersApiAdminUsersRestoreRequest} requestParameters Request parameters.
|
|
1926
|
+
* @param {*} [options] Override http request option.
|
|
1927
|
+
* @throws {RequiredError}
|
|
1928
|
+
*/
|
|
1929
|
+
adminUsersRestore(requestParameters, options) {
|
|
1930
|
+
return localVarFp.adminUsersRestore(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1931
|
+
},
|
|
1807
1932
|
/**
|
|
1808
1933
|
*
|
|
1809
1934
|
* @summary Block a user
|
|
@@ -1882,7 +2007,7 @@ const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1882
2007
|
* @throws {RequiredError}
|
|
1883
2008
|
*/
|
|
1884
2009
|
listUsers(requestParameters, options) {
|
|
1885
|
-
return localVarFp.listUsers(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
2010
|
+
return localVarFp.listUsers(requestParameters.orgId, requestParameters.page, requestParameters.limit, requestParameters.search, requestParameters.active, requestParameters.blocked, requestParameters.deleted, requestParameters.emailVerified, requestParameters.mfaEnabled, requestParameters.role, requestParameters.group, requestParameters.sortBy, requestParameters.sortDir, options).then((request) => request(axios, basePath));
|
|
1886
2011
|
},
|
|
1887
2012
|
/**
|
|
1888
2013
|
*
|
|
@@ -1956,7 +2081,7 @@ const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1956
2081
|
return localVarFp.sendUserVerificationEmail(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1957
2082
|
},
|
|
1958
2083
|
/**
|
|
1959
|
-
*
|
|
2084
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. 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.
|
|
1960
2085
|
* @summary Set a user\'s password
|
|
1961
2086
|
* @param {AdminUsersApiSetUserPasswordRequest} requestParameters Request parameters.
|
|
1962
2087
|
* @param {*} [options] Override http request option.
|
|
@@ -1966,7 +2091,7 @@ const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1966
2091
|
return localVarFp.setUserPassword(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1967
2092
|
},
|
|
1968
2093
|
/**
|
|
1969
|
-
*
|
|
2094
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. 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.
|
|
1970
2095
|
* @summary Set a user\'s password
|
|
1971
2096
|
* @param {AdminUsersApiSetUserPasswordPostRequest} requestParameters Request parameters.
|
|
1972
2097
|
* @param {*} [options] Override http request option.
|
|
@@ -2047,7 +2172,7 @@ class AdminUsersApi extends base_1.BaseAPI {
|
|
|
2047
2172
|
return (0, exports.AdminUsersApiFp)(this.configuration).addUserGroup(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2048
2173
|
}
|
|
2049
2174
|
/**
|
|
2050
|
-
*
|
|
2175
|
+
* Grants one permission to the user directly. The caller must hold the permission (403 otherwise). A permission that opens the admin portal makes an active user an administrator, who takes an admin seat: 403 `plan_limit_reached` (`limit`: `admin_seats`) when the plan has none free. On a plan with a hard monthly-active-user cap, an administrator also has a place kept inside the limit, so a user who has not been active this month needs a free place (`limit`: `mau`). A user or permission outside this organization is 404.
|
|
2051
2176
|
* @summary Assign a permission to a user
|
|
2052
2177
|
* @param {AdminUsersApiAddUserPermissionRequest} requestParameters Request parameters.
|
|
2053
2178
|
* @param {*} [options] Override http request option.
|
|
@@ -2069,7 +2194,7 @@ class AdminUsersApi extends base_1.BaseAPI {
|
|
|
2069
2194
|
return (0, exports.AdminUsersApiFp)(this.configuration).addUserRole(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2070
2195
|
}
|
|
2071
2196
|
/**
|
|
2072
|
-
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA.
|
|
2197
|
+
* Rebinds legacy bare-NameID users to `idp_id`, keeping their NameID: either `user_ids`, or every legacy user whose email domain the IdP\'s allowed email domains claim (`all_matching_domains: true`). Users the caller does not outrank, or whose NameID is already linked at that IdP, are skipped. `dry_run` (default true) only reports what would change. A real run revokes each relinked user\'s sessions, notifies them and is audited (identity.link.created per user, identity.link.bulk_relinked once); signed-in admins need fresh MFA. An access token must come from a sign-in within the last 10 minutes (401 insufficient_user_authentication otherwise), except for a request that sends `\"dry_run\": true`.
|
|
2073
2198
|
* @summary Relink legacy SAML users to an IdP
|
|
2074
2199
|
* @param {AdminUsersApiAdminIdentitiesLegacySamlRelinkRequest} requestParameters Request parameters.
|
|
2075
2200
|
* @param {*} [options] Override http request option.
|
|
@@ -2091,8 +2216,8 @@ class AdminUsersApi extends base_1.BaseAPI {
|
|
|
2091
2216
|
return (0, exports.AdminUsersApiFp)(this.configuration).adminIdentitiesLegacySamlReport(requestParameters.orgId, requestParameters.idpId, options).then((request) => request(this.axios, this.basePath));
|
|
2092
2217
|
}
|
|
2093
2218
|
/**
|
|
2094
|
-
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
2095
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
2219
|
+
* Sets (or replaces) the user\'s SAML binding (`idp_id` + `name_id`), enterprise OpenID Connect binding (`idp_id` + `subject`: the value of the connection\'s user identifier claim; a person can sign in through such a connection only after this link exists) or LDAP binding (`ldap_config_id` + `dn`; omit `dn` to look the entry up in the directory by the user\'s email / username). Refused with 409 when another user already holds that identity, or when the user is linked to a different federated source (unlink it first). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.created. Signed-in admins must have passed MFA in the last 10 minutes (send X-MFA-Challenge with an approved step-up challenge when calling with a user token).
|
|
2220
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
2096
2221
|
* @param {AdminUsersApiAdminIdentitiesLinkRequest} requestParameters Request parameters.
|
|
2097
2222
|
* @param {*} [options] Override http request option.
|
|
2098
2223
|
* @throws {RequiredError}
|
|
@@ -2102,7 +2227,7 @@ class AdminUsersApi extends base_1.BaseAPI {
|
|
|
2102
2227
|
return (0, exports.AdminUsersApiFp)(this.configuration).adminIdentitiesLink(requestParameters.orgId, requestParameters.userId, requestParameters.adminIdentitiesLinkRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2103
2228
|
}
|
|
2104
2229
|
/**
|
|
2105
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
2230
|
+
* SAML (IdP + NameID), enterprise OpenID Connect (connection + subject), LDAP (directory + DN) and social provider links. A SAML link with `legacy: true` stores a bare NameID and is refused at sign-in while the organization has more than one SAML IdP. An OpenID Connect link with `hashed: true` stores a long subject as a hash, so `subject` is null.
|
|
2106
2231
|
* @summary List a user\'s federated identity links
|
|
2107
2232
|
* @param {AdminUsersApiAdminIdentitiesListRequest} requestParameters Request parameters.
|
|
2108
2233
|
* @param {*} [options] Override http request option.
|
|
@@ -2113,8 +2238,8 @@ class AdminUsersApi extends base_1.BaseAPI {
|
|
|
2113
2238
|
return (0, exports.AdminUsersApiFp)(this.configuration).adminIdentitiesList(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2114
2239
|
}
|
|
2115
2240
|
/**
|
|
2116
|
-
* Removes the binding of the given type (`saml`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
2117
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
2241
|
+
* Removes the binding of the given type (`saml`, `oidc`, `ldap` or `social`). Revokes the user\'s sessions and tokens, notifies the user and is audited as identity.link.removed. Unlinking LDAP also clears LDAP-only. Same step-up rule as linking.
|
|
2242
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
2118
2243
|
* @param {AdminUsersApiAdminIdentitiesUnlinkRequest} requestParameters Request parameters.
|
|
2119
2244
|
* @param {*} [options] Override http request option.
|
|
2120
2245
|
* @throws {RequiredError}
|
|
@@ -2123,6 +2248,17 @@ class AdminUsersApi extends base_1.BaseAPI {
|
|
|
2123
2248
|
adminIdentitiesUnlink(requestParameters, options) {
|
|
2124
2249
|
return (0, exports.AdminUsersApiFp)(this.configuration).adminIdentitiesUnlink(requestParameters.type, requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2125
2250
|
}
|
|
2251
|
+
/**
|
|
2252
|
+
* Restores a user that inbound SCIM soft-deleted (list them with GET /users?deleted=true). The account keeps the roles, groups and permissions that it still holds, and its active and blocked state. Its sessions and tokens stay revoked: the user signs in again. An erased user cannot be restored.
|
|
2253
|
+
* @summary Restore a deleted user
|
|
2254
|
+
* @param {AdminUsersApiAdminUsersRestoreRequest} requestParameters Request parameters.
|
|
2255
|
+
* @param {*} [options] Override http request option.
|
|
2256
|
+
* @throws {RequiredError}
|
|
2257
|
+
* @memberof AdminUsersApi
|
|
2258
|
+
*/
|
|
2259
|
+
adminUsersRestore(requestParameters, options) {
|
|
2260
|
+
return (0, exports.AdminUsersApiFp)(this.configuration).adminUsersRestore(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2261
|
+
}
|
|
2126
2262
|
/**
|
|
2127
2263
|
*
|
|
2128
2264
|
* @summary Block a user
|
|
@@ -2209,7 +2345,7 @@ class AdminUsersApi extends base_1.BaseAPI {
|
|
|
2209
2345
|
* @memberof AdminUsersApi
|
|
2210
2346
|
*/
|
|
2211
2347
|
listUsers(requestParameters, options) {
|
|
2212
|
-
return (0, exports.AdminUsersApiFp)(this.configuration).listUsers(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
2348
|
+
return (0, exports.AdminUsersApiFp)(this.configuration).listUsers(requestParameters.orgId, requestParameters.page, requestParameters.limit, requestParameters.search, requestParameters.active, requestParameters.blocked, requestParameters.deleted, requestParameters.emailVerified, requestParameters.mfaEnabled, requestParameters.role, requestParameters.group, requestParameters.sortBy, requestParameters.sortDir, options).then((request) => request(this.axios, this.basePath));
|
|
2213
2349
|
}
|
|
2214
2350
|
/**
|
|
2215
2351
|
*
|
|
@@ -2290,7 +2426,7 @@ class AdminUsersApi extends base_1.BaseAPI {
|
|
|
2290
2426
|
return (0, exports.AdminUsersApiFp)(this.configuration).sendUserVerificationEmail(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2291
2427
|
}
|
|
2292
2428
|
/**
|
|
2293
|
-
*
|
|
2429
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. 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.
|
|
2294
2430
|
* @summary Set a user\'s password
|
|
2295
2431
|
* @param {AdminUsersApiSetUserPasswordRequest} requestParameters Request parameters.
|
|
2296
2432
|
* @param {*} [options] Override http request option.
|
|
@@ -2301,7 +2437,7 @@ class AdminUsersApi extends base_1.BaseAPI {
|
|
|
2301
2437
|
return (0, exports.AdminUsersApiFp)(this.configuration).setUserPassword(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2302
2438
|
}
|
|
2303
2439
|
/**
|
|
2304
|
-
*
|
|
2440
|
+
* Needs `users.edit`, and the caller must hold every permission of the user. 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.
|
|
2305
2441
|
* @summary Set a user\'s password
|
|
2306
2442
|
* @param {AdminUsersApiSetUserPasswordPostRequest} requestParameters Request parameters.
|
|
2307
2443
|
* @param {*} [options] Override http request option.
|
|
@@ -2375,6 +2511,28 @@ exports.AdminUsersApi = AdminUsersApi;
|
|
|
2375
2511
|
var AdminIdentitiesUnlinkType;
|
|
2376
2512
|
(function (AdminIdentitiesUnlinkType) {
|
|
2377
2513
|
AdminIdentitiesUnlinkType["SAML"] = "saml";
|
|
2514
|
+
AdminIdentitiesUnlinkType["OIDC"] = "oidc";
|
|
2378
2515
|
AdminIdentitiesUnlinkType["LDAP"] = "ldap";
|
|
2379
2516
|
AdminIdentitiesUnlinkType["SOCIAL"] = "social";
|
|
2380
2517
|
})(AdminIdentitiesUnlinkType || (exports.AdminIdentitiesUnlinkType = AdminIdentitiesUnlinkType = {}));
|
|
2518
|
+
/**
|
|
2519
|
+
* @export
|
|
2520
|
+
* @enum {string}
|
|
2521
|
+
*/
|
|
2522
|
+
var ListUsersSortBy;
|
|
2523
|
+
(function (ListUsersSortBy) {
|
|
2524
|
+
ListUsersSortBy["EMAIL"] = "email";
|
|
2525
|
+
ListUsersSortBy["NAME"] = "name";
|
|
2526
|
+
ListUsersSortBy["USERNAME"] = "username";
|
|
2527
|
+
ListUsersSortBy["CREATED_AT"] = "createdAt";
|
|
2528
|
+
ListUsersSortBy["LAST_LOGIN_AT"] = "lastLoginAt";
|
|
2529
|
+
})(ListUsersSortBy || (exports.ListUsersSortBy = ListUsersSortBy = {}));
|
|
2530
|
+
/**
|
|
2531
|
+
* @export
|
|
2532
|
+
* @enum {string}
|
|
2533
|
+
*/
|
|
2534
|
+
var ListUsersSortDir;
|
|
2535
|
+
(function (ListUsersSortDir) {
|
|
2536
|
+
ListUsersSortDir["ASC"] = "ASC";
|
|
2537
|
+
ListUsersSortDir["DESC"] = "DESC";
|
|
2538
|
+
})(ListUsersSortDir || (exports.ListUsersSortDir = ListUsersSortDir = {}));
|