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

Latest commit

 

History

History
1895 lines (1368 loc) · 57.9 KB

EventsApi.md

File metadata and controls

1895 lines (1368 loc) · 57.9 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

kotlin.collections.List<TypeCreate> eventsEventsActionsList()

Get all actions

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
try {
    val result : kotlin.collections.List<TypeCreate> = apiInstance.eventsEventsActionsList()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsEventsActionsList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsEventsActionsList")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

kotlin.collections.List<TypeCreate>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsEventsCreate

Event eventsEventsCreate(eventRequest)

Event Read-Only Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val eventRequest : EventRequest =  // EventRequest | 
try {
    val result : Event = apiInstance.eventsEventsCreate(eventRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsEventsCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsEventsCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
eventRequest EventRequest

Return type

Event

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsEventsDestroy

eventsEventsDestroy(eventUuid)

Event Read-Only Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val eventUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Event.
try {
    apiInstance.eventsEventsDestroy(eventUuid)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsEventsDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsEventsDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsEventsList

PaginatedEventList eventsEventsList(action, brandName, clientIp, contextAuthorizedApp, contextModelApp, contextModelName, contextModelPk, ordering, page, pageSize, search, username)

Event Read-Only Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val action : kotlin.String = action_example // kotlin.String | 
val brandName : kotlin.String = brandName_example // kotlin.String | Brand name
val clientIp : kotlin.String = clientIp_example // kotlin.String | 
val contextAuthorizedApp : kotlin.String = contextAuthorizedApp_example // kotlin.String | Context Authorized application
val contextModelApp : kotlin.String = contextModelApp_example // kotlin.String | Context Model App
val contextModelName : kotlin.String = contextModelName_example // kotlin.String | Context Model Name
val contextModelPk : kotlin.String = contextModelPk_example // kotlin.String | Context Model Primary Key
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
val username : kotlin.String = username_example // kotlin.String | Username
try {
    val result : PaginatedEventList = apiInstance.eventsEventsList(action, brandName, clientIp, contextAuthorizedApp, contextModelApp, contextModelName, contextModelPk, ordering, page, pageSize, search, username)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsEventsList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsEventsList")
    e.printStackTrace()
}

Parameters

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

Return type

PaginatedEventList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsEventsPartialUpdate

Event eventsEventsPartialUpdate(eventUuid, patchedEventRequest)

Event Read-Only Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val eventUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Event.
val patchedEventRequest : PatchedEventRequest =  // PatchedEventRequest | 
try {
    val result : Event = apiInstance.eventsEventsPartialUpdate(eventUuid, patchedEventRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsEventsPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsEventsPartialUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

Event

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsEventsPerMonthList

kotlin.collections.List<Coordinate> eventsEventsPerMonthList(action, query)

Get the count of events per month

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val action : kotlin.String = action_example // kotlin.String | 
val query : kotlin.String = query_example // kotlin.String | 
try {
    val result : kotlin.collections.List<Coordinate> = apiInstance.eventsEventsPerMonthList(action, query)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsEventsPerMonthList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsEventsPerMonthList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<Coordinate>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsEventsRetrieve

Event eventsEventsRetrieve(eventUuid)

Event Read-Only Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val eventUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Event.
try {
    val result : Event = apiInstance.eventsEventsRetrieve(eventUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsEventsRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsEventsRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

Event

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsEventsTopPerUserList

kotlin.collections.List<EventTopPerUser> eventsEventsTopPerUserList(action, topN)

Get the top_n events grouped by user count

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val action : kotlin.String = action_example // kotlin.String | 
val topN : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : kotlin.collections.List<EventTopPerUser> = apiInstance.eventsEventsTopPerUserList(action, topN)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsEventsTopPerUserList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsEventsTopPerUserList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<EventTopPerUser>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsEventsUpdate

Event eventsEventsUpdate(eventUuid, eventRequest)

Event Read-Only Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val eventUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Event.
val eventRequest : EventRequest =  // EventRequest | 
try {
    val result : Event = apiInstance.eventsEventsUpdate(eventUuid, eventRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsEventsUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsEventsUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

Event

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsEventsVolumeList

kotlin.collections.List<Coordinate> eventsEventsVolumeList(action, brandName, clientIp, contextAuthorizedApp, contextModelApp, contextModelName, contextModelPk, ordering, search, username)

Get event volume for specified filters and timeframe

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val action : kotlin.String = action_example // kotlin.String | 
val brandName : kotlin.String = brandName_example // kotlin.String | Brand name
val clientIp : kotlin.String = clientIp_example // kotlin.String | 
val contextAuthorizedApp : kotlin.String = contextAuthorizedApp_example // kotlin.String | Context Authorized application
val contextModelApp : kotlin.String = contextModelApp_example // kotlin.String | Context Model App
val contextModelName : kotlin.String = contextModelName_example // kotlin.String | Context Model Name
val contextModelPk : kotlin.String = contextModelPk_example // kotlin.String | Context Model Primary Key
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val search : kotlin.String = search_example // kotlin.String | A search term.
val username : kotlin.String = username_example // kotlin.String | Username
try {
    val result : kotlin.collections.List<Coordinate> = apiInstance.eventsEventsVolumeList(action, brandName, clientIp, contextAuthorizedApp, contextModelApp, contextModelName, contextModelPk, ordering, search, username)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsEventsVolumeList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsEventsVolumeList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<Coordinate>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsNotificationsDestroy

eventsNotificationsDestroy(uuid)

Notification Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification.
try {
    apiInstance.eventsNotificationsDestroy(uuid)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsNotificationsDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsNotificationsDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsNotificationsList

PaginatedNotificationList eventsNotificationsList(body, created, event, ordering, page, pageSize, search, seen, severity, user)

Notification Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val body : kotlin.String = body_example // kotlin.String | 
val created : java.time.OffsetDateTime = 2013-10-20T19:20:30+01:00 // java.time.OffsetDateTime | 
val event : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
val seen : kotlin.Boolean = true // kotlin.Boolean | 
val severity : kotlin.String = severity_example // kotlin.String | * `notice` - Notice * `warning` - Warning * `alert` - Alert
val user : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : PaginatedNotificationList = apiInstance.eventsNotificationsList(body, created, event, ordering, page, pageSize, search, seen, severity, user)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsNotificationsList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsNotificationsList")
    e.printStackTrace()
}

Parameters

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

Return type

PaginatedNotificationList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsNotificationsMarkAllSeenCreate

eventsNotificationsMarkAllSeenCreate()

Mark all the user's notifications as seen

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
try {
    apiInstance.eventsNotificationsMarkAllSeenCreate()
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsNotificationsMarkAllSeenCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsNotificationsMarkAllSeenCreate")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsNotificationsPartialUpdate

Notification eventsNotificationsPartialUpdate(uuid, patchedNotificationRequest)

Notification Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification.
val patchedNotificationRequest : PatchedNotificationRequest =  // PatchedNotificationRequest | 
try {
    val result : Notification = apiInstance.eventsNotificationsPartialUpdate(uuid, patchedNotificationRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsNotificationsPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsNotificationsPartialUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

Notification

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsNotificationsRetrieve

Notification eventsNotificationsRetrieve(uuid)

Notification Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification.
try {
    val result : Notification = apiInstance.eventsNotificationsRetrieve(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsNotificationsRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsNotificationsRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

Notification

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsNotificationsUpdate

Notification eventsNotificationsUpdate(uuid, notificationRequest)

Notification Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification.
val notificationRequest : NotificationRequest =  // NotificationRequest | 
try {
    val result : Notification = apiInstance.eventsNotificationsUpdate(uuid, notificationRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsNotificationsUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsNotificationsUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

Notification

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsNotificationsUsedByList

kotlin.collections.List<UsedBy> eventsNotificationsUsedByList(uuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.eventsNotificationsUsedByList(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsNotificationsUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsNotificationsUsedByList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsRulesCreate

NotificationRule eventsRulesCreate(notificationRuleRequest)

NotificationRule Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val notificationRuleRequest : NotificationRuleRequest =  // NotificationRuleRequest | 
try {
    val result : NotificationRule = apiInstance.eventsRulesCreate(notificationRuleRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsRulesCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsRulesCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
notificationRuleRequest NotificationRuleRequest

Return type

NotificationRule

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsRulesDestroy

eventsRulesDestroy(pbmUuid)

NotificationRule Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val pbmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification Rule.
try {
    apiInstance.eventsRulesDestroy(pbmUuid)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsRulesDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsRulesDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsRulesList

PaginatedNotificationRuleList eventsRulesList(groupName, name, ordering, page, pageSize, search, severity)

NotificationRule Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val groupName : kotlin.String = groupName_example // kotlin.String | 
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
val severity : kotlin.String = severity_example // kotlin.String | Controls which severity level the created notifications will have.  * `notice` - Notice * `warning` - Warning * `alert` - Alert
try {
    val result : PaginatedNotificationRuleList = apiInstance.eventsRulesList(groupName, name, ordering, page, pageSize, search, severity)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsRulesList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsRulesList")
    e.printStackTrace()
}

Parameters

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

Return type

PaginatedNotificationRuleList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsRulesPartialUpdate

NotificationRule eventsRulesPartialUpdate(pbmUuid, patchedNotificationRuleRequest)

NotificationRule Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val pbmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification Rule.
val patchedNotificationRuleRequest : PatchedNotificationRuleRequest =  // PatchedNotificationRuleRequest | 
try {
    val result : NotificationRule = apiInstance.eventsRulesPartialUpdate(pbmUuid, patchedNotificationRuleRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsRulesPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsRulesPartialUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

NotificationRule

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsRulesRetrieve

NotificationRule eventsRulesRetrieve(pbmUuid)

NotificationRule Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val pbmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification Rule.
try {
    val result : NotificationRule = apiInstance.eventsRulesRetrieve(pbmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsRulesRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsRulesRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

NotificationRule

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsRulesUpdate

NotificationRule eventsRulesUpdate(pbmUuid, notificationRuleRequest)

NotificationRule Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val pbmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification Rule.
val notificationRuleRequest : NotificationRuleRequest =  // NotificationRuleRequest | 
try {
    val result : NotificationRule = apiInstance.eventsRulesUpdate(pbmUuid, notificationRuleRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsRulesUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsRulesUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

NotificationRule

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsRulesUsedByList

kotlin.collections.List<UsedBy> eventsRulesUsedByList(pbmUuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val pbmUuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification Rule.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.eventsRulesUsedByList(pbmUuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsRulesUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsRulesUsedByList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsSystemTasksList

PaginatedSystemTaskList eventsSystemTasksList(name, ordering, page, pageSize, search, status, uid)

Read-only view set that returns all background tasks

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
val status : kotlin.String = status_example // kotlin.String | * `unknown` - Unknown * `successful` - Successful * `warning` - Warning * `error` - Error
val uid : kotlin.String = uid_example // kotlin.String | 
try {
    val result : PaginatedSystemTaskList = apiInstance.eventsSystemTasksList(name, ordering, page, pageSize, search, status, uid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsSystemTasksList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsSystemTasksList")
    e.printStackTrace()
}

Parameters

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

Return type

PaginatedSystemTaskList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsSystemTasksRetrieve

SystemTask eventsSystemTasksRetrieve(uuid)

Read-only view set that returns all background tasks

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this System Task.
try {
    val result : SystemTask = apiInstance.eventsSystemTasksRetrieve(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsSystemTasksRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsSystemTasksRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

SystemTask

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsSystemTasksRunCreate

eventsSystemTasksRunCreate(uuid)

Run task

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this System Task.
try {
    apiInstance.eventsSystemTasksRunCreate(uuid)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsSystemTasksRunCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsSystemTasksRunCreate")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsTransportsCreate

NotificationTransport eventsTransportsCreate(notificationTransportRequest)

NotificationTransport Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val notificationTransportRequest : NotificationTransportRequest =  // NotificationTransportRequest | 
try {
    val result : NotificationTransport = apiInstance.eventsTransportsCreate(notificationTransportRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsTransportsCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsTransportsCreate")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
notificationTransportRequest NotificationTransportRequest

Return type

NotificationTransport

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsTransportsDestroy

eventsTransportsDestroy(uuid)

NotificationTransport Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification Transport.
try {
    apiInstance.eventsTransportsDestroy(uuid)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsTransportsDestroy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsTransportsDestroy")
    e.printStackTrace()
}

Parameters

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

Return type

null (empty response body)

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsTransportsList

PaginatedNotificationTransportList eventsTransportsList(mode, name, ordering, page, pageSize, search, sendOnce, webhookUrl)

NotificationTransport Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val mode : kotlin.String = mode_example // kotlin.String | * `local` - authentik inbuilt notifications * `webhook` - Generic Webhook * `webhook_slack` - Slack Webhook (Slack/Discord) * `email` - Email
val name : kotlin.String = name_example // kotlin.String | 
val ordering : kotlin.String = ordering_example // kotlin.String | Which field to use when ordering the results.
val page : kotlin.Int = 56 // kotlin.Int | A page number within the paginated result set.
val pageSize : kotlin.Int = 56 // kotlin.Int | Number of results to return per page.
val search : kotlin.String = search_example // kotlin.String | A search term.
val sendOnce : kotlin.Boolean = true // kotlin.Boolean | 
val webhookUrl : kotlin.String = webhookUrl_example // kotlin.String | 
try {
    val result : PaginatedNotificationTransportList = apiInstance.eventsTransportsList(mode, name, ordering, page, pageSize, search, sendOnce, webhookUrl)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsTransportsList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsTransportsList")
    e.printStackTrace()
}

Parameters

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

Return type

PaginatedNotificationTransportList

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsTransportsPartialUpdate

NotificationTransport eventsTransportsPartialUpdate(uuid, patchedNotificationTransportRequest)

NotificationTransport Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification Transport.
val patchedNotificationTransportRequest : PatchedNotificationTransportRequest =  // PatchedNotificationTransportRequest | 
try {
    val result : NotificationTransport = apiInstance.eventsTransportsPartialUpdate(uuid, patchedNotificationTransportRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsTransportsPartialUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsTransportsPartialUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

NotificationTransport

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsTransportsRetrieve

NotificationTransport eventsTransportsRetrieve(uuid)

NotificationTransport Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification Transport.
try {
    val result : NotificationTransport = apiInstance.eventsTransportsRetrieve(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsTransportsRetrieve")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsTransportsRetrieve")
    e.printStackTrace()
}

Parameters

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

Return type

NotificationTransport

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsTransportsTestCreate

NotificationTransportTest eventsTransportsTestCreate(uuid)

Send example notification using selected transport. Requires Modify permissions.

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification Transport.
try {
    val result : NotificationTransportTest = apiInstance.eventsTransportsTestCreate(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsTransportsTestCreate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsTransportsTestCreate")
    e.printStackTrace()
}

Parameters

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

Return type

NotificationTransportTest

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsTransportsUpdate

NotificationTransport eventsTransportsUpdate(uuid, notificationTransportRequest)

NotificationTransport Viewset

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification Transport.
val notificationTransportRequest : NotificationTransportRequest =  // NotificationTransportRequest | 
try {
    val result : NotificationTransport = apiInstance.eventsTransportsUpdate(uuid, notificationTransportRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsTransportsUpdate")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsTransportsUpdate")
    e.printStackTrace()
}

Parameters

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

Return type

NotificationTransport

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

eventsTransportsUsedByList

kotlin.collections.List<UsedBy> eventsTransportsUsedByList(uuid)

Get a list of all objects that use this object

Example

// Import classes:
//import io.goauthentik.api.infrastructure.*
//import io.goauthentik.api.models.*

val apiInstance = EventsApi()
val uuid : java.util.UUID = 38400000-8cf0-11bd-b23e-10b96e4ef00d // java.util.UUID | A UUID string identifying this Notification Transport.
try {
    val result : kotlin.collections.List<UsedBy> = apiInstance.eventsTransportsUsedByList(uuid)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling EventsApi#eventsTransportsUsedByList")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling EventsApi#eventsTransportsUsedByList")
    e.printStackTrace()
}

Parameters

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

Return type

kotlin.collections.List<UsedBy>

Authorization

Configure authentik: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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