@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
|
@@ -71,7 +71,7 @@ export const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
71
71
|
};
|
|
72
72
|
}),
|
|
73
73
|
/**
|
|
74
|
-
*
|
|
74
|
+
* 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.
|
|
75
75
|
* @summary Assign a permission to a user
|
|
76
76
|
* @param {string} orgId
|
|
77
77
|
* @param {string} userId
|
|
@@ -147,7 +147,7 @@ export const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
147
147
|
};
|
|
148
148
|
}),
|
|
149
149
|
/**
|
|
150
|
-
* 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.
|
|
150
|
+
* 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`.
|
|
151
151
|
* @summary Relink legacy SAML users to an IdP
|
|
152
152
|
* @param {string} orgId
|
|
153
153
|
* @param {AdminIdentitiesLegacySamlRelinkRequest} adminIdentitiesLegacySamlRelinkRequest
|
|
@@ -224,8 +224,8 @@ export const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
224
224
|
};
|
|
225
225
|
}),
|
|
226
226
|
/**
|
|
227
|
-
* 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).
|
|
228
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
227
|
+
* 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).
|
|
228
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
229
229
|
* @param {string} orgId
|
|
230
230
|
* @param {string} userId
|
|
231
231
|
* @param {AdminIdentitiesLinkRequest} adminIdentitiesLinkRequest
|
|
@@ -267,7 +267,7 @@ export const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
267
267
|
};
|
|
268
268
|
}),
|
|
269
269
|
/**
|
|
270
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
270
|
+
* 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.
|
|
271
271
|
* @summary List a user\'s federated identity links
|
|
272
272
|
* @param {string} orgId
|
|
273
273
|
* @param {string} userId
|
|
@@ -305,8 +305,8 @@ export const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
305
305
|
};
|
|
306
306
|
}),
|
|
307
307
|
/**
|
|
308
|
-
* 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.
|
|
309
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
308
|
+
* 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.
|
|
309
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
310
310
|
* @param {AdminIdentitiesUnlinkType} type
|
|
311
311
|
* @param {string} orgId
|
|
312
312
|
* @param {string} userId
|
|
@@ -346,6 +346,44 @@ export const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
346
346
|
options: localVarRequestOptions,
|
|
347
347
|
};
|
|
348
348
|
}),
|
|
349
|
+
/**
|
|
350
|
+
* 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.
|
|
351
|
+
* @summary Restore a deleted user
|
|
352
|
+
* @param {string} orgId
|
|
353
|
+
* @param {string} userId
|
|
354
|
+
* @param {*} [options] Override http request option.
|
|
355
|
+
* @throws {RequiredError}
|
|
356
|
+
*/
|
|
357
|
+
adminUsersRestore: (orgId_1, userId_1, ...args_1) => __awaiter(this, [orgId_1, userId_1, ...args_1], void 0, function* (orgId, userId, options = {}) {
|
|
358
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
359
|
+
assertParamExists('adminUsersRestore', 'orgId', orgId);
|
|
360
|
+
// verify required parameter 'userId' is not null or undefined
|
|
361
|
+
assertParamExists('adminUsersRestore', 'userId', userId);
|
|
362
|
+
const localVarPath = `/orgs/{orgId}/api/v1/admin/users/{userId}/restore`
|
|
363
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)))
|
|
364
|
+
.replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
|
|
365
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
366
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
367
|
+
let baseOptions;
|
|
368
|
+
if (configuration) {
|
|
369
|
+
baseOptions = configuration.baseOptions;
|
|
370
|
+
}
|
|
371
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
372
|
+
const localVarHeaderParameter = {};
|
|
373
|
+
const localVarQueryParameter = {};
|
|
374
|
+
// authentication ApiKeyAuth required
|
|
375
|
+
yield setApiKeyToObject(localVarHeaderParameter, "X-API-Key", configuration);
|
|
376
|
+
// authentication BearerAuth required
|
|
377
|
+
// http bearer authentication required
|
|
378
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
379
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
380
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
381
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
382
|
+
return {
|
|
383
|
+
url: toPathString(localVarUrlObj),
|
|
384
|
+
options: localVarRequestOptions,
|
|
385
|
+
};
|
|
386
|
+
}),
|
|
349
387
|
/**
|
|
350
388
|
*
|
|
351
389
|
* @summary Block a user
|
|
@@ -612,10 +650,22 @@ export const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
612
650
|
*
|
|
613
651
|
* @summary List users
|
|
614
652
|
* @param {string} orgId
|
|
615
|
-
* @param {
|
|
616
|
-
* @
|
|
617
|
-
|
|
618
|
-
|
|
653
|
+
* @param {number} [page] Page number.
|
|
654
|
+
* @param {number} [limit] Users per page (1 to 100).
|
|
655
|
+
* @param {string} [search] Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used).
|
|
656
|
+
* @param {boolean} [active] Only active (`true`) or inactive (`false`) users.
|
|
657
|
+
* @param {boolean} [blocked] Only blocked (`true`) or not blocked (`false`) users.
|
|
658
|
+
* @param {boolean} [deleted] `true` lists only the users that SCIM deleted (soft-deleted). Without it, or with `false`, the list leaves them out.
|
|
659
|
+
* @param {boolean} [emailVerified] Only users whose email address is verified (`true`) or not (`false`).
|
|
660
|
+
* @param {boolean} [mfaEnabled] Only users with (`true`) or without (`false`) multi-factor authentication.
|
|
661
|
+
* @param {string} [role] Only users who hold the role with this slug.
|
|
662
|
+
* @param {string} [group] Only members of the group with this slug.
|
|
663
|
+
* @param {ListUsersSortBy} [sortBy] Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt.
|
|
664
|
+
* @param {ListUsersSortDir} [sortDir] Sort direction. Used only together with sortBy.
|
|
665
|
+
* @param {*} [options] Override http request option.
|
|
666
|
+
* @throws {RequiredError}
|
|
667
|
+
*/
|
|
668
|
+
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 = {}) {
|
|
619
669
|
// verify required parameter 'orgId' is not null or undefined
|
|
620
670
|
assertParamExists('listUsers', 'orgId', orgId);
|
|
621
671
|
const localVarPath = `/orgs/{orgId}/api/v1/admin/users`
|
|
@@ -634,6 +684,42 @@ export const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
634
684
|
// authentication BearerAuth required
|
|
635
685
|
// http bearer authentication required
|
|
636
686
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
687
|
+
if (page !== undefined) {
|
|
688
|
+
localVarQueryParameter['page'] = page;
|
|
689
|
+
}
|
|
690
|
+
if (limit !== undefined) {
|
|
691
|
+
localVarQueryParameter['limit'] = limit;
|
|
692
|
+
}
|
|
693
|
+
if (search !== undefined) {
|
|
694
|
+
localVarQueryParameter['search'] = search;
|
|
695
|
+
}
|
|
696
|
+
if (active !== undefined) {
|
|
697
|
+
localVarQueryParameter['active'] = active;
|
|
698
|
+
}
|
|
699
|
+
if (blocked !== undefined) {
|
|
700
|
+
localVarQueryParameter['blocked'] = blocked;
|
|
701
|
+
}
|
|
702
|
+
if (deleted !== undefined) {
|
|
703
|
+
localVarQueryParameter['deleted'] = deleted;
|
|
704
|
+
}
|
|
705
|
+
if (emailVerified !== undefined) {
|
|
706
|
+
localVarQueryParameter['emailVerified'] = emailVerified;
|
|
707
|
+
}
|
|
708
|
+
if (mfaEnabled !== undefined) {
|
|
709
|
+
localVarQueryParameter['mfaEnabled'] = mfaEnabled;
|
|
710
|
+
}
|
|
711
|
+
if (role !== undefined) {
|
|
712
|
+
localVarQueryParameter['role'] = role;
|
|
713
|
+
}
|
|
714
|
+
if (group !== undefined) {
|
|
715
|
+
localVarQueryParameter['group'] = group;
|
|
716
|
+
}
|
|
717
|
+
if (sortBy !== undefined) {
|
|
718
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
719
|
+
}
|
|
720
|
+
if (sortDir !== undefined) {
|
|
721
|
+
localVarQueryParameter['sortDir'] = sortDir;
|
|
722
|
+
}
|
|
637
723
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
638
724
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
639
725
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -922,7 +1008,7 @@ export const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
922
1008
|
};
|
|
923
1009
|
}),
|
|
924
1010
|
/**
|
|
925
|
-
*
|
|
1011
|
+
* 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.
|
|
926
1012
|
* @summary Set a user\'s password
|
|
927
1013
|
* @param {string} orgId
|
|
928
1014
|
* @param {string} userId
|
|
@@ -960,7 +1046,7 @@ export const AdminUsersApiAxiosParamCreator = function (configuration) {
|
|
|
960
1046
|
};
|
|
961
1047
|
}),
|
|
962
1048
|
/**
|
|
963
|
-
*
|
|
1049
|
+
* 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.
|
|
964
1050
|
* @summary Set a user\'s password
|
|
965
1051
|
* @param {string} orgId
|
|
966
1052
|
* @param {string} userId
|
|
@@ -1214,7 +1300,7 @@ export const AdminUsersApiFp = function (configuration) {
|
|
|
1214
1300
|
});
|
|
1215
1301
|
},
|
|
1216
1302
|
/**
|
|
1217
|
-
*
|
|
1303
|
+
* 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.
|
|
1218
1304
|
* @summary Assign a permission to a user
|
|
1219
1305
|
* @param {string} orgId
|
|
1220
1306
|
* @param {string} userId
|
|
@@ -1248,7 +1334,7 @@ export const AdminUsersApiFp = function (configuration) {
|
|
|
1248
1334
|
});
|
|
1249
1335
|
},
|
|
1250
1336
|
/**
|
|
1251
|
-
* 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.
|
|
1337
|
+
* 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`.
|
|
1252
1338
|
* @summary Relink legacy SAML users to an IdP
|
|
1253
1339
|
* @param {string} orgId
|
|
1254
1340
|
* @param {AdminIdentitiesLegacySamlRelinkRequest} adminIdentitiesLegacySamlRelinkRequest
|
|
@@ -1282,8 +1368,8 @@ export const AdminUsersApiFp = function (configuration) {
|
|
|
1282
1368
|
});
|
|
1283
1369
|
},
|
|
1284
1370
|
/**
|
|
1285
|
-
* 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).
|
|
1286
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
1371
|
+
* 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).
|
|
1372
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
1287
1373
|
* @param {string} orgId
|
|
1288
1374
|
* @param {string} userId
|
|
1289
1375
|
* @param {AdminIdentitiesLinkRequest} adminIdentitiesLinkRequest
|
|
@@ -1300,7 +1386,7 @@ export const AdminUsersApiFp = function (configuration) {
|
|
|
1300
1386
|
});
|
|
1301
1387
|
},
|
|
1302
1388
|
/**
|
|
1303
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
1389
|
+
* 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.
|
|
1304
1390
|
* @summary List a user\'s federated identity links
|
|
1305
1391
|
* @param {string} orgId
|
|
1306
1392
|
* @param {string} userId
|
|
@@ -1317,8 +1403,8 @@ export const AdminUsersApiFp = function (configuration) {
|
|
|
1317
1403
|
});
|
|
1318
1404
|
},
|
|
1319
1405
|
/**
|
|
1320
|
-
* 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.
|
|
1321
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
1406
|
+
* 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.
|
|
1407
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
1322
1408
|
* @param {AdminIdentitiesUnlinkType} type
|
|
1323
1409
|
* @param {string} orgId
|
|
1324
1410
|
* @param {string} userId
|
|
@@ -1334,6 +1420,23 @@ export const AdminUsersApiFp = function (configuration) {
|
|
|
1334
1420
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1335
1421
|
});
|
|
1336
1422
|
},
|
|
1423
|
+
/**
|
|
1424
|
+
* 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.
|
|
1425
|
+
* @summary Restore a deleted user
|
|
1426
|
+
* @param {string} orgId
|
|
1427
|
+
* @param {string} userId
|
|
1428
|
+
* @param {*} [options] Override http request option.
|
|
1429
|
+
* @throws {RequiredError}
|
|
1430
|
+
*/
|
|
1431
|
+
adminUsersRestore(orgId, userId, options) {
|
|
1432
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
1433
|
+
var _a, _b, _c;
|
|
1434
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.adminUsersRestore(orgId, userId, options);
|
|
1435
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1436
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminUsersApi.adminUsersRestore']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1437
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1438
|
+
});
|
|
1439
|
+
},
|
|
1337
1440
|
/**
|
|
1338
1441
|
*
|
|
1339
1442
|
* @summary Block a user
|
|
@@ -1456,13 +1559,25 @@ export const AdminUsersApiFp = function (configuration) {
|
|
|
1456
1559
|
*
|
|
1457
1560
|
* @summary List users
|
|
1458
1561
|
* @param {string} orgId
|
|
1459
|
-
* @param {
|
|
1460
|
-
* @
|
|
1461
|
-
|
|
1462
|
-
|
|
1562
|
+
* @param {number} [page] Page number.
|
|
1563
|
+
* @param {number} [limit] Users per page (1 to 100).
|
|
1564
|
+
* @param {string} [search] Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used).
|
|
1565
|
+
* @param {boolean} [active] Only active (`true`) or inactive (`false`) users.
|
|
1566
|
+
* @param {boolean} [blocked] Only blocked (`true`) or not blocked (`false`) users.
|
|
1567
|
+
* @param {boolean} [deleted] `true` lists only the users that SCIM deleted (soft-deleted). Without it, or with `false`, the list leaves them out.
|
|
1568
|
+
* @param {boolean} [emailVerified] Only users whose email address is verified (`true`) or not (`false`).
|
|
1569
|
+
* @param {boolean} [mfaEnabled] Only users with (`true`) or without (`false`) multi-factor authentication.
|
|
1570
|
+
* @param {string} [role] Only users who hold the role with this slug.
|
|
1571
|
+
* @param {string} [group] Only members of the group with this slug.
|
|
1572
|
+
* @param {ListUsersSortBy} [sortBy] Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt.
|
|
1573
|
+
* @param {ListUsersSortDir} [sortDir] Sort direction. Used only together with sortBy.
|
|
1574
|
+
* @param {*} [options] Override http request option.
|
|
1575
|
+
* @throws {RequiredError}
|
|
1576
|
+
*/
|
|
1577
|
+
listUsers(orgId, page, limit, search, active, blocked, deleted, emailVerified, mfaEnabled, role, group, sortBy, sortDir, options) {
|
|
1463
1578
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1464
1579
|
var _a, _b, _c;
|
|
1465
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listUsers(orgId, options);
|
|
1580
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listUsers(orgId, page, limit, search, active, blocked, deleted, emailVerified, mfaEnabled, role, group, sortBy, sortDir, options);
|
|
1466
1581
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1467
1582
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminUsersApi.listUsers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1468
1583
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1592,7 +1707,7 @@ export const AdminUsersApiFp = function (configuration) {
|
|
|
1592
1707
|
});
|
|
1593
1708
|
},
|
|
1594
1709
|
/**
|
|
1595
|
-
*
|
|
1710
|
+
* 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.
|
|
1596
1711
|
* @summary Set a user\'s password
|
|
1597
1712
|
* @param {string} orgId
|
|
1598
1713
|
* @param {string} userId
|
|
@@ -1609,7 +1724,7 @@ export const AdminUsersApiFp = function (configuration) {
|
|
|
1609
1724
|
});
|
|
1610
1725
|
},
|
|
1611
1726
|
/**
|
|
1612
|
-
*
|
|
1727
|
+
* 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.
|
|
1613
1728
|
* @summary Set a user\'s password
|
|
1614
1729
|
* @param {string} orgId
|
|
1615
1730
|
* @param {string} userId
|
|
@@ -1730,7 +1845,7 @@ export const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1730
1845
|
return localVarFp.addUserGroup(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1731
1846
|
},
|
|
1732
1847
|
/**
|
|
1733
|
-
*
|
|
1848
|
+
* 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.
|
|
1734
1849
|
* @summary Assign a permission to a user
|
|
1735
1850
|
* @param {AdminUsersApiAddUserPermissionRequest} requestParameters Request parameters.
|
|
1736
1851
|
* @param {*} [options] Override http request option.
|
|
@@ -1750,7 +1865,7 @@ export const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1750
1865
|
return localVarFp.addUserRole(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1751
1866
|
},
|
|
1752
1867
|
/**
|
|
1753
|
-
* 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.
|
|
1868
|
+
* 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`.
|
|
1754
1869
|
* @summary Relink legacy SAML users to an IdP
|
|
1755
1870
|
* @param {AdminUsersApiAdminIdentitiesLegacySamlRelinkRequest} requestParameters Request parameters.
|
|
1756
1871
|
* @param {*} [options] Override http request option.
|
|
@@ -1770,8 +1885,8 @@ export const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1770
1885
|
return localVarFp.adminIdentitiesLegacySamlReport(requestParameters.orgId, requestParameters.idpId, options).then((request) => request(axios, basePath));
|
|
1771
1886
|
},
|
|
1772
1887
|
/**
|
|
1773
|
-
* 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).
|
|
1774
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
1888
|
+
* 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).
|
|
1889
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
1775
1890
|
* @param {AdminUsersApiAdminIdentitiesLinkRequest} requestParameters Request parameters.
|
|
1776
1891
|
* @param {*} [options] Override http request option.
|
|
1777
1892
|
* @throws {RequiredError}
|
|
@@ -1780,7 +1895,7 @@ export const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1780
1895
|
return localVarFp.adminIdentitiesLink(requestParameters.orgId, requestParameters.userId, requestParameters.adminIdentitiesLinkRequest, options).then((request) => request(axios, basePath));
|
|
1781
1896
|
},
|
|
1782
1897
|
/**
|
|
1783
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
1898
|
+
* 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.
|
|
1784
1899
|
* @summary List a user\'s federated identity links
|
|
1785
1900
|
* @param {AdminUsersApiAdminIdentitiesListRequest} requestParameters Request parameters.
|
|
1786
1901
|
* @param {*} [options] Override http request option.
|
|
@@ -1790,8 +1905,8 @@ export const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1790
1905
|
return localVarFp.adminIdentitiesList(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1791
1906
|
},
|
|
1792
1907
|
/**
|
|
1793
|
-
* 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.
|
|
1794
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
1908
|
+
* 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.
|
|
1909
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
1795
1910
|
* @param {AdminUsersApiAdminIdentitiesUnlinkRequest} requestParameters Request parameters.
|
|
1796
1911
|
* @param {*} [options] Override http request option.
|
|
1797
1912
|
* @throws {RequiredError}
|
|
@@ -1799,6 +1914,16 @@ export const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1799
1914
|
adminIdentitiesUnlink(requestParameters, options) {
|
|
1800
1915
|
return localVarFp.adminIdentitiesUnlink(requestParameters.type, requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1801
1916
|
},
|
|
1917
|
+
/**
|
|
1918
|
+
* 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.
|
|
1919
|
+
* @summary Restore a deleted user
|
|
1920
|
+
* @param {AdminUsersApiAdminUsersRestoreRequest} requestParameters Request parameters.
|
|
1921
|
+
* @param {*} [options] Override http request option.
|
|
1922
|
+
* @throws {RequiredError}
|
|
1923
|
+
*/
|
|
1924
|
+
adminUsersRestore(requestParameters, options) {
|
|
1925
|
+
return localVarFp.adminUsersRestore(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1926
|
+
},
|
|
1802
1927
|
/**
|
|
1803
1928
|
*
|
|
1804
1929
|
* @summary Block a user
|
|
@@ -1877,7 +2002,7 @@ export const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1877
2002
|
* @throws {RequiredError}
|
|
1878
2003
|
*/
|
|
1879
2004
|
listUsers(requestParameters, options) {
|
|
1880
|
-
return localVarFp.listUsers(requestParameters.orgId, options).then((request) => request(axios, basePath));
|
|
2005
|
+
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));
|
|
1881
2006
|
},
|
|
1882
2007
|
/**
|
|
1883
2008
|
*
|
|
@@ -1951,7 +2076,7 @@ export const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1951
2076
|
return localVarFp.sendUserVerificationEmail(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1952
2077
|
},
|
|
1953
2078
|
/**
|
|
1954
|
-
*
|
|
2079
|
+
* 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.
|
|
1955
2080
|
* @summary Set a user\'s password
|
|
1956
2081
|
* @param {AdminUsersApiSetUserPasswordRequest} requestParameters Request parameters.
|
|
1957
2082
|
* @param {*} [options] Override http request option.
|
|
@@ -1961,7 +2086,7 @@ export const AdminUsersApiFactory = function (configuration, basePath, axios) {
|
|
|
1961
2086
|
return localVarFp.setUserPassword(requestParameters.orgId, requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
1962
2087
|
},
|
|
1963
2088
|
/**
|
|
1964
|
-
*
|
|
2089
|
+
* 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.
|
|
1965
2090
|
* @summary Set a user\'s password
|
|
1966
2091
|
* @param {AdminUsersApiSetUserPasswordPostRequest} requestParameters Request parameters.
|
|
1967
2092
|
* @param {*} [options] Override http request option.
|
|
@@ -2041,7 +2166,7 @@ export class AdminUsersApi extends BaseAPI {
|
|
|
2041
2166
|
return AdminUsersApiFp(this.configuration).addUserGroup(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2042
2167
|
}
|
|
2043
2168
|
/**
|
|
2044
|
-
*
|
|
2169
|
+
* 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.
|
|
2045
2170
|
* @summary Assign a permission to a user
|
|
2046
2171
|
* @param {AdminUsersApiAddUserPermissionRequest} requestParameters Request parameters.
|
|
2047
2172
|
* @param {*} [options] Override http request option.
|
|
@@ -2063,7 +2188,7 @@ export class AdminUsersApi extends BaseAPI {
|
|
|
2063
2188
|
return AdminUsersApiFp(this.configuration).addUserRole(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2064
2189
|
}
|
|
2065
2190
|
/**
|
|
2066
|
-
* 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.
|
|
2191
|
+
* 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`.
|
|
2067
2192
|
* @summary Relink legacy SAML users to an IdP
|
|
2068
2193
|
* @param {AdminUsersApiAdminIdentitiesLegacySamlRelinkRequest} requestParameters Request parameters.
|
|
2069
2194
|
* @param {*} [options] Override http request option.
|
|
@@ -2085,8 +2210,8 @@ export class AdminUsersApi extends BaseAPI {
|
|
|
2085
2210
|
return AdminUsersApiFp(this.configuration).adminIdentitiesLegacySamlReport(requestParameters.orgId, requestParameters.idpId, options).then((request) => request(this.axios, this.basePath));
|
|
2086
2211
|
}
|
|
2087
2212
|
/**
|
|
2088
|
-
* 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).
|
|
2089
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
2213
|
+
* 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).
|
|
2214
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
2090
2215
|
* @param {AdminUsersApiAdminIdentitiesLinkRequest} requestParameters Request parameters.
|
|
2091
2216
|
* @param {*} [options] Override http request option.
|
|
2092
2217
|
* @throws {RequiredError}
|
|
@@ -2096,7 +2221,7 @@ export class AdminUsersApi extends BaseAPI {
|
|
|
2096
2221
|
return AdminUsersApiFp(this.configuration).adminIdentitiesLink(requestParameters.orgId, requestParameters.userId, requestParameters.adminIdentitiesLinkRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2097
2222
|
}
|
|
2098
2223
|
/**
|
|
2099
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
2224
|
+
* 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.
|
|
2100
2225
|
* @summary List a user\'s federated identity links
|
|
2101
2226
|
* @param {AdminUsersApiAdminIdentitiesListRequest} requestParameters Request parameters.
|
|
2102
2227
|
* @param {*} [options] Override http request option.
|
|
@@ -2107,8 +2232,8 @@ export class AdminUsersApi extends BaseAPI {
|
|
|
2107
2232
|
return AdminUsersApiFp(this.configuration).adminIdentitiesList(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2108
2233
|
}
|
|
2109
2234
|
/**
|
|
2110
|
-
* 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.
|
|
2111
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
2235
|
+
* 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.
|
|
2236
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
2112
2237
|
* @param {AdminUsersApiAdminIdentitiesUnlinkRequest} requestParameters Request parameters.
|
|
2113
2238
|
* @param {*} [options] Override http request option.
|
|
2114
2239
|
* @throws {RequiredError}
|
|
@@ -2117,6 +2242,17 @@ export class AdminUsersApi extends BaseAPI {
|
|
|
2117
2242
|
adminIdentitiesUnlink(requestParameters, options) {
|
|
2118
2243
|
return AdminUsersApiFp(this.configuration).adminIdentitiesUnlink(requestParameters.type, requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2119
2244
|
}
|
|
2245
|
+
/**
|
|
2246
|
+
* 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.
|
|
2247
|
+
* @summary Restore a deleted user
|
|
2248
|
+
* @param {AdminUsersApiAdminUsersRestoreRequest} requestParameters Request parameters.
|
|
2249
|
+
* @param {*} [options] Override http request option.
|
|
2250
|
+
* @throws {RequiredError}
|
|
2251
|
+
* @memberof AdminUsersApi
|
|
2252
|
+
*/
|
|
2253
|
+
adminUsersRestore(requestParameters, options) {
|
|
2254
|
+
return AdminUsersApiFp(this.configuration).adminUsersRestore(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2255
|
+
}
|
|
2120
2256
|
/**
|
|
2121
2257
|
*
|
|
2122
2258
|
* @summary Block a user
|
|
@@ -2203,7 +2339,7 @@ export class AdminUsersApi extends BaseAPI {
|
|
|
2203
2339
|
* @memberof AdminUsersApi
|
|
2204
2340
|
*/
|
|
2205
2341
|
listUsers(requestParameters, options) {
|
|
2206
|
-
return AdminUsersApiFp(this.configuration).listUsers(requestParameters.orgId, options).then((request) => request(this.axios, this.basePath));
|
|
2342
|
+
return 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));
|
|
2207
2343
|
}
|
|
2208
2344
|
/**
|
|
2209
2345
|
*
|
|
@@ -2284,7 +2420,7 @@ export class AdminUsersApi extends BaseAPI {
|
|
|
2284
2420
|
return AdminUsersApiFp(this.configuration).sendUserVerificationEmail(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2285
2421
|
}
|
|
2286
2422
|
/**
|
|
2287
|
-
*
|
|
2423
|
+
* 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.
|
|
2288
2424
|
* @summary Set a user\'s password
|
|
2289
2425
|
* @param {AdminUsersApiSetUserPasswordRequest} requestParameters Request parameters.
|
|
2290
2426
|
* @param {*} [options] Override http request option.
|
|
@@ -2295,7 +2431,7 @@ export class AdminUsersApi extends BaseAPI {
|
|
|
2295
2431
|
return AdminUsersApiFp(this.configuration).setUserPassword(requestParameters.orgId, requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
2296
2432
|
}
|
|
2297
2433
|
/**
|
|
2298
|
-
*
|
|
2434
|
+
* 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.
|
|
2299
2435
|
* @summary Set a user\'s password
|
|
2300
2436
|
* @param {AdminUsersApiSetUserPasswordPostRequest} requestParameters Request parameters.
|
|
2301
2437
|
* @param {*} [options] Override http request option.
|
|
@@ -2368,6 +2504,28 @@ export class AdminUsersApi extends BaseAPI {
|
|
|
2368
2504
|
export var AdminIdentitiesUnlinkType;
|
|
2369
2505
|
(function (AdminIdentitiesUnlinkType) {
|
|
2370
2506
|
AdminIdentitiesUnlinkType["SAML"] = "saml";
|
|
2507
|
+
AdminIdentitiesUnlinkType["OIDC"] = "oidc";
|
|
2371
2508
|
AdminIdentitiesUnlinkType["LDAP"] = "ldap";
|
|
2372
2509
|
AdminIdentitiesUnlinkType["SOCIAL"] = "social";
|
|
2373
2510
|
})(AdminIdentitiesUnlinkType || (AdminIdentitiesUnlinkType = {}));
|
|
2511
|
+
/**
|
|
2512
|
+
* @export
|
|
2513
|
+
* @enum {string}
|
|
2514
|
+
*/
|
|
2515
|
+
export var ListUsersSortBy;
|
|
2516
|
+
(function (ListUsersSortBy) {
|
|
2517
|
+
ListUsersSortBy["EMAIL"] = "email";
|
|
2518
|
+
ListUsersSortBy["NAME"] = "name";
|
|
2519
|
+
ListUsersSortBy["USERNAME"] = "username";
|
|
2520
|
+
ListUsersSortBy["CREATED_AT"] = "createdAt";
|
|
2521
|
+
ListUsersSortBy["LAST_LOGIN_AT"] = "lastLoginAt";
|
|
2522
|
+
})(ListUsersSortBy || (ListUsersSortBy = {}));
|
|
2523
|
+
/**
|
|
2524
|
+
* @export
|
|
2525
|
+
* @enum {string}
|
|
2526
|
+
*/
|
|
2527
|
+
export var ListUsersSortDir;
|
|
2528
|
+
(function (ListUsersSortDir) {
|
|
2529
|
+
ListUsersSortDir["ASC"] = "ASC";
|
|
2530
|
+
ListUsersSortDir["DESC"] = "DESC";
|
|
2531
|
+
})(ListUsersSortDir || (ListUsersSortDir = {}));
|