/** * authentik * Making authentication simple. * * The version of the OpenAPI document: 2025.6.3 * Contact: hello@goauthentik.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { Event, EventRequest, EventTopPerUser, EventVolume, Notification, NotificationRequest, NotificationRule, NotificationRuleRequest, NotificationTransport, NotificationTransportRequest, NotificationTransportTest, PaginatedEventList, PaginatedNotificationList, PaginatedNotificationRuleList, PaginatedNotificationTransportList, PaginatedSystemTaskList, PatchedEventRequest, PatchedNotificationRequest, PatchedNotificationRuleRequest, PatchedNotificationTransportRequest, SystemTask, TypeCreate, UsedBy } from '../models/index'; export interface EventsEventsCreateRequest { eventRequest: EventRequest; } export interface EventsEventsDestroyRequest { eventUuid: string; } export interface EventsEventsListRequest { action?: string; actions?: Array; brandName?: string; clientIp?: string; contextAuthorizedApp?: string; contextModelApp?: string; contextModelName?: string; contextModelPk?: string; ordering?: string; page?: number; pageSize?: number; search?: string; username?: string; } export interface EventsEventsPartialUpdateRequest { eventUuid: string; patchedEventRequest?: PatchedEventRequest; } export interface EventsEventsRetrieveRequest { eventUuid: string; } export interface EventsEventsTopPerUserListRequest { action?: string; topN?: number; } export interface EventsEventsUpdateRequest { eventUuid: string; eventRequest: EventRequest; } export interface EventsEventsVolumeListRequest { action?: string; actions?: Array; brandName?: string; clientIp?: string; contextAuthorizedApp?: string; contextModelApp?: string; contextModelName?: string; contextModelPk?: string; historyDays?: number; ordering?: string; search?: string; username?: string; } export interface EventsNotificationsDestroyRequest { uuid: string; } export interface EventsNotificationsListRequest { body?: string; created?: Date; event?: string; ordering?: string; page?: number; pageSize?: number; search?: string; seen?: boolean; severity?: EventsNotificationsListSeverityEnum; user?: number; } export interface EventsNotificationsPartialUpdateRequest { uuid: string; patchedNotificationRequest?: PatchedNotificationRequest; } export interface EventsNotificationsRetrieveRequest { uuid: string; } export interface EventsNotificationsUpdateRequest { uuid: string; notificationRequest?: NotificationRequest; } export interface EventsNotificationsUsedByListRequest { uuid: string; } export interface EventsRulesCreateRequest { notificationRuleRequest: NotificationRuleRequest; } export interface EventsRulesDestroyRequest { pbmUuid: string; } export interface EventsRulesListRequest { destinationGroupName?: string; name?: string; ordering?: string; page?: number; pageSize?: number; search?: string; severity?: EventsRulesListSeverityEnum; } export interface EventsRulesPartialUpdateRequest { pbmUuid: string; patchedNotificationRuleRequest?: PatchedNotificationRuleRequest; } export interface EventsRulesRetrieveRequest { pbmUuid: string; } export interface EventsRulesUpdateRequest { pbmUuid: string; notificationRuleRequest: NotificationRuleRequest; } export interface EventsRulesUsedByListRequest { pbmUuid: string; } export interface EventsSystemTasksListRequest { name?: string; ordering?: string; page?: number; pageSize?: number; search?: string; status?: EventsSystemTasksListStatusEnum; uid?: string; } export interface EventsSystemTasksRetrieveRequest { uuid: string; } export interface EventsSystemTasksRunCreateRequest { uuid: string; } export interface EventsTransportsCreateRequest { notificationTransportRequest: NotificationTransportRequest; } export interface EventsTransportsDestroyRequest { uuid: string; } export interface EventsTransportsListRequest { mode?: EventsTransportsListModeEnum; name?: string; ordering?: string; page?: number; pageSize?: number; search?: string; sendOnce?: boolean; webhookUrl?: string; } export interface EventsTransportsPartialUpdateRequest { uuid: string; patchedNotificationTransportRequest?: PatchedNotificationTransportRequest; } export interface EventsTransportsRetrieveRequest { uuid: string; } export interface EventsTransportsTestCreateRequest { uuid: string; } export interface EventsTransportsUpdateRequest { uuid: string; notificationTransportRequest: NotificationTransportRequest; } export interface EventsTransportsUsedByListRequest { uuid: string; } /** * */ export declare class EventsApi extends runtime.BaseAPI { /** * Get all actions */ eventsEventsActionsListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Get all actions */ eventsEventsActionsList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Event Read-Only Viewset */ eventsEventsCreateRaw(requestParameters: EventsEventsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Event Read-Only Viewset */ eventsEventsCreate(requestParameters: EventsEventsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Event Read-Only Viewset */ eventsEventsDestroyRaw(requestParameters: EventsEventsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Event Read-Only Viewset */ eventsEventsDestroy(requestParameters: EventsEventsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Event Read-Only Viewset */ eventsEventsListRaw(requestParameters: EventsEventsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Event Read-Only Viewset */ eventsEventsList(requestParameters?: EventsEventsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Event Read-Only Viewset */ eventsEventsPartialUpdateRaw(requestParameters: EventsEventsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Event Read-Only Viewset */ eventsEventsPartialUpdate(requestParameters: EventsEventsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Event Read-Only Viewset */ eventsEventsRetrieveRaw(requestParameters: EventsEventsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Event Read-Only Viewset */ eventsEventsRetrieve(requestParameters: EventsEventsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get the top_n events grouped by user count */ eventsEventsTopPerUserListRaw(requestParameters: EventsEventsTopPerUserListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Get the top_n events grouped by user count */ eventsEventsTopPerUserList(requestParameters?: EventsEventsTopPerUserListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Event Read-Only Viewset */ eventsEventsUpdateRaw(requestParameters: EventsEventsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Event Read-Only Viewset */ eventsEventsUpdate(requestParameters: EventsEventsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get event volume for specified filters and timeframe */ eventsEventsVolumeListRaw(requestParameters: EventsEventsVolumeListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Get event volume for specified filters and timeframe */ eventsEventsVolumeList(requestParameters?: EventsEventsVolumeListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Notification Viewset */ eventsNotificationsDestroyRaw(requestParameters: EventsNotificationsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Notification Viewset */ eventsNotificationsDestroy(requestParameters: EventsNotificationsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Notification Viewset */ eventsNotificationsListRaw(requestParameters: EventsNotificationsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Notification Viewset */ eventsNotificationsList(requestParameters?: EventsNotificationsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Mark all the user\'s notifications as seen */ eventsNotificationsMarkAllSeenCreateRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Mark all the user\'s notifications as seen */ eventsNotificationsMarkAllSeenCreate(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Notification Viewset */ eventsNotificationsPartialUpdateRaw(requestParameters: EventsNotificationsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Notification Viewset */ eventsNotificationsPartialUpdate(requestParameters: EventsNotificationsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Notification Viewset */ eventsNotificationsRetrieveRaw(requestParameters: EventsNotificationsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Notification Viewset */ eventsNotificationsRetrieve(requestParameters: EventsNotificationsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Notification Viewset */ eventsNotificationsUpdateRaw(requestParameters: EventsNotificationsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Notification Viewset */ eventsNotificationsUpdate(requestParameters: EventsNotificationsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get a list of all objects that use this object */ eventsNotificationsUsedByListRaw(requestParameters: EventsNotificationsUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Get a list of all objects that use this object */ eventsNotificationsUsedByList(requestParameters: EventsNotificationsUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * NotificationRule Viewset */ eventsRulesCreateRaw(requestParameters: EventsRulesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * NotificationRule Viewset */ eventsRulesCreate(requestParameters: EventsRulesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * NotificationRule Viewset */ eventsRulesDestroyRaw(requestParameters: EventsRulesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * NotificationRule Viewset */ eventsRulesDestroy(requestParameters: EventsRulesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * NotificationRule Viewset */ eventsRulesListRaw(requestParameters: EventsRulesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * NotificationRule Viewset */ eventsRulesList(requestParameters?: EventsRulesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * NotificationRule Viewset */ eventsRulesPartialUpdateRaw(requestParameters: EventsRulesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * NotificationRule Viewset */ eventsRulesPartialUpdate(requestParameters: EventsRulesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * NotificationRule Viewset */ eventsRulesRetrieveRaw(requestParameters: EventsRulesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * NotificationRule Viewset */ eventsRulesRetrieve(requestParameters: EventsRulesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * NotificationRule Viewset */ eventsRulesUpdateRaw(requestParameters: EventsRulesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * NotificationRule Viewset */ eventsRulesUpdate(requestParameters: EventsRulesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get a list of all objects that use this object */ eventsRulesUsedByListRaw(requestParameters: EventsRulesUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Get a list of all objects that use this object */ eventsRulesUsedByList(requestParameters: EventsRulesUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Read-only view set that returns all background tasks */ eventsSystemTasksListRaw(requestParameters: EventsSystemTasksListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Read-only view set that returns all background tasks */ eventsSystemTasksList(requestParameters?: EventsSystemTasksListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Read-only view set that returns all background tasks */ eventsSystemTasksRetrieveRaw(requestParameters: EventsSystemTasksRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Read-only view set that returns all background tasks */ eventsSystemTasksRetrieve(requestParameters: EventsSystemTasksRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Run task */ eventsSystemTasksRunCreateRaw(requestParameters: EventsSystemTasksRunCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Run task */ eventsSystemTasksRunCreate(requestParameters: EventsSystemTasksRunCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * NotificationTransport Viewset */ eventsTransportsCreateRaw(requestParameters: EventsTransportsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * NotificationTransport Viewset */ eventsTransportsCreate(requestParameters: EventsTransportsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * NotificationTransport Viewset */ eventsTransportsDestroyRaw(requestParameters: EventsTransportsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * NotificationTransport Viewset */ eventsTransportsDestroy(requestParameters: EventsTransportsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * NotificationTransport Viewset */ eventsTransportsListRaw(requestParameters: EventsTransportsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * NotificationTransport Viewset */ eventsTransportsList(requestParameters?: EventsTransportsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * NotificationTransport Viewset */ eventsTransportsPartialUpdateRaw(requestParameters: EventsTransportsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * NotificationTransport Viewset */ eventsTransportsPartialUpdate(requestParameters: EventsTransportsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * NotificationTransport Viewset */ eventsTransportsRetrieveRaw(requestParameters: EventsTransportsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * NotificationTransport Viewset */ eventsTransportsRetrieve(requestParameters: EventsTransportsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Send example notification using selected transport. Requires Modify permissions. */ eventsTransportsTestCreateRaw(requestParameters: EventsTransportsTestCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Send example notification using selected transport. Requires Modify permissions. */ eventsTransportsTestCreate(requestParameters: EventsTransportsTestCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * NotificationTransport Viewset */ eventsTransportsUpdateRaw(requestParameters: EventsTransportsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * NotificationTransport Viewset */ eventsTransportsUpdate(requestParameters: EventsTransportsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get a list of all objects that use this object */ eventsTransportsUsedByListRaw(requestParameters: EventsTransportsUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Get a list of all objects that use this object */ eventsTransportsUsedByList(requestParameters: EventsTransportsUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; } /** * @export */ export declare const EventsEventsListActionsEnum: { readonly AuthorizeApplication: "authorize_application"; readonly ConfigurationError: "configuration_error"; readonly Custom: "custom_"; readonly EmailSent: "email_sent"; readonly FlowExecution: "flow_execution"; readonly ImpersonationEnded: "impersonation_ended"; readonly ImpersonationStarted: "impersonation_started"; readonly InvitationUsed: "invitation_used"; readonly Login: "login"; readonly LoginFailed: "login_failed"; readonly Logout: "logout"; readonly ModelCreated: "model_created"; readonly ModelDeleted: "model_deleted"; readonly ModelUpdated: "model_updated"; readonly PasswordSet: "password_set"; readonly PolicyException: "policy_exception"; readonly PolicyExecution: "policy_execution"; readonly PropertyMappingException: "property_mapping_exception"; readonly SecretRotate: "secret_rotate"; readonly SecretView: "secret_view"; readonly SourceLinked: "source_linked"; readonly SuspiciousRequest: "suspicious_request"; readonly SystemException: "system_exception"; readonly SystemTaskException: "system_task_exception"; readonly SystemTaskExecution: "system_task_execution"; readonly UpdateAvailable: "update_available"; readonly UserWrite: "user_write"; readonly UnknownDefaultOpenApi: "11184809"; }; export type EventsEventsListActionsEnum = typeof EventsEventsListActionsEnum[keyof typeof EventsEventsListActionsEnum]; /** * @export */ export declare const EventsEventsVolumeListActionsEnum: { readonly AuthorizeApplication: "authorize_application"; readonly ConfigurationError: "configuration_error"; readonly Custom: "custom_"; readonly EmailSent: "email_sent"; readonly FlowExecution: "flow_execution"; readonly ImpersonationEnded: "impersonation_ended"; readonly ImpersonationStarted: "impersonation_started"; readonly InvitationUsed: "invitation_used"; readonly Login: "login"; readonly LoginFailed: "login_failed"; readonly Logout: "logout"; readonly ModelCreated: "model_created"; readonly ModelDeleted: "model_deleted"; readonly ModelUpdated: "model_updated"; readonly PasswordSet: "password_set"; readonly PolicyException: "policy_exception"; readonly PolicyExecution: "policy_execution"; readonly PropertyMappingException: "property_mapping_exception"; readonly SecretRotate: "secret_rotate"; readonly SecretView: "secret_view"; readonly SourceLinked: "source_linked"; readonly SuspiciousRequest: "suspicious_request"; readonly SystemException: "system_exception"; readonly SystemTaskException: "system_task_exception"; readonly SystemTaskExecution: "system_task_execution"; readonly UpdateAvailable: "update_available"; readonly UserWrite: "user_write"; readonly UnknownDefaultOpenApi: "11184809"; }; export type EventsEventsVolumeListActionsEnum = typeof EventsEventsVolumeListActionsEnum[keyof typeof EventsEventsVolumeListActionsEnum]; /** * @export */ export declare const EventsNotificationsListSeverityEnum: { readonly Alert: "alert"; readonly Notice: "notice"; readonly Warning: "warning"; readonly UnknownDefaultOpenApi: "11184809"; }; export type EventsNotificationsListSeverityEnum = typeof EventsNotificationsListSeverityEnum[keyof typeof EventsNotificationsListSeverityEnum]; /** * @export */ export declare const EventsRulesListSeverityEnum: { readonly Alert: "alert"; readonly Notice: "notice"; readonly Warning: "warning"; readonly UnknownDefaultOpenApi: "11184809"; }; export type EventsRulesListSeverityEnum = typeof EventsRulesListSeverityEnum[keyof typeof EventsRulesListSeverityEnum]; /** * @export */ export declare const EventsSystemTasksListStatusEnum: { readonly Error: "error"; readonly Successful: "successful"; readonly Unknown: "unknown"; readonly Warning: "warning"; readonly UnknownDefaultOpenApi: "11184809"; }; export type EventsSystemTasksListStatusEnum = typeof EventsSystemTasksListStatusEnum[keyof typeof EventsSystemTasksListStatusEnum]; /** * @export */ export declare const EventsTransportsListModeEnum: { readonly Email: "email"; readonly Local: "local"; readonly Webhook: "webhook"; readonly WebhookSlack: "webhook_slack"; readonly UnknownDefaultOpenApi: "11184809"; }; export type EventsTransportsListModeEnum = typeof EventsTransportsListModeEnum[keyof typeof EventsTransportsListModeEnum]; //# sourceMappingURL=EventsApi.d.ts.map