Skip to content
This repository has been archived by the owner on Apr 17, 2024. It is now read-only.

Latest commit

 

History

History
1866 lines (1269 loc) · 59.5 KB

EventsAPI.md

File metadata and controls

1866 lines (1269 loc) · 59.5 KB
Raw

EventsAPI

All URIs are relative to http://localhost/api/v3

Method HTTP request Description
eventsEventsActionsList GET /events/events/actions/
eventsEventsCreate POST /events/events/
eventsEventsDestroy DELETE /events/events/{event_uuid}/
eventsEventsList GET /events/events/
eventsEventsPartialUpdate PATCH /events/events/{event_uuid}/
eventsEventsPerMonthList GET /events/events/per_month/
eventsEventsRetrieve GET /events/events/{event_uuid}/
eventsEventsTopPerUserList GET /events/events/top_per_user/
eventsEventsUpdate PUT /events/events/{event_uuid}/
eventsEventsVolumeList GET /events/events/volume/
eventsNotificationsDestroy DELETE /events/notifications/{uuid}/
eventsNotificationsList GET /events/notifications/
eventsNotificationsMarkAllSeenCreate POST /events/notifications/mark_all_seen/
eventsNotificationsPartialUpdate PATCH /events/notifications/{uuid}/
eventsNotificationsRetrieve GET /events/notifications/{uuid}/
eventsNotificationsUpdate PUT /events/notifications/{uuid}/
eventsNotificationsUsedByList GET /events/notifications/{uuid}/used_by/
eventsRulesCreate POST /events/rules/
eventsRulesDestroy DELETE /events/rules/{pbm_uuid}/
eventsRulesList GET /events/rules/
eventsRulesPartialUpdate PATCH /events/rules/{pbm_uuid}/
eventsRulesRetrieve GET /events/rules/{pbm_uuid}/
eventsRulesUpdate PUT /events/rules/{pbm_uuid}/
eventsRulesUsedByList GET /events/rules/{pbm_uuid}/used_by/
eventsSystemTasksList GET /events/system_tasks/
eventsSystemTasksRetrieve GET /events/system_tasks/{uuid}/
eventsSystemTasksRunCreate POST /events/system_tasks/{uuid}/run/
eventsTransportsCreate POST /events/transports/
eventsTransportsDestroy DELETE /events/transports/{uuid}/
eventsTransportsList GET /events/transports/
eventsTransportsPartialUpdate PATCH /events/transports/{uuid}/
eventsTransportsRetrieve GET /events/transports/{uuid}/
eventsTransportsTestCreate POST /events/transports/{uuid}/test/
eventsTransportsUpdate PUT /events/transports/{uuid}/
eventsTransportsUsedByList GET /events/transports/{uuid}/used_by/

eventsEventsActionsList

    open class func eventsEventsActionsList(completion: @escaping (_ data: [TypeCreate]?, _ error: Error?) -> Void)

Get all actions

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient


EventsAPI.eventsEventsActionsList() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

[TypeCreate]

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsEventsCreate

    open class func eventsEventsCreate(eventRequest: EventRequest, completion: @escaping (_ data: Event?, _ error: Error?) -> Void)

Event Read-Only Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let eventRequest = EventRequest(user: "TODO", action: EventActions(), app: "app_example", context: "TODO", clientIp: "clientIp_example", expires: Date(), brand: "TODO") // EventRequest | 

EventsAPI.eventsEventsCreate(eventRequest: eventRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
eventRequest EventRequest

Return type

Event

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsEventsDestroy

    open class func eventsEventsDestroy(eventUuid: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Event Read-Only Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let eventUuid = 987 // UUID | A UUID string identifying this Event.

EventsAPI.eventsEventsDestroy(eventUuid: eventUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
eventUuid UUID A UUID string identifying this Event.

Return type

Void (empty response body)

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsEventsList

    open class func eventsEventsList(action: String? = nil, brandName: String? = nil, clientIp: String? = nil, contextAuthorizedApp: String? = nil, contextModelApp: String? = nil, contextModelName: String? = nil, contextModelPk: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, username: String? = nil, completion: @escaping (_ data: PaginatedEventList?, _ error: Error?) -> Void)

Event Read-Only Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let action = "action_example" // String |  (optional)
let brandName = "brandName_example" // String | Brand name (optional)
let clientIp = "clientIp_example" // String |  (optional)
let contextAuthorizedApp = "contextAuthorizedApp_example" // String | Context Authorized application (optional)
let contextModelApp = "contextModelApp_example" // String | Context Model App (optional)
let contextModelName = "contextModelName_example" // String | Context Model Name (optional)
let contextModelPk = "contextModelPk_example" // String | Context Model Primary Key (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)
let username = "username_example" // String | Username (optional)

EventsAPI.eventsEventsList(action: action, brandName: brandName, clientIp: clientIp, contextAuthorizedApp: contextAuthorizedApp, contextModelApp: contextModelApp, contextModelName: contextModelName, contextModelPk: contextModelPk, ordering: ordering, page: page, pageSize: pageSize, search: search, username: username) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
action String [optional]
brandName String Brand name [optional]
clientIp String [optional]
contextAuthorizedApp String Context Authorized application [optional]
contextModelApp String Context Model App [optional]
contextModelName String Context Model Name [optional]
contextModelPk String Context Model Primary Key [optional]
ordering String Which field to use when ordering the results. [optional]
page Int A page number within the paginated result set. [optional]
pageSize Int Number of results to return per page. [optional]
search String A search term. [optional]
username String Username [optional]

Return type

PaginatedEventList

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsEventsPartialUpdate

    open class func eventsEventsPartialUpdate(eventUuid: UUID, patchedEventRequest: PatchedEventRequest? = nil, completion: @escaping (_ data: Event?, _ error: Error?) -> Void)

Event Read-Only Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let eventUuid = 987 // UUID | A UUID string identifying this Event.
let patchedEventRequest = PatchedEventRequest(user: "TODO", action: EventActions(), app: "app_example", context: "TODO", clientIp: "clientIp_example", expires: Date(), brand: "TODO") // PatchedEventRequest |  (optional)

EventsAPI.eventsEventsPartialUpdate(eventUuid: eventUuid, patchedEventRequest: patchedEventRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
eventUuid UUID A UUID string identifying this Event.
patchedEventRequest PatchedEventRequest [optional]

Return type

Event

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsEventsPerMonthList

    open class func eventsEventsPerMonthList(action: String? = nil, query: String? = nil, completion: @escaping (_ data: [Coordinate]?, _ error: Error?) -> Void)

Get the count of events per month

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let action = "action_example" // String |  (optional)
let query = "query_example" // String |  (optional)

EventsAPI.eventsEventsPerMonthList(action: action, query: query) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
action String [optional]
query String [optional]

Return type

[Coordinate]

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsEventsRetrieve

    open class func eventsEventsRetrieve(eventUuid: UUID, completion: @escaping (_ data: Event?, _ error: Error?) -> Void)

Event Read-Only Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let eventUuid = 987 // UUID | A UUID string identifying this Event.

EventsAPI.eventsEventsRetrieve(eventUuid: eventUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
eventUuid UUID A UUID string identifying this Event.

Return type

Event

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsEventsTopPerUserList

    open class func eventsEventsTopPerUserList(action: String? = nil, topN: Int? = nil, completion: @escaping (_ data: [EventTopPerUser]?, _ error: Error?) -> Void)

Get the top_n events grouped by user count

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let action = "action_example" // String |  (optional)
let topN = 987 // Int |  (optional)

EventsAPI.eventsEventsTopPerUserList(action: action, topN: topN) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
action String [optional]
topN Int [optional]

Return type

[EventTopPerUser]

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsEventsUpdate

    open class func eventsEventsUpdate(eventUuid: UUID, eventRequest: EventRequest, completion: @escaping (_ data: Event?, _ error: Error?) -> Void)

Event Read-Only Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let eventUuid = 987 // UUID | A UUID string identifying this Event.
let eventRequest = EventRequest(user: "TODO", action: EventActions(), app: "app_example", context: "TODO", clientIp: "clientIp_example", expires: Date(), brand: "TODO") // EventRequest | 

EventsAPI.eventsEventsUpdate(eventUuid: eventUuid, eventRequest: eventRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
eventUuid UUID A UUID string identifying this Event.
eventRequest EventRequest

Return type

Event

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsEventsVolumeList

    open class func eventsEventsVolumeList(action: String? = nil, brandName: String? = nil, clientIp: String? = nil, contextAuthorizedApp: String? = nil, contextModelApp: String? = nil, contextModelName: String? = nil, contextModelPk: String? = nil, ordering: String? = nil, search: String? = nil, username: String? = nil, completion: @escaping (_ data: [Coordinate]?, _ error: Error?) -> Void)

Get event volume for specified filters and timeframe

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let action = "action_example" // String |  (optional)
let brandName = "brandName_example" // String | Brand name (optional)
let clientIp = "clientIp_example" // String |  (optional)
let contextAuthorizedApp = "contextAuthorizedApp_example" // String | Context Authorized application (optional)
let contextModelApp = "contextModelApp_example" // String | Context Model App (optional)
let contextModelName = "contextModelName_example" // String | Context Model Name (optional)
let contextModelPk = "contextModelPk_example" // String | Context Model Primary Key (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let search = "search_example" // String | A search term. (optional)
let username = "username_example" // String | Username (optional)

EventsAPI.eventsEventsVolumeList(action: action, brandName: brandName, clientIp: clientIp, contextAuthorizedApp: contextAuthorizedApp, contextModelApp: contextModelApp, contextModelName: contextModelName, contextModelPk: contextModelPk, ordering: ordering, search: search, username: username) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
action String [optional]
brandName String Brand name [optional]
clientIp String [optional]
contextAuthorizedApp String Context Authorized application [optional]
contextModelApp String Context Model App [optional]
contextModelName String Context Model Name [optional]
contextModelPk String Context Model Primary Key [optional]
ordering String Which field to use when ordering the results. [optional]
search String A search term. [optional]
username String Username [optional]

Return type

[Coordinate]

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsNotificationsDestroy

    open class func eventsNotificationsDestroy(uuid: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Notification Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let uuid = 987 // UUID | A UUID string identifying this Notification.

EventsAPI.eventsNotificationsDestroy(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uuid UUID A UUID string identifying this Notification.

Return type

Void (empty response body)

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsNotificationsList

    open class func eventsNotificationsList(body: String? = nil, created: Date? = nil, event: UUID? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, seen: Bool? = nil, severity: Severity_eventsNotificationsList? = nil, user: Int? = nil, completion: @escaping (_ data: PaginatedNotificationList?, _ error: Error?) -> Void)

Notification Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let body = "body_example" // String |  (optional)
let created = Date() // Date |  (optional)
let event = 987 // UUID |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)
let seen = true // Bool |  (optional)
let severity = "severity_example" // String | * `notice` - Notice * `warning` - Warning * `alert` - Alert (optional)
let user = 987 // Int |  (optional)

EventsAPI.eventsNotificationsList(body: body, created: created, event: event, ordering: ordering, page: page, pageSize: pageSize, search: search, seen: seen, severity: severity, user: user) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
body String [optional]
created Date [optional]
event UUID [optional]
ordering String Which field to use when ordering the results. [optional]
page Int A page number within the paginated result set. [optional]
pageSize Int Number of results to return per page. [optional]
search String A search term. [optional]
seen Bool [optional]
severity String * `notice` - Notice * `warning` - Warning * `alert` - Alert [optional]
user Int [optional]

Return type

PaginatedNotificationList

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsNotificationsMarkAllSeenCreate

    open class func eventsNotificationsMarkAllSeenCreate(completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Mark all the user's notifications as seen

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient


EventsAPI.eventsNotificationsMarkAllSeenCreate() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Void (empty response body)

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsNotificationsPartialUpdate

    open class func eventsNotificationsPartialUpdate(uuid: UUID, patchedNotificationRequest: PatchedNotificationRequest? = nil, completion: @escaping (_ data: Notification?, _ error: Error?) -> Void)

Notification Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let uuid = 987 // UUID | A UUID string identifying this Notification.
let patchedNotificationRequest = PatchedNotificationRequest(event: EventRequest(user: "TODO", action: EventActions(), app: "app_example", context: "TODO", clientIp: "clientIp_example", expires: Date(), brand: "TODO"), seen: false) // PatchedNotificationRequest |  (optional)

EventsAPI.eventsNotificationsPartialUpdate(uuid: uuid, patchedNotificationRequest: patchedNotificationRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uuid UUID A UUID string identifying this Notification.
patchedNotificationRequest PatchedNotificationRequest [optional]

Return type

Notification

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsNotificationsRetrieve

    open class func eventsNotificationsRetrieve(uuid: UUID, completion: @escaping (_ data: Notification?, _ error: Error?) -> Void)

Notification Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let uuid = 987 // UUID | A UUID string identifying this Notification.

EventsAPI.eventsNotificationsRetrieve(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uuid UUID A UUID string identifying this Notification.

Return type

Notification

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsNotificationsUpdate

    open class func eventsNotificationsUpdate(uuid: UUID, notificationRequest: NotificationRequest? = nil, completion: @escaping (_ data: Notification?, _ error: Error?) -> Void)

Notification Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let uuid = 987 // UUID | A UUID string identifying this Notification.
let notificationRequest = NotificationRequest(event: EventRequest(user: "TODO", action: EventActions(), app: "app_example", context: "TODO", clientIp: "clientIp_example", expires: Date(), brand: "TODO"), seen: false) // NotificationRequest |  (optional)

EventsAPI.eventsNotificationsUpdate(uuid: uuid, notificationRequest: notificationRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uuid UUID A UUID string identifying this Notification.
notificationRequest NotificationRequest [optional]

Return type

Notification

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsNotificationsUsedByList

    open class func eventsNotificationsUsedByList(uuid: UUID, completion: @escaping (_ data: [UsedBy]?, _ error: Error?) -> Void)

Get a list of all objects that use this object

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let uuid = 987 // UUID | A UUID string identifying this Notification.

EventsAPI.eventsNotificationsUsedByList(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uuid UUID A UUID string identifying this Notification.

Return type

[UsedBy]

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsRulesCreate

    open class func eventsRulesCreate(notificationRuleRequest: NotificationRuleRequest, completion: @escaping (_ data: NotificationRule?, _ error: Error?) -> Void)

NotificationRule Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let notificationRuleRequest = NotificationRuleRequest(name: "name_example", transports: [123], severity: SeverityEnum(), group: 123) // NotificationRuleRequest | 

EventsAPI.eventsRulesCreate(notificationRuleRequest: notificationRuleRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
notificationRuleRequest NotificationRuleRequest

Return type

NotificationRule

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsRulesDestroy

    open class func eventsRulesDestroy(pbmUuid: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

NotificationRule Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let pbmUuid = 987 // UUID | A UUID string identifying this Notification Rule.

EventsAPI.eventsRulesDestroy(pbmUuid: pbmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pbmUuid UUID A UUID string identifying this Notification Rule.

Return type

Void (empty response body)

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsRulesList

    open class func eventsRulesList(groupName: String? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, severity: Severity_eventsRulesList? = nil, completion: @escaping (_ data: PaginatedNotificationRuleList?, _ error: Error?) -> Void)

NotificationRule Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let groupName = "groupName_example" // String |  (optional)
let name = "name_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)
let severity = "severity_example" // String | Controls which severity level the created notifications will have.  * `notice` - Notice * `warning` - Warning * `alert` - Alert (optional)

EventsAPI.eventsRulesList(groupName: groupName, name: name, ordering: ordering, page: page, pageSize: pageSize, search: search, severity: severity) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
groupName String [optional]
name String [optional]
ordering String Which field to use when ordering the results. [optional]
page Int A page number within the paginated result set. [optional]
pageSize Int Number of results to return per page. [optional]
search String A search term. [optional]
severity String Controls which severity level the created notifications will have. * `notice` - Notice * `warning` - Warning * `alert` - Alert [optional]

Return type

PaginatedNotificationRuleList

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsRulesPartialUpdate

    open class func eventsRulesPartialUpdate(pbmUuid: UUID, patchedNotificationRuleRequest: PatchedNotificationRuleRequest? = nil, completion: @escaping (_ data: NotificationRule?, _ error: Error?) -> Void)

NotificationRule Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let pbmUuid = 987 // UUID | A UUID string identifying this Notification Rule.
let patchedNotificationRuleRequest = PatchedNotificationRuleRequest(name: "name_example", transports: [123], severity: SeverityEnum(), group: 123) // PatchedNotificationRuleRequest |  (optional)

EventsAPI.eventsRulesPartialUpdate(pbmUuid: pbmUuid, patchedNotificationRuleRequest: patchedNotificationRuleRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pbmUuid UUID A UUID string identifying this Notification Rule.
patchedNotificationRuleRequest PatchedNotificationRuleRequest [optional]

Return type

NotificationRule

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsRulesRetrieve

    open class func eventsRulesRetrieve(pbmUuid: UUID, completion: @escaping (_ data: NotificationRule?, _ error: Error?) -> Void)

NotificationRule Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let pbmUuid = 987 // UUID | A UUID string identifying this Notification Rule.

EventsAPI.eventsRulesRetrieve(pbmUuid: pbmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pbmUuid UUID A UUID string identifying this Notification Rule.

Return type

NotificationRule

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsRulesUpdate

    open class func eventsRulesUpdate(pbmUuid: UUID, notificationRuleRequest: NotificationRuleRequest, completion: @escaping (_ data: NotificationRule?, _ error: Error?) -> Void)

NotificationRule Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let pbmUuid = 987 // UUID | A UUID string identifying this Notification Rule.
let notificationRuleRequest = NotificationRuleRequest(name: "name_example", transports: [123], severity: SeverityEnum(), group: 123) // NotificationRuleRequest | 

EventsAPI.eventsRulesUpdate(pbmUuid: pbmUuid, notificationRuleRequest: notificationRuleRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pbmUuid UUID A UUID string identifying this Notification Rule.
notificationRuleRequest NotificationRuleRequest

Return type

NotificationRule

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsRulesUsedByList

    open class func eventsRulesUsedByList(pbmUuid: UUID, completion: @escaping (_ data: [UsedBy]?, _ error: Error?) -> Void)

Get a list of all objects that use this object

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let pbmUuid = 987 // UUID | A UUID string identifying this Notification Rule.

EventsAPI.eventsRulesUsedByList(pbmUuid: pbmUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pbmUuid UUID A UUID string identifying this Notification Rule.

Return type

[UsedBy]

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsSystemTasksList

    open class func eventsSystemTasksList(name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, status: Status_eventsSystemTasksList? = nil, uid: String? = nil, completion: @escaping (_ data: PaginatedSystemTaskList?, _ error: Error?) -> Void)

Read-only view set that returns all background tasks

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let name = "name_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)
let status = "status_example" // String | * `unknown` - Unknown * `successful` - Successful * `warning` - Warning * `error` - Error (optional)
let uid = "uid_example" // String |  (optional)

EventsAPI.eventsSystemTasksList(name: name, ordering: ordering, page: page, pageSize: pageSize, search: search, status: status, uid: uid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
name String [optional]
ordering String Which field to use when ordering the results. [optional]
page Int A page number within the paginated result set. [optional]
pageSize Int Number of results to return per page. [optional]
search String A search term. [optional]
status String * `unknown` - Unknown * `successful` - Successful * `warning` - Warning * `error` - Error [optional]
uid String [optional]

Return type

PaginatedSystemTaskList

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsSystemTasksRetrieve

    open class func eventsSystemTasksRetrieve(uuid: UUID, completion: @escaping (_ data: SystemTask?, _ error: Error?) -> Void)

Read-only view set that returns all background tasks

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let uuid = 987 // UUID | A UUID string identifying this System Task.

EventsAPI.eventsSystemTasksRetrieve(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uuid UUID A UUID string identifying this System Task.

Return type

SystemTask

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsSystemTasksRunCreate

    open class func eventsSystemTasksRunCreate(uuid: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Run task

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let uuid = 987 // UUID | A UUID string identifying this System Task.

EventsAPI.eventsSystemTasksRunCreate(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uuid UUID A UUID string identifying this System Task.

Return type

Void (empty response body)

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsTransportsCreate

    open class func eventsTransportsCreate(notificationTransportRequest: NotificationTransportRequest, completion: @escaping (_ data: NotificationTransport?, _ error: Error?) -> Void)

NotificationTransport Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let notificationTransportRequest = NotificationTransportRequest(name: "name_example", mode: NotificationTransportModeEnum(), webhookUrl: "webhookUrl_example", webhookMapping: 123, sendOnce: false) // NotificationTransportRequest | 

EventsAPI.eventsTransportsCreate(notificationTransportRequest: notificationTransportRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
notificationTransportRequest NotificationTransportRequest

Return type

NotificationTransport

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsTransportsDestroy

    open class func eventsTransportsDestroy(uuid: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

NotificationTransport Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let uuid = 987 // UUID | A UUID string identifying this Notification Transport.

EventsAPI.eventsTransportsDestroy(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uuid UUID A UUID string identifying this Notification Transport.

Return type

Void (empty response body)

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsTransportsList

    open class func eventsTransportsList(mode: Mode_eventsTransportsList? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, sendOnce: Bool? = nil, webhookUrl: String? = nil, completion: @escaping (_ data: PaginatedNotificationTransportList?, _ error: Error?) -> Void)

NotificationTransport Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let mode = "mode_example" // String | * `local` - authentik inbuilt notifications * `webhook` - Generic Webhook * `webhook_slack` - Slack Webhook (Slack/Discord) * `email` - Email (optional)
let name = "name_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)
let sendOnce = true // Bool |  (optional)
let webhookUrl = "webhookUrl_example" // String |  (optional)

EventsAPI.eventsTransportsList(mode: mode, name: name, ordering: ordering, page: page, pageSize: pageSize, search: search, sendOnce: sendOnce, webhookUrl: webhookUrl) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
mode String * `local` - authentik inbuilt notifications * `webhook` - Generic Webhook * `webhook_slack` - Slack Webhook (Slack/Discord) * `email` - Email [optional]
name String [optional]
ordering String Which field to use when ordering the results. [optional]
page Int A page number within the paginated result set. [optional]
pageSize Int Number of results to return per page. [optional]
search String A search term. [optional]
sendOnce Bool [optional]
webhookUrl String [optional]

Return type

PaginatedNotificationTransportList

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsTransportsPartialUpdate

    open class func eventsTransportsPartialUpdate(uuid: UUID, patchedNotificationTransportRequest: PatchedNotificationTransportRequest? = nil, completion: @escaping (_ data: NotificationTransport?, _ error: Error?) -> Void)

NotificationTransport Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let uuid = 987 // UUID | A UUID string identifying this Notification Transport.
let patchedNotificationTransportRequest = PatchedNotificationTransportRequest(name: "name_example", mode: NotificationTransportModeEnum(), webhookUrl: "webhookUrl_example", webhookMapping: 123, sendOnce: false) // PatchedNotificationTransportRequest |  (optional)

EventsAPI.eventsTransportsPartialUpdate(uuid: uuid, patchedNotificationTransportRequest: patchedNotificationTransportRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uuid UUID A UUID string identifying this Notification Transport.
patchedNotificationTransportRequest PatchedNotificationTransportRequest [optional]

Return type

NotificationTransport

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsTransportsRetrieve

    open class func eventsTransportsRetrieve(uuid: UUID, completion: @escaping (_ data: NotificationTransport?, _ error: Error?) -> Void)

NotificationTransport Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let uuid = 987 // UUID | A UUID string identifying this Notification Transport.

EventsAPI.eventsTransportsRetrieve(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uuid UUID A UUID string identifying this Notification Transport.

Return type

NotificationTransport

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsTransportsTestCreate

    open class func eventsTransportsTestCreate(uuid: UUID, completion: @escaping (_ data: NotificationTransportTest?, _ error: Error?) -> Void)

Send example notification using selected transport. Requires Modify permissions.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let uuid = 987 // UUID | A UUID string identifying this Notification Transport.

EventsAPI.eventsTransportsTestCreate(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uuid UUID A UUID string identifying this Notification Transport.

Return type

NotificationTransportTest

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsTransportsUpdate

    open class func eventsTransportsUpdate(uuid: UUID, notificationTransportRequest: NotificationTransportRequest, completion: @escaping (_ data: NotificationTransport?, _ error: Error?) -> Void)

NotificationTransport Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let uuid = 987 // UUID | A UUID string identifying this Notification Transport.
let notificationTransportRequest = NotificationTransportRequest(name: "name_example", mode: NotificationTransportModeEnum(), webhookUrl: "webhookUrl_example", webhookMapping: 123, sendOnce: false) // NotificationTransportRequest | 

EventsAPI.eventsTransportsUpdate(uuid: uuid, notificationTransportRequest: notificationTransportRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uuid UUID A UUID string identifying this Notification Transport.
notificationTransportRequest NotificationTransportRequest

Return type

NotificationTransport

Authorization

authentik

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

eventsTransportsUsedByList

    open class func eventsTransportsUsedByList(uuid: UUID, completion: @escaping (_ data: [UsedBy]?, _ error: Error?) -> Void)

Get a list of all objects that use this object

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let uuid = 987 // UUID | A UUID string identifying this Notification Transport.

EventsAPI.eventsTransportsUsedByList(uuid: uuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
uuid UUID A UUID string identifying this Notification Transport.

Return type

[UsedBy]

Authorization

authentik

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]