EventsApi.md

authentik_client.EventsApi

All URIs are relative to /api/v3

Method	HTTP request	Description
events_events_actions_list	GET /events/events/actions/
events_events_create	POST /events/events/
events_events_destroy	DELETE /events/events/{event_uuid}/
events_events_export_create	POST /events/events/export/
events_events_list	GET /events/events/
events_events_partial_update	PATCH /events/events/{event_uuid}/
events_events_retrieve	GET /events/events/{event_uuid}/
events_events_top_per_user_list	GET /events/events/top_per_user/
events_events_update	PUT /events/events/{event_uuid}/
events_events_volume_list	GET /events/events/volume/
events_notifications_destroy	DELETE /events/notifications/{uuid}/
events_notifications_list	GET /events/notifications/
events_notifications_mark_all_seen_create	POST /events/notifications/mark_all_seen/
events_notifications_partial_update	PATCH /events/notifications/{uuid}/
events_notifications_retrieve	GET /events/notifications/{uuid}/
events_notifications_update	PUT /events/notifications/{uuid}/
events_notifications_used_by_list	GET /events/notifications/{uuid}/used_by/
events_rules_create	POST /events/rules/
events_rules_destroy	DELETE /events/rules/{pbm_uuid}/
events_rules_list	GET /events/rules/
events_rules_partial_update	PATCH /events/rules/{pbm_uuid}/
events_rules_retrieve	GET /events/rules/{pbm_uuid}/
events_rules_update	PUT /events/rules/{pbm_uuid}/
events_rules_used_by_list	GET /events/rules/{pbm_uuid}/used_by/
events_transports_create	POST /events/transports/
events_transports_destroy	DELETE /events/transports/{uuid}/
events_transports_list	GET /events/transports/
events_transports_partial_update	PATCH /events/transports/{uuid}/
events_transports_retrieve	GET /events/transports/{uuid}/
events_transports_test_create	POST /events/transports/{uuid}/test/
events_transports_update	PUT /events/transports/{uuid}/
events_transports_used_by_list	GET /events/transports/{uuid}/used_by/

events_events_actions_list

List[TypeCreate] events_events_actions_list()

Get all actions

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.type_create import TypeCreate
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)

    try:
        api_response = api_instance.events_events_actions_list()
        print("The response of EventsApi->events_events_actions_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_events_actions_list: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[TypeCreate]

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_events_create

Event events_events_create(event_request)

Event Read-Only Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.event import Event
from authentik_client.models.event_request import EventRequest
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    event_request = authentik_client.EventRequest() # EventRequest | 

    try:
        api_response = api_instance.events_events_create(event_request)
        print("The response of EventsApi->events_events_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_events_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
event_request	EventRequest

Return type

Event

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201		-
400		-
403		-

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

events_events_destroy

events_events_destroy(event_uuid)

Event Read-Only Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    event_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Event.

    try:
        api_instance.events_events_destroy(event_uuid)
    except Exception as e:
        print("Exception when calling EventsApi->events_events_destroy: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	No response body	-
400		-
403		-

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

events_events_export_create

DataExport events_events_export_create(action=action, actions=actions, brand_name=brand_name, client_ip=client_ip, context_authorized_app=context_authorized_app, context_model_app=context_model_app, context_model_name=context_model_name, context_model_pk=context_model_pk, ordering=ordering, search=search, username=username)

Create a data export for this data type. Note that the export is generated asynchronously: this method returns a DataExport object that will initially have completed=false as well as the permanent URL to that object in the Location header. You can poll that URL until completed=true, at which point the file_url property will contain a URL to download

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.data_export import DataExport
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    action = 'action_example' # str |  (optional)
    actions = ['actions_example'] # List[str] |  (optional)
    brand_name = 'brand_name_example' # str | Brand name (optional)
    client_ip = 'client_ip_example' # str |  (optional)
    context_authorized_app = 'context_authorized_app_example' # str | Context Authorized application (optional)
    context_model_app = 'context_model_app_example' # str | Context Model App (optional)
    context_model_name = 'context_model_name_example' # str | Context Model Name (optional)
    context_model_pk = 'context_model_pk_example' # str | Context Model Primary Key (optional)
    ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional)
    search = 'search_example' # str | A search term. (optional)
    username = 'username_example' # str | Username (optional)

    try:
        api_response = api_instance.events_events_export_create(action=action, actions=actions, brand_name=brand_name, client_ip=client_ip, context_authorized_app=context_authorized_app, context_model_app=context_model_app, context_model_name=context_model_name, context_model_pk=context_model_pk, ordering=ordering, search=search, username=username)
        print("The response of EventsApi->events_events_export_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_events_export_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
action	str		[optional]
actions	List[str]		[optional]
brand_name	str	Brand name	[optional]
client_ip	str		[optional]
context_authorized_app	str	Context Authorized application	[optional]
context_model_app	str	Context Model App	[optional]
context_model_name	str	Context Model Name	[optional]
context_model_pk	str	Context Model Primary Key	[optional]
ordering	str	Which field to use when ordering the results.	[optional]
search	str	A search term.	[optional]
username	str	Username	[optional]

Return type

DataExport

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201		-
400		-
403		-

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

events_events_list

PaginatedEventList events_events_list(action=action, actions=actions, brand_name=brand_name, client_ip=client_ip, context_authorized_app=context_authorized_app, context_model_app=context_model_app, context_model_name=context_model_name, context_model_pk=context_model_pk, ordering=ordering, page=page, page_size=page_size, search=search, username=username)

Event Read-Only Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.paginated_event_list import PaginatedEventList
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    action = 'action_example' # str |  (optional)
    actions = ['actions_example'] # List[str] |  (optional)
    brand_name = 'brand_name_example' # str | Brand name (optional)
    client_ip = 'client_ip_example' # str |  (optional)
    context_authorized_app = 'context_authorized_app_example' # str | Context Authorized application (optional)
    context_model_app = 'context_model_app_example' # str | Context Model App (optional)
    context_model_name = 'context_model_name_example' # str | Context Model Name (optional)
    context_model_pk = 'context_model_pk_example' # str | Context Model Primary Key (optional)
    ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional)
    page = 56 # int | A page number within the paginated result set. (optional)
    page_size = 56 # int | Number of results to return per page. (optional)
    search = 'search_example' # str | A search term. (optional)
    username = 'username_example' # str | Username (optional)

    try:
        api_response = api_instance.events_events_list(action=action, actions=actions, brand_name=brand_name, client_ip=client_ip, context_authorized_app=context_authorized_app, context_model_app=context_model_app, context_model_name=context_model_name, context_model_pk=context_model_pk, ordering=ordering, page=page, page_size=page_size, search=search, username=username)
        print("The response of EventsApi->events_events_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_events_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
action	str		[optional]
actions	List[str]		[optional]
brand_name	str	Brand name	[optional]
client_ip	str		[optional]
context_authorized_app	str	Context Authorized application	[optional]
context_model_app	str	Context Model App	[optional]
context_model_name	str	Context Model Name	[optional]
context_model_pk	str	Context Model Primary Key	[optional]
ordering	str	Which field to use when ordering the results.	[optional]
page	int	A page number within the paginated result set.	[optional]
page_size	int	Number of results to return per page.	[optional]
search	str	A search term.	[optional]
username	str	Username	[optional]

Return type

PaginatedEventList

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_events_partial_update

Event events_events_partial_update(event_uuid, patched_event_request=patched_event_request)

Event Read-Only Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.event import Event
from authentik_client.models.patched_event_request import PatchedEventRequest
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    event_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Event.
    patched_event_request = authentik_client.PatchedEventRequest() # PatchedEventRequest |  (optional)

    try:
        api_response = api_instance.events_events_partial_update(event_uuid, patched_event_request=patched_event_request)
        print("The response of EventsApi->events_events_partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_events_partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
event_uuid	UUID	A UUID string identifying this Event.
patched_event_request	PatchedEventRequest		[optional]

Return type

Event

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_events_retrieve

Event events_events_retrieve(event_uuid)

Event Read-Only Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.event import Event
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    event_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Event.

    try:
        api_response = api_instance.events_events_retrieve(event_uuid)
        print("The response of EventsApi->events_events_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_events_retrieve: %s\n" % e)

Parameters

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

Return type

Event

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_events_top_per_user_list

List[EventTopPerUser] events_events_top_per_user_list(action=action, top_n=top_n)

Get the top_n events grouped by user count

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.event_top_per_user import EventTopPerUser
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    action = 'action_example' # str |  (optional)
    top_n = 56 # int |  (optional)

    try:
        api_response = api_instance.events_events_top_per_user_list(action=action, top_n=top_n)
        print("The response of EventsApi->events_events_top_per_user_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_events_top_per_user_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
action	str		[optional]
top_n	int		[optional]

Return type

List[EventTopPerUser]

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_events_update

Event events_events_update(event_uuid, event_request)

Event Read-Only Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.event import Event
from authentik_client.models.event_request import EventRequest
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    event_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Event.
    event_request = authentik_client.EventRequest() # EventRequest | 

    try:
        api_response = api_instance.events_events_update(event_uuid, event_request)
        print("The response of EventsApi->events_events_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_events_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
event_uuid	UUID	A UUID string identifying this Event.
event_request	EventRequest

Return type

Event

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_events_volume_list

List[EventVolume] events_events_volume_list(action=action, actions=actions, brand_name=brand_name, client_ip=client_ip, context_authorized_app=context_authorized_app, context_model_app=context_model_app, context_model_name=context_model_name, context_model_pk=context_model_pk, history_days=history_days, ordering=ordering, search=search, username=username)

Get event volume for specified filters and timeframe

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.event_volume import EventVolume
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    action = 'action_example' # str |  (optional)
    actions = ['actions_example'] # List[str] |  (optional)
    brand_name = 'brand_name_example' # str | Brand name (optional)
    client_ip = 'client_ip_example' # str |  (optional)
    context_authorized_app = 'context_authorized_app_example' # str | Context Authorized application (optional)
    context_model_app = 'context_model_app_example' # str | Context Model App (optional)
    context_model_name = 'context_model_name_example' # str | Context Model Name (optional)
    context_model_pk = 'context_model_pk_example' # str | Context Model Primary Key (optional)
    history_days = 7 # float |  (optional) (default to 7)
    ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional)
    search = 'search_example' # str | A search term. (optional)
    username = 'username_example' # str | Username (optional)

    try:
        api_response = api_instance.events_events_volume_list(action=action, actions=actions, brand_name=brand_name, client_ip=client_ip, context_authorized_app=context_authorized_app, context_model_app=context_model_app, context_model_name=context_model_name, context_model_pk=context_model_pk, history_days=history_days, ordering=ordering, search=search, username=username)
        print("The response of EventsApi->events_events_volume_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_events_volume_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
action	str		[optional]
actions	List[str]		[optional]
brand_name	str	Brand name	[optional]
client_ip	str		[optional]
context_authorized_app	str	Context Authorized application	[optional]
context_model_app	str	Context Model App	[optional]
context_model_name	str	Context Model Name	[optional]
context_model_pk	str	Context Model Primary Key	[optional]
history_days	float		[optional] [default to 7]
ordering	str	Which field to use when ordering the results.	[optional]
search	str	A search term.	[optional]
username	str	Username	[optional]

Return type

List[EventVolume]

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_notifications_destroy

events_notifications_destroy(uuid)

Notification Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification.

    try:
        api_instance.events_notifications_destroy(uuid)
    except Exception as e:
        print("Exception when calling EventsApi->events_notifications_destroy: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	No response body	-
400		-
403		-

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

events_notifications_list

PaginatedNotificationList events_notifications_list(body=body, created=created, event=event, ordering=ordering, page=page, page_size=page_size, search=search, seen=seen, severity=severity, user=user)

Notification Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.paginated_notification_list import PaginatedNotificationList
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    body = 'body_example' # str |  (optional)
    created = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    event = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |  (optional)
    ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional)
    page = 56 # int | A page number within the paginated result set. (optional)
    page_size = 56 # int | Number of results to return per page. (optional)
    search = 'search_example' # str | A search term. (optional)
    seen = True # bool |  (optional)
    severity = 'severity_example' # str |  (optional)
    user = 56 # int |  (optional)

    try:
        api_response = api_instance.events_notifications_list(body=body, created=created, event=event, ordering=ordering, page=page, page_size=page_size, search=search, seen=seen, severity=severity, user=user)
        print("The response of EventsApi->events_notifications_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_notifications_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	str		[optional]
created	datetime		[optional]
event	UUID		[optional]
ordering	str	Which field to use when ordering the results.	[optional]
page	int	A page number within the paginated result set.	[optional]
page_size	int	Number of results to return per page.	[optional]
search	str	A search term.	[optional]
seen	bool		[optional]
severity	str		[optional]
user	int		[optional]

Return type

PaginatedNotificationList

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_notifications_mark_all_seen_create

events_notifications_mark_all_seen_create()

Mark all the user's notifications as seen

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)

    try:
        api_instance.events_notifications_mark_all_seen_create()
    except Exception as e:
        print("Exception when calling EventsApi->events_notifications_mark_all_seen_create: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	Marked tasks as read successfully.	-
400		-
403		-

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

events_notifications_partial_update

Notification events_notifications_partial_update(uuid, patched_notification_request=patched_notification_request)

Notification Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.notification import Notification
from authentik_client.models.patched_notification_request import PatchedNotificationRequest
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification.
    patched_notification_request = authentik_client.PatchedNotificationRequest() # PatchedNotificationRequest |  (optional)

    try:
        api_response = api_instance.events_notifications_partial_update(uuid, patched_notification_request=patched_notification_request)
        print("The response of EventsApi->events_notifications_partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_notifications_partial_update: %s\n" % e)

Parameters

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

Return type

Notification

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_notifications_retrieve

Notification events_notifications_retrieve(uuid)

Notification Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.notification import Notification
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification.

    try:
        api_response = api_instance.events_notifications_retrieve(uuid)
        print("The response of EventsApi->events_notifications_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_notifications_retrieve: %s\n" % e)

Parameters

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

Return type

Notification

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_notifications_update

Notification events_notifications_update(uuid, notification_request=notification_request)

Notification Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.notification import Notification
from authentik_client.models.notification_request import NotificationRequest
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification.
    notification_request = authentik_client.NotificationRequest() # NotificationRequest |  (optional)

    try:
        api_response = api_instance.events_notifications_update(uuid, notification_request=notification_request)
        print("The response of EventsApi->events_notifications_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_notifications_update: %s\n" % e)

Parameters

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

Return type

Notification

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_notifications_used_by_list

List[UsedBy] events_notifications_used_by_list(uuid)

Get a list of all objects that use this object

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.used_by import UsedBy
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification.

    try:
        api_response = api_instance.events_notifications_used_by_list(uuid)
        print("The response of EventsApi->events_notifications_used_by_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_notifications_used_by_list: %s\n" % e)

Parameters

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

Return type

List[UsedBy]

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_rules_create

NotificationRule events_rules_create(notification_rule_request)

NotificationRule Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.notification_rule import NotificationRule
from authentik_client.models.notification_rule_request import NotificationRuleRequest
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    notification_rule_request = authentik_client.NotificationRuleRequest() # NotificationRuleRequest | 

    try:
        api_response = api_instance.events_rules_create(notification_rule_request)
        print("The response of EventsApi->events_rules_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_rules_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
notification_rule_request	NotificationRuleRequest

Return type

NotificationRule

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201		-
400		-
403		-

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

events_rules_destroy

events_rules_destroy(pbm_uuid)

NotificationRule Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    pbm_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification Rule.

    try:
        api_instance.events_rules_destroy(pbm_uuid)
    except Exception as e:
        print("Exception when calling EventsApi->events_rules_destroy: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	No response body	-
400		-
403		-

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

events_rules_list

PaginatedNotificationRuleList events_rules_list(destination_group__name=destination_group__name, name=name, ordering=ordering, page=page, page_size=page_size, search=search, severity=severity)

NotificationRule Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.paginated_notification_rule_list import PaginatedNotificationRuleList
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    destination_group__name = 'destination_group__name_example' # str |  (optional)
    name = 'name_example' # str |  (optional)
    ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional)
    page = 56 # int | A page number within the paginated result set. (optional)
    page_size = 56 # int | Number of results to return per page. (optional)
    search = 'search_example' # str | A search term. (optional)
    severity = 'severity_example' # str | Controls which severity level the created notifications will have.   (optional)

    try:
        api_response = api_instance.events_rules_list(destination_group__name=destination_group__name, name=name, ordering=ordering, page=page, page_size=page_size, search=search, severity=severity)
        print("The response of EventsApi->events_rules_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_rules_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
destination_group__name	str		[optional]
name	str		[optional]
ordering	str	Which field to use when ordering the results.	[optional]
page	int	A page number within the paginated result set.	[optional]
page_size	int	Number of results to return per page.	[optional]
search	str	A search term.	[optional]
severity	str	Controls which severity level the created notifications will have.	[optional]

Return type

PaginatedNotificationRuleList

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_rules_partial_update

NotificationRule events_rules_partial_update(pbm_uuid, patched_notification_rule_request=patched_notification_rule_request)

NotificationRule Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.notification_rule import NotificationRule
from authentik_client.models.patched_notification_rule_request import PatchedNotificationRuleRequest
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    pbm_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification Rule.
    patched_notification_rule_request = authentik_client.PatchedNotificationRuleRequest() # PatchedNotificationRuleRequest |  (optional)

    try:
        api_response = api_instance.events_rules_partial_update(pbm_uuid, patched_notification_rule_request=patched_notification_rule_request)
        print("The response of EventsApi->events_rules_partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_rules_partial_update: %s\n" % e)

Parameters

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

Return type

NotificationRule

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_rules_retrieve

NotificationRule events_rules_retrieve(pbm_uuid)

NotificationRule Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.notification_rule import NotificationRule
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    pbm_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification Rule.

    try:
        api_response = api_instance.events_rules_retrieve(pbm_uuid)
        print("The response of EventsApi->events_rules_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_rules_retrieve: %s\n" % e)

Parameters

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

Return type

NotificationRule

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_rules_update

NotificationRule events_rules_update(pbm_uuid, notification_rule_request)

NotificationRule Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.notification_rule import NotificationRule
from authentik_client.models.notification_rule_request import NotificationRuleRequest
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    pbm_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification Rule.
    notification_rule_request = authentik_client.NotificationRuleRequest() # NotificationRuleRequest | 

    try:
        api_response = api_instance.events_rules_update(pbm_uuid, notification_rule_request)
        print("The response of EventsApi->events_rules_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_rules_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
pbm_uuid	UUID	A UUID string identifying this Notification Rule.
notification_rule_request	NotificationRuleRequest

Return type

NotificationRule

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_rules_used_by_list

List[UsedBy] events_rules_used_by_list(pbm_uuid)

Get a list of all objects that use this object

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.used_by import UsedBy
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    pbm_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification Rule.

    try:
        api_response = api_instance.events_rules_used_by_list(pbm_uuid)
        print("The response of EventsApi->events_rules_used_by_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_rules_used_by_list: %s\n" % e)

Parameters

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

Return type

List[UsedBy]

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_transports_create

NotificationTransport events_transports_create(notification_transport_request)

NotificationTransport Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.notification_transport import NotificationTransport
from authentik_client.models.notification_transport_request import NotificationTransportRequest
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    notification_transport_request = authentik_client.NotificationTransportRequest() # NotificationTransportRequest | 

    try:
        api_response = api_instance.events_transports_create(notification_transport_request)
        print("The response of EventsApi->events_transports_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_transports_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
notification_transport_request	NotificationTransportRequest

Return type

NotificationTransport

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201		-
400		-
403		-

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

events_transports_destroy

events_transports_destroy(uuid)

NotificationTransport Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification Transport.

    try:
        api_instance.events_transports_destroy(uuid)
    except Exception as e:
        print("Exception when calling EventsApi->events_transports_destroy: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
204	No response body	-
400		-
403		-

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

events_transports_list

PaginatedNotificationTransportList events_transports_list(mode=mode, name=name, ordering=ordering, page=page, page_size=page_size, search=search, send_once=send_once, webhook_url=webhook_url)

NotificationTransport Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.paginated_notification_transport_list import PaginatedNotificationTransportList
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    mode = 'mode_example' # str |  (optional)
    name = 'name_example' # str |  (optional)
    ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional)
    page = 56 # int | A page number within the paginated result set. (optional)
    page_size = 56 # int | Number of results to return per page. (optional)
    search = 'search_example' # str | A search term. (optional)
    send_once = True # bool |  (optional)
    webhook_url = 'webhook_url_example' # str |  (optional)

    try:
        api_response = api_instance.events_transports_list(mode=mode, name=name, ordering=ordering, page=page, page_size=page_size, search=search, send_once=send_once, webhook_url=webhook_url)
        print("The response of EventsApi->events_transports_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_transports_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
mode	str		[optional]
name	str		[optional]
ordering	str	Which field to use when ordering the results.	[optional]
page	int	A page number within the paginated result set.	[optional]
page_size	int	Number of results to return per page.	[optional]
search	str	A search term.	[optional]
send_once	bool		[optional]
webhook_url	str		[optional]

Return type

PaginatedNotificationTransportList

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_transports_partial_update

NotificationTransport events_transports_partial_update(uuid, patched_notification_transport_request=patched_notification_transport_request)

NotificationTransport Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.notification_transport import NotificationTransport
from authentik_client.models.patched_notification_transport_request import PatchedNotificationTransportRequest
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification Transport.
    patched_notification_transport_request = authentik_client.PatchedNotificationTransportRequest() # PatchedNotificationTransportRequest |  (optional)

    try:
        api_response = api_instance.events_transports_partial_update(uuid, patched_notification_transport_request=patched_notification_transport_request)
        print("The response of EventsApi->events_transports_partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_transports_partial_update: %s\n" % e)

Parameters

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

Return type

NotificationTransport

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_transports_retrieve

NotificationTransport events_transports_retrieve(uuid)

NotificationTransport Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.notification_transport import NotificationTransport
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification Transport.

    try:
        api_response = api_instance.events_transports_retrieve(uuid)
        print("The response of EventsApi->events_transports_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_transports_retrieve: %s\n" % e)

Parameters

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

Return type

NotificationTransport

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_transports_test_create

NotificationTransportTest events_transports_test_create(uuid)

Send example notification using selected transport. Requires Modify permissions.

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.notification_transport_test import NotificationTransportTest
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification Transport.

    try:
        api_response = api_instance.events_transports_test_create(uuid)
        print("The response of EventsApi->events_transports_test_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_transports_test_create: %s\n" % e)

Parameters

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

Return type

NotificationTransportTest

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
500	Failed to test transport	-
400		-
403		-

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

events_transports_update

NotificationTransport events_transports_update(uuid, notification_transport_request)

NotificationTransport Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.notification_transport import NotificationTransport
from authentik_client.models.notification_transport_request import NotificationTransportRequest
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification Transport.
    notification_transport_request = authentik_client.NotificationTransportRequest() # NotificationTransportRequest | 

    try:
        api_response = api_instance.events_transports_update(uuid, notification_transport_request)
        print("The response of EventsApi->events_transports_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_transports_update: %s\n" % e)

Parameters

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

Return type

NotificationTransport

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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

events_transports_used_by_list

List[UsedBy] events_transports_used_by_list(uuid)

Get a list of all objects that use this object

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.used_by import UsedBy
from authentik_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v3
# See configuration.py for a list of all supported configuration parameters.
configuration = authentik_client.Configuration(
    host = "/api/v3"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: authentik
configuration = authentik_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with authentik_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = authentik_client.EventsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Notification Transport.

    try:
        api_response = api_instance.events_transports_used_by_list(uuid)
        print("The response of EventsApi->events_transports_used_by_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EventsApi->events_transports_used_by_list: %s\n" % e)

Parameters

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

Return type

List[UsedBy]

Authorization

authentik

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
400		-
403		-

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