@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
|
@@ -23,6 +23,7 @@ import type { AdminIdentitiesLegacySamlReportResponse } from '../models';
|
|
|
23
23
|
import type { AdminIdentitiesLinkRequest } from '../models';
|
|
24
24
|
import type { AdminIdentitiesListResponse } from '../models';
|
|
25
25
|
import type { AdminRolesGetPermissionsResponse } from '../models';
|
|
26
|
+
import type { AdminUsersRestoreResponse } from '../models';
|
|
26
27
|
import type { BlockUserResponse } from '../models';
|
|
27
28
|
import type { CreateUserResponse } from '../models';
|
|
28
29
|
import type { DeleteUserResponse } from '../models';
|
|
@@ -54,7 +55,7 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
54
55
|
*/
|
|
55
56
|
addUserGroup: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
57
|
/**
|
|
57
|
-
*
|
|
58
|
+
* 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.
|
|
58
59
|
* @summary Assign a permission to a user
|
|
59
60
|
* @param {string} orgId
|
|
60
61
|
* @param {string} userId
|
|
@@ -72,7 +73,7 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
72
73
|
*/
|
|
73
74
|
addUserRole: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
74
75
|
/**
|
|
75
|
-
* 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.
|
|
76
|
+
* 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`.
|
|
76
77
|
* @summary Relink legacy SAML users to an IdP
|
|
77
78
|
* @param {string} orgId
|
|
78
79
|
* @param {AdminIdentitiesLegacySamlRelinkRequest} adminIdentitiesLegacySamlRelinkRequest
|
|
@@ -90,8 +91,8 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
90
91
|
*/
|
|
91
92
|
adminIdentitiesLegacySamlReport: (orgId: string, idpId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
92
93
|
/**
|
|
93
|
-
* 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).
|
|
94
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
94
|
+
* 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).
|
|
95
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
95
96
|
* @param {string} orgId
|
|
96
97
|
* @param {string} userId
|
|
97
98
|
* @param {AdminIdentitiesLinkRequest} adminIdentitiesLinkRequest
|
|
@@ -100,7 +101,7 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
100
101
|
*/
|
|
101
102
|
adminIdentitiesLink: (orgId: string, userId: string, adminIdentitiesLinkRequest: AdminIdentitiesLinkRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
102
103
|
/**
|
|
103
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
104
|
+
* 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.
|
|
104
105
|
* @summary List a user\'s federated identity links
|
|
105
106
|
* @param {string} orgId
|
|
106
107
|
* @param {string} userId
|
|
@@ -109,8 +110,8 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
109
110
|
*/
|
|
110
111
|
adminIdentitiesList: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
111
112
|
/**
|
|
112
|
-
* 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.
|
|
113
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
113
|
+
* 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.
|
|
114
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
114
115
|
* @param {AdminIdentitiesUnlinkType} type
|
|
115
116
|
* @param {string} orgId
|
|
116
117
|
* @param {string} userId
|
|
@@ -118,6 +119,15 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
118
119
|
* @throws {RequiredError}
|
|
119
120
|
*/
|
|
120
121
|
adminIdentitiesUnlink: (type: AdminIdentitiesUnlinkType, orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
122
|
+
/**
|
|
123
|
+
* 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.
|
|
124
|
+
* @summary Restore a deleted user
|
|
125
|
+
* @param {string} orgId
|
|
126
|
+
* @param {string} userId
|
|
127
|
+
* @param {*} [options] Override http request option.
|
|
128
|
+
* @throws {RequiredError}
|
|
129
|
+
*/
|
|
130
|
+
adminUsersRestore: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
121
131
|
/**
|
|
122
132
|
*
|
|
123
133
|
* @summary Block a user
|
|
@@ -184,10 +194,22 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
184
194
|
*
|
|
185
195
|
* @summary List users
|
|
186
196
|
* @param {string} orgId
|
|
197
|
+
* @param {number} [page] Page number.
|
|
198
|
+
* @param {number} [limit] Users per page (1 to 100).
|
|
199
|
+
* @param {string} [search] Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used).
|
|
200
|
+
* @param {boolean} [active] Only active (`true`) or inactive (`false`) users.
|
|
201
|
+
* @param {boolean} [blocked] Only blocked (`true`) or not blocked (`false`) users.
|
|
202
|
+
* @param {boolean} [deleted] `true` lists only the users that SCIM deleted (soft-deleted). Without it, or with `false`, the list leaves them out.
|
|
203
|
+
* @param {boolean} [emailVerified] Only users whose email address is verified (`true`) or not (`false`).
|
|
204
|
+
* @param {boolean} [mfaEnabled] Only users with (`true`) or without (`false`) multi-factor authentication.
|
|
205
|
+
* @param {string} [role] Only users who hold the role with this slug.
|
|
206
|
+
* @param {string} [group] Only members of the group with this slug.
|
|
207
|
+
* @param {ListUsersSortBy} [sortBy] Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt.
|
|
208
|
+
* @param {ListUsersSortDir} [sortDir] Sort direction. Used only together with sortBy.
|
|
187
209
|
* @param {*} [options] Override http request option.
|
|
188
210
|
* @throws {RequiredError}
|
|
189
211
|
*/
|
|
190
|
-
listUsers: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
212
|
+
listUsers: (orgId: string, page?: number, limit?: number, search?: string, active?: boolean, blocked?: boolean, deleted?: boolean, emailVerified?: boolean, mfaEnabled?: boolean, role?: string, group?: string, sortBy?: ListUsersSortBy, sortDir?: ListUsersSortDir, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
191
213
|
/**
|
|
192
214
|
*
|
|
193
215
|
* @summary Mark a user\'s email as verified
|
|
@@ -256,7 +278,7 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
256
278
|
*/
|
|
257
279
|
sendUserVerificationEmail: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
258
280
|
/**
|
|
259
|
-
*
|
|
281
|
+
* 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.
|
|
260
282
|
* @summary Set a user\'s password
|
|
261
283
|
* @param {string} orgId
|
|
262
284
|
* @param {string} userId
|
|
@@ -265,7 +287,7 @@ export declare const AdminUsersApiAxiosParamCreator: (configuration?: Configurat
|
|
|
265
287
|
*/
|
|
266
288
|
setUserPassword: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
267
289
|
/**
|
|
268
|
-
*
|
|
290
|
+
* 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.
|
|
269
291
|
* @summary Set a user\'s password
|
|
270
292
|
* @param {string} orgId
|
|
271
293
|
* @param {string} userId
|
|
@@ -334,7 +356,7 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
|
|
|
334
356
|
*/
|
|
335
357
|
addUserGroup(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddUserGroupResponse>>;
|
|
336
358
|
/**
|
|
337
|
-
*
|
|
359
|
+
* 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.
|
|
338
360
|
* @summary Assign a permission to a user
|
|
339
361
|
* @param {string} orgId
|
|
340
362
|
* @param {string} userId
|
|
@@ -352,7 +374,7 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
|
|
|
352
374
|
*/
|
|
353
375
|
addUserRole(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddUserRoleResponse>>;
|
|
354
376
|
/**
|
|
355
|
-
* 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.
|
|
377
|
+
* 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`.
|
|
356
378
|
* @summary Relink legacy SAML users to an IdP
|
|
357
379
|
* @param {string} orgId
|
|
358
380
|
* @param {AdminIdentitiesLegacySamlRelinkRequest} adminIdentitiesLegacySamlRelinkRequest
|
|
@@ -370,8 +392,8 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
|
|
|
370
392
|
*/
|
|
371
393
|
adminIdentitiesLegacySamlReport(orgId: string, idpId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminIdentitiesLegacySamlReportResponse>>;
|
|
372
394
|
/**
|
|
373
|
-
* 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).
|
|
374
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
395
|
+
* 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).
|
|
396
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
375
397
|
* @param {string} orgId
|
|
376
398
|
* @param {string} userId
|
|
377
399
|
* @param {AdminIdentitiesLinkRequest} adminIdentitiesLinkRequest
|
|
@@ -380,7 +402,7 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
|
|
|
380
402
|
*/
|
|
381
403
|
adminIdentitiesLink(orgId: string, userId: string, adminIdentitiesLinkRequest: AdminIdentitiesLinkRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAgentsGetResponse>>;
|
|
382
404
|
/**
|
|
383
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
405
|
+
* 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.
|
|
384
406
|
* @summary List a user\'s federated identity links
|
|
385
407
|
* @param {string} orgId
|
|
386
408
|
* @param {string} userId
|
|
@@ -389,8 +411,8 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
|
|
|
389
411
|
*/
|
|
390
412
|
adminIdentitiesList(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminIdentitiesListResponse>>;
|
|
391
413
|
/**
|
|
392
|
-
* 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.
|
|
393
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
414
|
+
* 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.
|
|
415
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
394
416
|
* @param {AdminIdentitiesUnlinkType} type
|
|
395
417
|
* @param {string} orgId
|
|
396
418
|
* @param {string} userId
|
|
@@ -398,6 +420,15 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
|
|
|
398
420
|
* @throws {RequiredError}
|
|
399
421
|
*/
|
|
400
422
|
adminIdentitiesUnlink(type: AdminIdentitiesUnlinkType, orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminAgentsGetResponse>>;
|
|
423
|
+
/**
|
|
424
|
+
* 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.
|
|
425
|
+
* @summary Restore a deleted user
|
|
426
|
+
* @param {string} orgId
|
|
427
|
+
* @param {string} userId
|
|
428
|
+
* @param {*} [options] Override http request option.
|
|
429
|
+
* @throws {RequiredError}
|
|
430
|
+
*/
|
|
431
|
+
adminUsersRestore(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminUsersRestoreResponse>>;
|
|
401
432
|
/**
|
|
402
433
|
*
|
|
403
434
|
* @summary Block a user
|
|
@@ -464,10 +495,22 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
|
|
|
464
495
|
*
|
|
465
496
|
* @summary List users
|
|
466
497
|
* @param {string} orgId
|
|
498
|
+
* @param {number} [page] Page number.
|
|
499
|
+
* @param {number} [limit] Users per page (1 to 100).
|
|
500
|
+
* @param {string} [search] Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used).
|
|
501
|
+
* @param {boolean} [active] Only active (`true`) or inactive (`false`) users.
|
|
502
|
+
* @param {boolean} [blocked] Only blocked (`true`) or not blocked (`false`) users.
|
|
503
|
+
* @param {boolean} [deleted] `true` lists only the users that SCIM deleted (soft-deleted). Without it, or with `false`, the list leaves them out.
|
|
504
|
+
* @param {boolean} [emailVerified] Only users whose email address is verified (`true`) or not (`false`).
|
|
505
|
+
* @param {boolean} [mfaEnabled] Only users with (`true`) or without (`false`) multi-factor authentication.
|
|
506
|
+
* @param {string} [role] Only users who hold the role with this slug.
|
|
507
|
+
* @param {string} [group] Only members of the group with this slug.
|
|
508
|
+
* @param {ListUsersSortBy} [sortBy] Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt.
|
|
509
|
+
* @param {ListUsersSortDir} [sortDir] Sort direction. Used only together with sortBy.
|
|
467
510
|
* @param {*} [options] Override http request option.
|
|
468
511
|
* @throws {RequiredError}
|
|
469
512
|
*/
|
|
470
|
-
listUsers(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponse>>;
|
|
513
|
+
listUsers(orgId: string, page?: number, limit?: number, search?: string, active?: boolean, blocked?: boolean, deleted?: boolean, emailVerified?: boolean, mfaEnabled?: boolean, role?: string, group?: string, sortBy?: ListUsersSortBy, sortDir?: ListUsersSortDir, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListUsersResponse>>;
|
|
471
514
|
/**
|
|
472
515
|
*
|
|
473
516
|
* @summary Mark a user\'s email as verified
|
|
@@ -536,7 +579,7 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
|
|
|
536
579
|
*/
|
|
537
580
|
sendUserVerificationEmail(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SendUserVerificationEmailResponse>>;
|
|
538
581
|
/**
|
|
539
|
-
*
|
|
582
|
+
* 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.
|
|
540
583
|
* @summary Set a user\'s password
|
|
541
584
|
* @param {string} orgId
|
|
542
585
|
* @param {string} userId
|
|
@@ -545,7 +588,7 @@ export declare const AdminUsersApiFp: (configuration?: Configuration) => {
|
|
|
545
588
|
*/
|
|
546
589
|
setUserPassword(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SetUserPasswordPostResponse>>;
|
|
547
590
|
/**
|
|
548
|
-
*
|
|
591
|
+
* 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.
|
|
549
592
|
* @summary Set a user\'s password
|
|
550
593
|
* @param {string} orgId
|
|
551
594
|
* @param {string} userId
|
|
@@ -613,7 +656,7 @@ export declare const AdminUsersApiFactory: (configuration?: Configuration, baseP
|
|
|
613
656
|
*/
|
|
614
657
|
addUserGroup(requestParameters: AdminUsersApiAddUserGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddUserGroupResponse>;
|
|
615
658
|
/**
|
|
616
|
-
*
|
|
659
|
+
* 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.
|
|
617
660
|
* @summary Assign a permission to a user
|
|
618
661
|
* @param {AdminUsersApiAddUserPermissionRequest} requestParameters Request parameters.
|
|
619
662
|
* @param {*} [options] Override http request option.
|
|
@@ -629,7 +672,7 @@ export declare const AdminUsersApiFactory: (configuration?: Configuration, baseP
|
|
|
629
672
|
*/
|
|
630
673
|
addUserRole(requestParameters: AdminUsersApiAddUserRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddUserRoleResponse>;
|
|
631
674
|
/**
|
|
632
|
-
* 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.
|
|
675
|
+
* 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`.
|
|
633
676
|
* @summary Relink legacy SAML users to an IdP
|
|
634
677
|
* @param {AdminUsersApiAdminIdentitiesLegacySamlRelinkRequest} requestParameters Request parameters.
|
|
635
678
|
* @param {*} [options] Override http request option.
|
|
@@ -645,15 +688,15 @@ export declare const AdminUsersApiFactory: (configuration?: Configuration, baseP
|
|
|
645
688
|
*/
|
|
646
689
|
adminIdentitiesLegacySamlReport(requestParameters: AdminUsersApiAdminIdentitiesLegacySamlReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminIdentitiesLegacySamlReportResponse>;
|
|
647
690
|
/**
|
|
648
|
-
* 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).
|
|
649
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
691
|
+
* 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).
|
|
692
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
650
693
|
* @param {AdminUsersApiAdminIdentitiesLinkRequest} requestParameters Request parameters.
|
|
651
694
|
* @param {*} [options] Override http request option.
|
|
652
695
|
* @throws {RequiredError}
|
|
653
696
|
*/
|
|
654
697
|
adminIdentitiesLink(requestParameters: AdminUsersApiAdminIdentitiesLinkRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAgentsGetResponse>;
|
|
655
698
|
/**
|
|
656
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
699
|
+
* 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.
|
|
657
700
|
* @summary List a user\'s federated identity links
|
|
658
701
|
* @param {AdminUsersApiAdminIdentitiesListRequest} requestParameters Request parameters.
|
|
659
702
|
* @param {*} [options] Override http request option.
|
|
@@ -661,13 +704,21 @@ export declare const AdminUsersApiFactory: (configuration?: Configuration, baseP
|
|
|
661
704
|
*/
|
|
662
705
|
adminIdentitiesList(requestParameters: AdminUsersApiAdminIdentitiesListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminIdentitiesListResponse>;
|
|
663
706
|
/**
|
|
664
|
-
* 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.
|
|
665
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
707
|
+
* 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.
|
|
708
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
666
709
|
* @param {AdminUsersApiAdminIdentitiesUnlinkRequest} requestParameters Request parameters.
|
|
667
710
|
* @param {*} [options] Override http request option.
|
|
668
711
|
* @throws {RequiredError}
|
|
669
712
|
*/
|
|
670
713
|
adminIdentitiesUnlink(requestParameters: AdminUsersApiAdminIdentitiesUnlinkRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAgentsGetResponse>;
|
|
714
|
+
/**
|
|
715
|
+
* 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.
|
|
716
|
+
* @summary Restore a deleted user
|
|
717
|
+
* @param {AdminUsersApiAdminUsersRestoreRequest} requestParameters Request parameters.
|
|
718
|
+
* @param {*} [options] Override http request option.
|
|
719
|
+
* @throws {RequiredError}
|
|
720
|
+
*/
|
|
721
|
+
adminUsersRestore(requestParameters: AdminUsersApiAdminUsersRestoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminUsersRestoreResponse>;
|
|
671
722
|
/**
|
|
672
723
|
*
|
|
673
724
|
* @summary Block a user
|
|
@@ -790,7 +841,7 @@ export declare const AdminUsersApiFactory: (configuration?: Configuration, baseP
|
|
|
790
841
|
*/
|
|
791
842
|
sendUserVerificationEmail(requestParameters: AdminUsersApiSendUserVerificationEmailRequest, options?: RawAxiosRequestConfig): AxiosPromise<SendUserVerificationEmailResponse>;
|
|
792
843
|
/**
|
|
793
|
-
*
|
|
844
|
+
* 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.
|
|
794
845
|
* @summary Set a user\'s password
|
|
795
846
|
* @param {AdminUsersApiSetUserPasswordRequest} requestParameters Request parameters.
|
|
796
847
|
* @param {*} [options] Override http request option.
|
|
@@ -798,7 +849,7 @@ export declare const AdminUsersApiFactory: (configuration?: Configuration, baseP
|
|
|
798
849
|
*/
|
|
799
850
|
setUserPassword(requestParameters: AdminUsersApiSetUserPasswordRequest, options?: RawAxiosRequestConfig): AxiosPromise<SetUserPasswordPostResponse>;
|
|
800
851
|
/**
|
|
801
|
-
*
|
|
852
|
+
* 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.
|
|
802
853
|
* @summary Set a user\'s password
|
|
803
854
|
* @param {AdminUsersApiSetUserPasswordPostRequest} requestParameters Request parameters.
|
|
804
855
|
* @param {*} [options] Override http request option.
|
|
@@ -862,7 +913,7 @@ export interface AdminUsersApiInterface {
|
|
|
862
913
|
*/
|
|
863
914
|
addUserGroup(requestParameters: AdminUsersApiAddUserGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddUserGroupResponse>;
|
|
864
915
|
/**
|
|
865
|
-
*
|
|
916
|
+
* 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.
|
|
866
917
|
* @summary Assign a permission to a user
|
|
867
918
|
* @param {AdminUsersApiAddUserPermissionRequest} requestParameters Request parameters.
|
|
868
919
|
* @param {*} [options] Override http request option.
|
|
@@ -880,7 +931,7 @@ export interface AdminUsersApiInterface {
|
|
|
880
931
|
*/
|
|
881
932
|
addUserRole(requestParameters: AdminUsersApiAddUserRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<AddUserRoleResponse>;
|
|
882
933
|
/**
|
|
883
|
-
* 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.
|
|
934
|
+
* 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`.
|
|
884
935
|
* @summary Relink legacy SAML users to an IdP
|
|
885
936
|
* @param {AdminUsersApiAdminIdentitiesLegacySamlRelinkRequest} requestParameters Request parameters.
|
|
886
937
|
* @param {*} [options] Override http request option.
|
|
@@ -898,8 +949,8 @@ export interface AdminUsersApiInterface {
|
|
|
898
949
|
*/
|
|
899
950
|
adminIdentitiesLegacySamlReport(requestParameters: AdminUsersApiAdminIdentitiesLegacySamlReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminIdentitiesLegacySamlReportResponse>;
|
|
900
951
|
/**
|
|
901
|
-
* 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).
|
|
902
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
952
|
+
* 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).
|
|
953
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
903
954
|
* @param {AdminUsersApiAdminIdentitiesLinkRequest} requestParameters Request parameters.
|
|
904
955
|
* @param {*} [options] Override http request option.
|
|
905
956
|
* @throws {RequiredError}
|
|
@@ -907,7 +958,7 @@ export interface AdminUsersApiInterface {
|
|
|
907
958
|
*/
|
|
908
959
|
adminIdentitiesLink(requestParameters: AdminUsersApiAdminIdentitiesLinkRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAgentsGetResponse>;
|
|
909
960
|
/**
|
|
910
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
961
|
+
* 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.
|
|
911
962
|
* @summary List a user\'s federated identity links
|
|
912
963
|
* @param {AdminUsersApiAdminIdentitiesListRequest} requestParameters Request parameters.
|
|
913
964
|
* @param {*} [options] Override http request option.
|
|
@@ -916,14 +967,23 @@ export interface AdminUsersApiInterface {
|
|
|
916
967
|
*/
|
|
917
968
|
adminIdentitiesList(requestParameters: AdminUsersApiAdminIdentitiesListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminIdentitiesListResponse>;
|
|
918
969
|
/**
|
|
919
|
-
* 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.
|
|
920
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
970
|
+
* 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.
|
|
971
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
921
972
|
* @param {AdminUsersApiAdminIdentitiesUnlinkRequest} requestParameters Request parameters.
|
|
922
973
|
* @param {*} [options] Override http request option.
|
|
923
974
|
* @throws {RequiredError}
|
|
924
975
|
* @memberof AdminUsersApiInterface
|
|
925
976
|
*/
|
|
926
977
|
adminIdentitiesUnlink(requestParameters: AdminUsersApiAdminIdentitiesUnlinkRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminAgentsGetResponse>;
|
|
978
|
+
/**
|
|
979
|
+
* 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.
|
|
980
|
+
* @summary Restore a deleted user
|
|
981
|
+
* @param {AdminUsersApiAdminUsersRestoreRequest} requestParameters Request parameters.
|
|
982
|
+
* @param {*} [options] Override http request option.
|
|
983
|
+
* @throws {RequiredError}
|
|
984
|
+
* @memberof AdminUsersApiInterface
|
|
985
|
+
*/
|
|
986
|
+
adminUsersRestore(requestParameters: AdminUsersApiAdminUsersRestoreRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminUsersRestoreResponse>;
|
|
927
987
|
/**
|
|
928
988
|
*
|
|
929
989
|
* @summary Block a user
|
|
@@ -1061,7 +1121,7 @@ export interface AdminUsersApiInterface {
|
|
|
1061
1121
|
*/
|
|
1062
1122
|
sendUserVerificationEmail(requestParameters: AdminUsersApiSendUserVerificationEmailRequest, options?: RawAxiosRequestConfig): AxiosPromise<SendUserVerificationEmailResponse>;
|
|
1063
1123
|
/**
|
|
1064
|
-
*
|
|
1124
|
+
* 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.
|
|
1065
1125
|
* @summary Set a user\'s password
|
|
1066
1126
|
* @param {AdminUsersApiSetUserPasswordRequest} requestParameters Request parameters.
|
|
1067
1127
|
* @param {*} [options] Override http request option.
|
|
@@ -1070,7 +1130,7 @@ export interface AdminUsersApiInterface {
|
|
|
1070
1130
|
*/
|
|
1071
1131
|
setUserPassword(requestParameters: AdminUsersApiSetUserPasswordRequest, options?: RawAxiosRequestConfig): AxiosPromise<SetUserPasswordPostResponse>;
|
|
1072
1132
|
/**
|
|
1073
|
-
*
|
|
1133
|
+
* 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.
|
|
1074
1134
|
* @summary Set a user\'s password
|
|
1075
1135
|
* @param {AdminUsersApiSetUserPasswordPostRequest} requestParameters Request parameters.
|
|
1076
1136
|
* @param {*} [options] Override http request option.
|
|
@@ -1271,7 +1331,7 @@ export interface AdminUsersApiAdminIdentitiesListRequest {
|
|
|
1271
1331
|
export interface AdminUsersApiAdminIdentitiesUnlinkRequest {
|
|
1272
1332
|
/**
|
|
1273
1333
|
*
|
|
1274
|
-
* @type {'saml' | 'ldap' | 'social'}
|
|
1334
|
+
* @type {'saml' | 'oidc' | 'ldap' | 'social'}
|
|
1275
1335
|
* @memberof AdminUsersApiAdminIdentitiesUnlink
|
|
1276
1336
|
*/
|
|
1277
1337
|
readonly type: AdminIdentitiesUnlinkType;
|
|
@@ -1288,6 +1348,25 @@ export interface AdminUsersApiAdminIdentitiesUnlinkRequest {
|
|
|
1288
1348
|
*/
|
|
1289
1349
|
readonly userId: string;
|
|
1290
1350
|
}
|
|
1351
|
+
/**
|
|
1352
|
+
* Request parameters for adminUsersRestore operation in AdminUsersApi.
|
|
1353
|
+
* @export
|
|
1354
|
+
* @interface AdminUsersApiAdminUsersRestoreRequest
|
|
1355
|
+
*/
|
|
1356
|
+
export interface AdminUsersApiAdminUsersRestoreRequest {
|
|
1357
|
+
/**
|
|
1358
|
+
*
|
|
1359
|
+
* @type {string}
|
|
1360
|
+
* @memberof AdminUsersApiAdminUsersRestore
|
|
1361
|
+
*/
|
|
1362
|
+
readonly orgId: string;
|
|
1363
|
+
/**
|
|
1364
|
+
*
|
|
1365
|
+
* @type {string}
|
|
1366
|
+
* @memberof AdminUsersApiAdminUsersRestore
|
|
1367
|
+
*/
|
|
1368
|
+
readonly userId: string;
|
|
1369
|
+
}
|
|
1291
1370
|
/**
|
|
1292
1371
|
* Request parameters for blockUser operation in AdminUsersApi.
|
|
1293
1372
|
* @export
|
|
@@ -1427,6 +1506,78 @@ export interface AdminUsersApiListUsersRequest {
|
|
|
1427
1506
|
* @memberof AdminUsersApiListUsers
|
|
1428
1507
|
*/
|
|
1429
1508
|
readonly orgId: string;
|
|
1509
|
+
/**
|
|
1510
|
+
* Page number.
|
|
1511
|
+
* @type {number}
|
|
1512
|
+
* @memberof AdminUsersApiListUsers
|
|
1513
|
+
*/
|
|
1514
|
+
readonly page?: number;
|
|
1515
|
+
/**
|
|
1516
|
+
* Users per page (1 to 100).
|
|
1517
|
+
* @type {number}
|
|
1518
|
+
* @memberof AdminUsersApiListUsers
|
|
1519
|
+
*/
|
|
1520
|
+
readonly limit?: number;
|
|
1521
|
+
/**
|
|
1522
|
+
* Users whose email address, name or username contains this text (case-sensitive; the first 100 characters are used).
|
|
1523
|
+
* @type {string}
|
|
1524
|
+
* @memberof AdminUsersApiListUsers
|
|
1525
|
+
*/
|
|
1526
|
+
readonly search?: string;
|
|
1527
|
+
/**
|
|
1528
|
+
* Only active (`true`) or inactive (`false`) users.
|
|
1529
|
+
* @type {boolean}
|
|
1530
|
+
* @memberof AdminUsersApiListUsers
|
|
1531
|
+
*/
|
|
1532
|
+
readonly active?: boolean;
|
|
1533
|
+
/**
|
|
1534
|
+
* Only blocked (`true`) or not blocked (`false`) users.
|
|
1535
|
+
* @type {boolean}
|
|
1536
|
+
* @memberof AdminUsersApiListUsers
|
|
1537
|
+
*/
|
|
1538
|
+
readonly blocked?: boolean;
|
|
1539
|
+
/**
|
|
1540
|
+
* `true` lists only the users that SCIM deleted (soft-deleted). Without it, or with `false`, the list leaves them out.
|
|
1541
|
+
* @type {boolean}
|
|
1542
|
+
* @memberof AdminUsersApiListUsers
|
|
1543
|
+
*/
|
|
1544
|
+
readonly deleted?: boolean;
|
|
1545
|
+
/**
|
|
1546
|
+
* Only users whose email address is verified (`true`) or not (`false`).
|
|
1547
|
+
* @type {boolean}
|
|
1548
|
+
* @memberof AdminUsersApiListUsers
|
|
1549
|
+
*/
|
|
1550
|
+
readonly emailVerified?: boolean;
|
|
1551
|
+
/**
|
|
1552
|
+
* Only users with (`true`) or without (`false`) multi-factor authentication.
|
|
1553
|
+
* @type {boolean}
|
|
1554
|
+
* @memberof AdminUsersApiListUsers
|
|
1555
|
+
*/
|
|
1556
|
+
readonly mfaEnabled?: boolean;
|
|
1557
|
+
/**
|
|
1558
|
+
* Only users who hold the role with this slug.
|
|
1559
|
+
* @type {string}
|
|
1560
|
+
* @memberof AdminUsersApiListUsers
|
|
1561
|
+
*/
|
|
1562
|
+
readonly role?: string;
|
|
1563
|
+
/**
|
|
1564
|
+
* Only members of the group with this slug.
|
|
1565
|
+
* @type {string}
|
|
1566
|
+
* @memberof AdminUsersApiListUsers
|
|
1567
|
+
*/
|
|
1568
|
+
readonly group?: string;
|
|
1569
|
+
/**
|
|
1570
|
+
* Sort field. Without it the list is sorted by createdAt, newest first. Another value sorts by createdAt.
|
|
1571
|
+
* @type {'email' | 'name' | 'username' | 'createdAt' | 'lastLoginAt'}
|
|
1572
|
+
* @memberof AdminUsersApiListUsers
|
|
1573
|
+
*/
|
|
1574
|
+
readonly sortBy?: ListUsersSortBy;
|
|
1575
|
+
/**
|
|
1576
|
+
* Sort direction. Used only together with sortBy.
|
|
1577
|
+
* @type {'ASC' | 'DESC'}
|
|
1578
|
+
* @memberof AdminUsersApiListUsers
|
|
1579
|
+
*/
|
|
1580
|
+
readonly sortDir?: ListUsersSortDir;
|
|
1430
1581
|
}
|
|
1431
1582
|
/**
|
|
1432
1583
|
* Request parameters for markUserVerified operation in AdminUsersApi.
|
|
@@ -1729,7 +1880,7 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
|
|
|
1729
1880
|
*/
|
|
1730
1881
|
addUserGroup(requestParameters: AdminUsersApiAddUserGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddUserGroupResponse, any, {}>>;
|
|
1731
1882
|
/**
|
|
1732
|
-
*
|
|
1883
|
+
* 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.
|
|
1733
1884
|
* @summary Assign a permission to a user
|
|
1734
1885
|
* @param {AdminUsersApiAddUserPermissionRequest} requestParameters Request parameters.
|
|
1735
1886
|
* @param {*} [options] Override http request option.
|
|
@@ -1747,7 +1898,7 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
|
|
|
1747
1898
|
*/
|
|
1748
1899
|
addUserRole(requestParameters: AdminUsersApiAddUserRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AddUserRoleResponse, any, {}>>;
|
|
1749
1900
|
/**
|
|
1750
|
-
* 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.
|
|
1901
|
+
* 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`.
|
|
1751
1902
|
* @summary Relink legacy SAML users to an IdP
|
|
1752
1903
|
* @param {AdminUsersApiAdminIdentitiesLegacySamlRelinkRequest} requestParameters Request parameters.
|
|
1753
1904
|
* @param {*} [options] Override http request option.
|
|
@@ -1765,8 +1916,8 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
|
|
|
1765
1916
|
*/
|
|
1766
1917
|
adminIdentitiesLegacySamlReport(requestParameters: AdminUsersApiAdminIdentitiesLegacySamlReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminIdentitiesLegacySamlReportResponse, any, {}>>;
|
|
1767
1918
|
/**
|
|
1768
|
-
* 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).
|
|
1769
|
-
* @summary Link a SAML or LDAP identity to a user
|
|
1919
|
+
* 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).
|
|
1920
|
+
* @summary Link a SAML, OpenID Connect or LDAP identity to a user
|
|
1770
1921
|
* @param {AdminUsersApiAdminIdentitiesLinkRequest} requestParameters Request parameters.
|
|
1771
1922
|
* @param {*} [options] Override http request option.
|
|
1772
1923
|
* @throws {RequiredError}
|
|
@@ -1774,7 +1925,7 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
|
|
|
1774
1925
|
*/
|
|
1775
1926
|
adminIdentitiesLink(requestParameters: AdminUsersApiAdminIdentitiesLinkRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAgentsGetResponse, any, {}>>;
|
|
1776
1927
|
/**
|
|
1777
|
-
* SAML (IdP + NameID), LDAP (directory + DN)
|
|
1928
|
+
* 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.
|
|
1778
1929
|
* @summary List a user\'s federated identity links
|
|
1779
1930
|
* @param {AdminUsersApiAdminIdentitiesListRequest} requestParameters Request parameters.
|
|
1780
1931
|
* @param {*} [options] Override http request option.
|
|
@@ -1783,14 +1934,23 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
|
|
|
1783
1934
|
*/
|
|
1784
1935
|
adminIdentitiesList(requestParameters: AdminUsersApiAdminIdentitiesListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminIdentitiesListResponse, any, {}>>;
|
|
1785
1936
|
/**
|
|
1786
|
-
* 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.
|
|
1787
|
-
* @summary Unlink a user\'s SAML, LDAP or social identity
|
|
1937
|
+
* 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.
|
|
1938
|
+
* @summary Unlink a user\'s SAML, OpenID Connect, LDAP or social identity
|
|
1788
1939
|
* @param {AdminUsersApiAdminIdentitiesUnlinkRequest} requestParameters Request parameters.
|
|
1789
1940
|
* @param {*} [options] Override http request option.
|
|
1790
1941
|
* @throws {RequiredError}
|
|
1791
1942
|
* @memberof AdminUsersApi
|
|
1792
1943
|
*/
|
|
1793
1944
|
adminIdentitiesUnlink(requestParameters: AdminUsersApiAdminIdentitiesUnlinkRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminAgentsGetResponse, any, {}>>;
|
|
1945
|
+
/**
|
|
1946
|
+
* 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.
|
|
1947
|
+
* @summary Restore a deleted user
|
|
1948
|
+
* @param {AdminUsersApiAdminUsersRestoreRequest} requestParameters Request parameters.
|
|
1949
|
+
* @param {*} [options] Override http request option.
|
|
1950
|
+
* @throws {RequiredError}
|
|
1951
|
+
* @memberof AdminUsersApi
|
|
1952
|
+
*/
|
|
1953
|
+
adminUsersRestore(requestParameters: AdminUsersApiAdminUsersRestoreRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminUsersRestoreResponse, any, {}>>;
|
|
1794
1954
|
/**
|
|
1795
1955
|
*
|
|
1796
1956
|
* @summary Block a user
|
|
@@ -1928,7 +2088,7 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
|
|
|
1928
2088
|
*/
|
|
1929
2089
|
sendUserVerificationEmail(requestParameters: AdminUsersApiSendUserVerificationEmailRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SendUserVerificationEmailResponse, any, {}>>;
|
|
1930
2090
|
/**
|
|
1931
|
-
*
|
|
2091
|
+
* 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.
|
|
1932
2092
|
* @summary Set a user\'s password
|
|
1933
2093
|
* @param {AdminUsersApiSetUserPasswordRequest} requestParameters Request parameters.
|
|
1934
2094
|
* @param {*} [options] Override http request option.
|
|
@@ -1937,7 +2097,7 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
|
|
|
1937
2097
|
*/
|
|
1938
2098
|
setUserPassword(requestParameters: AdminUsersApiSetUserPasswordRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SetUserPasswordPostResponse, any, {}>>;
|
|
1939
2099
|
/**
|
|
1940
|
-
*
|
|
2100
|
+
* 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.
|
|
1941
2101
|
* @summary Set a user\'s password
|
|
1942
2102
|
* @param {AdminUsersApiSetUserPasswordPostRequest} requestParameters Request parameters.
|
|
1943
2103
|
* @param {*} [options] Override http request option.
|
|
@@ -1997,6 +2157,26 @@ export declare class AdminUsersApi extends BaseAPI implements AdminUsersApiInter
|
|
|
1997
2157
|
*/
|
|
1998
2158
|
export declare enum AdminIdentitiesUnlinkType {
|
|
1999
2159
|
SAML = "saml",
|
|
2160
|
+
OIDC = "oidc",
|
|
2000
2161
|
LDAP = "ldap",
|
|
2001
2162
|
SOCIAL = "social"
|
|
2002
2163
|
}
|
|
2164
|
+
/**
|
|
2165
|
+
* @export
|
|
2166
|
+
* @enum {string}
|
|
2167
|
+
*/
|
|
2168
|
+
export declare enum ListUsersSortBy {
|
|
2169
|
+
EMAIL = "email",
|
|
2170
|
+
NAME = "name",
|
|
2171
|
+
USERNAME = "username",
|
|
2172
|
+
CREATED_AT = "createdAt",
|
|
2173
|
+
LAST_LOGIN_AT = "lastLoginAt"
|
|
2174
|
+
}
|
|
2175
|
+
/**
|
|
2176
|
+
* @export
|
|
2177
|
+
* @enum {string}
|
|
2178
|
+
*/
|
|
2179
|
+
export declare enum ListUsersSortDir {
|
|
2180
|
+
ASC = "ASC",
|
|
2181
|
+
DESC = "DESC"
|
|
2182
|
+
}
|