EventsApi.md

\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

[]TypeCreate EventsEventsActionsList(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsEventsActionsList(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsEventsActionsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsEventsActionsList`: []TypeCreate
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsEventsActionsList`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiEventsEventsActionsListRequest struct via the builder pattern

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

Event EventsEventsCreate(ctx).EventRequest(eventRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    eventRequest := *openapiclient.NewEventRequest(openapiclient.EventActions("login"), "App_example") // EventRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsEventsCreate(context.Background()).EventRequest(eventRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsEventsCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsEventsCreate`: Event
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsEventsCreate`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiEventsEventsCreateRequest struct via the builder pattern

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

EventsEventsDestroy(ctx, eventUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    eventUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Event.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsEventsDestroy(context.Background(), eventUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsEventsDestroy``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
eventUuid	string	A UUID string identifying this Event.

Other Parameters

Other parameters are passed through a pointer to a apiEventsEventsDestroyRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(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

PaginatedEventList EventsEventsList(ctx).Action(action).BrandName(brandName).ClientIp(clientIp).ContextAuthorizedApp(contextAuthorizedApp).ContextModelApp(contextModelApp).ContextModelName(contextModelName).ContextModelPk(contextModelPk).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Username(username).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsEventsList(context.Background()).Action(action).BrandName(brandName).ClientIp(clientIp).ContextAuthorizedApp(contextAuthorizedApp).ContextModelApp(contextModelApp).ContextModelName(contextModelName).ContextModelPk(contextModelPk).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Username(username).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsEventsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsEventsList`: PaginatedEventList
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsEventsList`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiEventsEventsListRequest struct via the builder pattern

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

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

Event EventsEventsPartialUpdate(ctx, eventUuid).PatchedEventRequest(patchedEventRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    eventUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Event.
    patchedEventRequest := *openapiclient.NewPatchedEventRequest() // PatchedEventRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsEventsPartialUpdate(context.Background(), eventUuid).PatchedEventRequest(patchedEventRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsEventsPartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsEventsPartialUpdate`: Event
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsEventsPartialUpdate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
eventUuid	string	A UUID string identifying this Event.

Other Parameters

Other parameters are passed through a pointer to a apiEventsEventsPartialUpdateRequest struct via the builder pattern

Name	Type	Description	Notes

patchedEventRequest | PatchedEventRequest | |

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

[]Coordinate EventsEventsPerMonthList(ctx).Action(action).Query(query).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    action := "action_example" // string |  (optional)
    query := "query_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsEventsPerMonthList(context.Background()).Action(action).Query(query).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsEventsPerMonthList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsEventsPerMonthList`: []Coordinate
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsEventsPerMonthList`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiEventsEventsPerMonthListRequest struct via the builder pattern

Name	Type	Description	Notes
action	string
query	string

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

Event EventsEventsRetrieve(ctx, eventUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    eventUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Event.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsEventsRetrieve(context.Background(), eventUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsEventsRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsEventsRetrieve`: Event
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsEventsRetrieve`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
eventUuid	string	A UUID string identifying this Event.

Other Parameters

Other parameters are passed through a pointer to a apiEventsEventsRetrieveRequest struct via the builder pattern

Name	Type	Description	Notes

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

[]EventTopPerUser EventsEventsTopPerUserList(ctx).Action(action).TopN(topN).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    action := "action_example" // string |  (optional)
    topN := int32(56) // int32 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsEventsTopPerUserList(context.Background()).Action(action).TopN(topN).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsEventsTopPerUserList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsEventsTopPerUserList`: []EventTopPerUser
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsEventsTopPerUserList`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiEventsEventsTopPerUserListRequest struct via the builder pattern

Name	Type	Description	Notes
action	string
topN	int32

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

Event EventsEventsUpdate(ctx, eventUuid).EventRequest(eventRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    eventUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Event.
    eventRequest := *openapiclient.NewEventRequest(openapiclient.EventActions("login"), "App_example") // EventRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsEventsUpdate(context.Background(), eventUuid).EventRequest(eventRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsEventsUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsEventsUpdate`: Event
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsEventsUpdate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
eventUuid	string	A UUID string identifying this Event.

Other Parameters

Other parameters are passed through a pointer to a apiEventsEventsUpdateRequest struct via the builder pattern

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]

EventsEventsVolumeList

[]Coordinate EventsEventsVolumeList(ctx).Action(action).BrandName(brandName).ClientIp(clientIp).ContextAuthorizedApp(contextAuthorizedApp).ContextModelApp(contextModelApp).ContextModelName(contextModelName).ContextModelPk(contextModelPk).Ordering(ordering).Search(search).Username(username).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

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

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsEventsVolumeList(context.Background()).Action(action).BrandName(brandName).ClientIp(clientIp).ContextAuthorizedApp(contextAuthorizedApp).ContextModelApp(contextModelApp).ContextModelName(contextModelName).ContextModelPk(contextModelPk).Ordering(ordering).Search(search).Username(username).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsEventsVolumeList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsEventsVolumeList`: []Coordinate
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsEventsVolumeList`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiEventsEventsVolumeListRequest struct via the builder pattern

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

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

EventsNotificationsDestroy(ctx, uuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsNotificationsDestroy(context.Background(), uuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsNotificationsDestroy``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid	string	A UUID string identifying this Notification.

Other Parameters

Other parameters are passed through a pointer to a apiEventsNotificationsDestroyRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(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

PaginatedNotificationList EventsNotificationsList(ctx).Body(body).Created(created).Event(event).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Seen(seen).Severity(severity).User(user).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    body := "body_example" // string |  (optional)
    created := time.Now() // time.Time |  (optional)
    event := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    ordering := "ordering_example" // string | Which field to use when ordering the results. (optional)
    page := int32(56) // int32 | A page number within the paginated result set. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    search := "search_example" // string | A search term. (optional)
    seen := true // bool |  (optional)
    severity := "severity_example" // string |  (optional)
    user := int32(56) // int32 |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsNotificationsList(context.Background()).Body(body).Created(created).Event(event).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Seen(seen).Severity(severity).User(user).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsNotificationsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsNotificationsList`: PaginatedNotificationList
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsNotificationsList`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiEventsNotificationsListRequest struct via the builder pattern

Name	Type	Description	Notes
body	string
created	time.Time
event	string
ordering	string	Which field to use when ordering the results.
page	int32	A page number within the paginated result set.
pageSize	int32	Number of results to return per page.
search	string	A search term.
seen	bool
severity	string
user	int32

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

EventsNotificationsMarkAllSeenCreate(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsNotificationsMarkAllSeenCreate(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsNotificationsMarkAllSeenCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiEventsNotificationsMarkAllSeenCreateRequest struct via the builder pattern

Return type

(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

Notification EventsNotificationsPartialUpdate(ctx, uuid).PatchedNotificationRequest(patchedNotificationRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification.
    patchedNotificationRequest := *openapiclient.NewPatchedNotificationRequest() // PatchedNotificationRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsNotificationsPartialUpdate(context.Background(), uuid).PatchedNotificationRequest(patchedNotificationRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsNotificationsPartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsNotificationsPartialUpdate`: Notification
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsNotificationsPartialUpdate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid	string	A UUID string identifying this Notification.

Other Parameters

Other parameters are passed through a pointer to a apiEventsNotificationsPartialUpdateRequest struct via the builder pattern

Name	Type	Description	Notes

patchedNotificationRequest | PatchedNotificationRequest | |

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

Notification EventsNotificationsRetrieve(ctx, uuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsNotificationsRetrieve(context.Background(), uuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsNotificationsRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsNotificationsRetrieve`: Notification
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsNotificationsRetrieve`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid	string	A UUID string identifying this Notification.

Other Parameters

Other parameters are passed through a pointer to a apiEventsNotificationsRetrieveRequest struct via the builder pattern

Name	Type	Description	Notes

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

Notification EventsNotificationsUpdate(ctx, uuid).NotificationRequest(notificationRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification.
    notificationRequest := *openapiclient.NewNotificationRequest() // NotificationRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsNotificationsUpdate(context.Background(), uuid).NotificationRequest(notificationRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsNotificationsUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsNotificationsUpdate`: Notification
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsNotificationsUpdate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid	string	A UUID string identifying this Notification.

Other Parameters

Other parameters are passed through a pointer to a apiEventsNotificationsUpdateRequest struct via the builder pattern

Name	Type	Description	Notes

notificationRequest | NotificationRequest | |

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

[]UsedBy EventsNotificationsUsedByList(ctx, uuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsNotificationsUsedByList(context.Background(), uuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsNotificationsUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsNotificationsUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsNotificationsUsedByList`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid	string	A UUID string identifying this Notification.

Other Parameters

Other parameters are passed through a pointer to a apiEventsNotificationsUsedByListRequest struct via the builder pattern

Name	Type	Description	Notes

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

NotificationRule EventsRulesCreate(ctx).NotificationRuleRequest(notificationRuleRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    notificationRuleRequest := *openapiclient.NewNotificationRuleRequest("Name_example") // NotificationRuleRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsRulesCreate(context.Background()).NotificationRuleRequest(notificationRuleRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsRulesCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsRulesCreate`: NotificationRule
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsRulesCreate`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiEventsRulesCreateRequest struct via the builder pattern

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

EventsRulesDestroy(ctx, pbmUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pbmUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification Rule.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsRulesDestroy(context.Background(), pbmUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsRulesDestroy``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pbmUuid	string	A UUID string identifying this Notification Rule.

Other Parameters

Other parameters are passed through a pointer to a apiEventsRulesDestroyRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(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

PaginatedNotificationRuleList EventsRulesList(ctx).GroupName(groupName).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Severity(severity).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    groupName := "groupName_example" // string |  (optional)
    name := "name_example" // string |  (optional)
    ordering := "ordering_example" // string | Which field to use when ordering the results. (optional)
    page := int32(56) // int32 | A page number within the paginated result set. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    search := "search_example" // string | A search term. (optional)
    severity := "severity_example" // string | Controls which severity level the created notifications will have.   (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsRulesList(context.Background()).GroupName(groupName).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Severity(severity).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsRulesList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsRulesList`: PaginatedNotificationRuleList
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsRulesList`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiEventsRulesListRequest struct via the builder pattern

Name	Type	Description	Notes
groupName	string
name	string
ordering	string	Which field to use when ordering the results.
page	int32	A page number within the paginated result set.
pageSize	int32	Number of results to return per page.
search	string	A search term.
severity	string	Controls which severity level the created notifications will have.

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

NotificationRule EventsRulesPartialUpdate(ctx, pbmUuid).PatchedNotificationRuleRequest(patchedNotificationRuleRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pbmUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification Rule.
    patchedNotificationRuleRequest := *openapiclient.NewPatchedNotificationRuleRequest() // PatchedNotificationRuleRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsRulesPartialUpdate(context.Background(), pbmUuid).PatchedNotificationRuleRequest(patchedNotificationRuleRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsRulesPartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsRulesPartialUpdate`: NotificationRule
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsRulesPartialUpdate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pbmUuid	string	A UUID string identifying this Notification Rule.

Other Parameters

Other parameters are passed through a pointer to a apiEventsRulesPartialUpdateRequest struct via the builder pattern

Name	Type	Description	Notes

patchedNotificationRuleRequest | PatchedNotificationRuleRequest | |

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

NotificationRule EventsRulesRetrieve(ctx, pbmUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pbmUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification Rule.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsRulesRetrieve(context.Background(), pbmUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsRulesRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsRulesRetrieve`: NotificationRule
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsRulesRetrieve`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pbmUuid	string	A UUID string identifying this Notification Rule.

Other Parameters

Other parameters are passed through a pointer to a apiEventsRulesRetrieveRequest struct via the builder pattern

Name	Type	Description	Notes

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

NotificationRule EventsRulesUpdate(ctx, pbmUuid).NotificationRuleRequest(notificationRuleRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pbmUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification Rule.
    notificationRuleRequest := *openapiclient.NewNotificationRuleRequest("Name_example") // NotificationRuleRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsRulesUpdate(context.Background(), pbmUuid).NotificationRuleRequest(notificationRuleRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsRulesUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsRulesUpdate`: NotificationRule
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsRulesUpdate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pbmUuid	string	A UUID string identifying this Notification Rule.

Other Parameters

Other parameters are passed through a pointer to a apiEventsRulesUpdateRequest struct via the builder pattern

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]

EventsRulesUsedByList

[]UsedBy EventsRulesUsedByList(ctx, pbmUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    pbmUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification Rule.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsRulesUsedByList(context.Background(), pbmUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsRulesUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsRulesUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsRulesUsedByList`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
pbmUuid	string	A UUID string identifying this Notification Rule.

Other Parameters

Other parameters are passed through a pointer to a apiEventsRulesUsedByListRequest struct via the builder pattern

Name	Type	Description	Notes

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

PaginatedSystemTaskList EventsSystemTasksList(ctx).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Status(status).Uid(uid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    name := "name_example" // string |  (optional)
    ordering := "ordering_example" // string | Which field to use when ordering the results. (optional)
    page := int32(56) // int32 | A page number within the paginated result set. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    search := "search_example" // string | A search term. (optional)
    status := "status_example" // string |  (optional)
    uid := "uid_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsSystemTasksList(context.Background()).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Status(status).Uid(uid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsSystemTasksList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsSystemTasksList`: PaginatedSystemTaskList
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsSystemTasksList`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiEventsSystemTasksListRequest struct via the builder pattern

Name	Type	Description	Notes
name	string
ordering	string	Which field to use when ordering the results.
page	int32	A page number within the paginated result set.
pageSize	int32	Number of results to return per page.
search	string	A search term.
status	string
uid	string

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

SystemTask EventsSystemTasksRetrieve(ctx, uuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this System Task.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsSystemTasksRetrieve(context.Background(), uuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsSystemTasksRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsSystemTasksRetrieve`: SystemTask
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsSystemTasksRetrieve`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid	string	A UUID string identifying this System Task.

Other Parameters

Other parameters are passed through a pointer to a apiEventsSystemTasksRetrieveRequest struct via the builder pattern

Name	Type	Description	Notes

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

EventsSystemTasksRunCreate(ctx, uuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this System Task.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsSystemTasksRunCreate(context.Background(), uuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsSystemTasksRunCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid	string	A UUID string identifying this System Task.

Other Parameters

Other parameters are passed through a pointer to a apiEventsSystemTasksRunCreateRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(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

NotificationTransport EventsTransportsCreate(ctx).NotificationTransportRequest(notificationTransportRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    notificationTransportRequest := *openapiclient.NewNotificationTransportRequest("Name_example") // NotificationTransportRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsTransportsCreate(context.Background()).NotificationTransportRequest(notificationTransportRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsTransportsCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsTransportsCreate`: NotificationTransport
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsTransportsCreate`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiEventsTransportsCreateRequest struct via the builder pattern

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

EventsTransportsDestroy(ctx, uuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification Transport.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsTransportsDestroy(context.Background(), uuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsTransportsDestroy``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid	string	A UUID string identifying this Notification Transport.

Other Parameters

Other parameters are passed through a pointer to a apiEventsTransportsDestroyRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(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

PaginatedNotificationTransportList EventsTransportsList(ctx).Mode(mode).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).SendOnce(sendOnce).WebhookUrl(webhookUrl).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    mode := "mode_example" // string |  (optional)
    name := "name_example" // string |  (optional)
    ordering := "ordering_example" // string | Which field to use when ordering the results. (optional)
    page := int32(56) // int32 | A page number within the paginated result set. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    search := "search_example" // string | A search term. (optional)
    sendOnce := true // bool |  (optional)
    webhookUrl := "webhookUrl_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsTransportsList(context.Background()).Mode(mode).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).SendOnce(sendOnce).WebhookUrl(webhookUrl).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsTransportsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsTransportsList`: PaginatedNotificationTransportList
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsTransportsList`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiEventsTransportsListRequest struct via the builder pattern

Name	Type	Description	Notes
mode	string
name	string
ordering	string	Which field to use when ordering the results.
page	int32	A page number within the paginated result set.
pageSize	int32	Number of results to return per page.
search	string	A search term.
sendOnce	bool
webhookUrl	string

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

NotificationTransport EventsTransportsPartialUpdate(ctx, uuid).PatchedNotificationTransportRequest(patchedNotificationTransportRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification Transport.
    patchedNotificationTransportRequest := *openapiclient.NewPatchedNotificationTransportRequest() // PatchedNotificationTransportRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsTransportsPartialUpdate(context.Background(), uuid).PatchedNotificationTransportRequest(patchedNotificationTransportRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsTransportsPartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsTransportsPartialUpdate`: NotificationTransport
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsTransportsPartialUpdate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid	string	A UUID string identifying this Notification Transport.

Other Parameters

Other parameters are passed through a pointer to a apiEventsTransportsPartialUpdateRequest struct via the builder pattern

Name	Type	Description	Notes

patchedNotificationTransportRequest | PatchedNotificationTransportRequest | |

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

NotificationTransport EventsTransportsRetrieve(ctx, uuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification Transport.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsTransportsRetrieve(context.Background(), uuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsTransportsRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsTransportsRetrieve`: NotificationTransport
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsTransportsRetrieve`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid	string	A UUID string identifying this Notification Transport.

Other Parameters

Other parameters are passed through a pointer to a apiEventsTransportsRetrieveRequest struct via the builder pattern

Name	Type	Description	Notes

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

NotificationTransportTest EventsTransportsTestCreate(ctx, uuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification Transport.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsTransportsTestCreate(context.Background(), uuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsTransportsTestCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsTransportsTestCreate`: NotificationTransportTest
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsTransportsTestCreate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid	string	A UUID string identifying this Notification Transport.

Other Parameters

Other parameters are passed through a pointer to a apiEventsTransportsTestCreateRequest struct via the builder pattern

Name	Type	Description	Notes

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

NotificationTransport EventsTransportsUpdate(ctx, uuid).NotificationTransportRequest(notificationTransportRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification Transport.
    notificationTransportRequest := *openapiclient.NewNotificationTransportRequest("Name_example") // NotificationTransportRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsTransportsUpdate(context.Background(), uuid).NotificationTransportRequest(notificationTransportRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsTransportsUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsTransportsUpdate`: NotificationTransport
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsTransportsUpdate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid	string	A UUID string identifying this Notification Transport.

Other Parameters

Other parameters are passed through a pointer to a apiEventsTransportsUpdateRequest struct via the builder pattern

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]

EventsTransportsUsedByList

[]UsedBy EventsTransportsUsedByList(ctx, uuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    uuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Notification Transport.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.EventsApi.EventsTransportsUsedByList(context.Background(), uuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `EventsApi.EventsTransportsUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EventsTransportsUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `EventsApi.EventsTransportsUsedByList`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
uuid	string	A UUID string identifying this Notification Transport.

Other Parameters

Other parameters are passed through a pointer to a apiEventsTransportsUsedByListRequest struct via the builder pattern

Name	Type	Description	Notes

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]