OutpostsApi.md

authentik_client.OutpostsApi

All URIs are relative to /api/v3

Method	HTTP request	Description
outposts_instances_create	POST /outposts/instances/
outposts_instances_default_settings_retrieve	GET /outposts/instances/default_settings/
outposts_instances_destroy	DELETE /outposts/instances/{uuid}/
outposts_instances_health_list	GET /outposts/instances/{uuid}/health/
outposts_instances_list	GET /outposts/instances/
outposts_instances_partial_update	PATCH /outposts/instances/{uuid}/
outposts_instances_retrieve	GET /outposts/instances/{uuid}/
outposts_instances_update	PUT /outposts/instances/{uuid}/
outposts_instances_used_by_list	GET /outposts/instances/{uuid}/used_by/
outposts_ldap_access_check	GET /outposts/ldap/{id}/check_access/
outposts_ldap_list	GET /outposts/ldap/
outposts_proxy_list	GET /outposts/proxy/
outposts_radius_access_check	GET /outposts/radius/{id}/check_access/
outposts_radius_list	GET /outposts/radius/
outposts_service_connections_all_destroy	DELETE /outposts/service_connections/all/{uuid}/
outposts_service_connections_all_list	GET /outposts/service_connections/all/
outposts_service_connections_all_retrieve	GET /outposts/service_connections/all/{uuid}/
outposts_service_connections_all_state_retrieve	GET /outposts/service_connections/all/{uuid}/state/
outposts_service_connections_all_types_list	GET /outposts/service_connections/all/types/
outposts_service_connections_all_used_by_list	GET /outposts/service_connections/all/{uuid}/used_by/
outposts_service_connections_docker_create	POST /outposts/service_connections/docker/
outposts_service_connections_docker_destroy	DELETE /outposts/service_connections/docker/{uuid}/
outposts_service_connections_docker_list	GET /outposts/service_connections/docker/
outposts_service_connections_docker_partial_update	PATCH /outposts/service_connections/docker/{uuid}/
outposts_service_connections_docker_retrieve	GET /outposts/service_connections/docker/{uuid}/
outposts_service_connections_docker_update	PUT /outposts/service_connections/docker/{uuid}/
outposts_service_connections_docker_used_by_list	GET /outposts/service_connections/docker/{uuid}/used_by/
outposts_service_connections_kubernetes_create	POST /outposts/service_connections/kubernetes/
outposts_service_connections_kubernetes_destroy	DELETE /outposts/service_connections/kubernetes/{uuid}/
outposts_service_connections_kubernetes_list	GET /outposts/service_connections/kubernetes/
outposts_service_connections_kubernetes_partial_update	PATCH /outposts/service_connections/kubernetes/{uuid}/
outposts_service_connections_kubernetes_retrieve	GET /outposts/service_connections/kubernetes/{uuid}/
outposts_service_connections_kubernetes_update	PUT /outposts/service_connections/kubernetes/{uuid}/
outposts_service_connections_kubernetes_used_by_list	GET /outposts/service_connections/kubernetes/{uuid}/used_by/

outposts_instances_create

Outpost outposts_instances_create(outpost_request)

Outpost Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.outpost import Outpost
from authentik_client.models.outpost_request import OutpostRequest
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.OutpostsApi(api_client)
    outpost_request = authentik_client.OutpostRequest() # OutpostRequest | 

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

Parameters

Name	Type	Description	Notes
outpost_request	OutpostRequest

Return type

Outpost

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]

outposts_instances_default_settings_retrieve

OutpostDefaultConfig outposts_instances_default_settings_retrieve()

Global default outpost config

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.outpost_default_config import OutpostDefaultConfig
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.OutpostsApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

OutpostDefaultConfig

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]

outposts_instances_destroy

outposts_instances_destroy(uuid)

Outpost 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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Outpost.

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

Parameters

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

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]

outposts_instances_health_list

List[OutpostHealth] outposts_instances_health_list(uuid, managed__icontains=managed__icontains, managed__iexact=managed__iexact, name__icontains=name__icontains, name__iexact=name__iexact, ordering=ordering, providers__isnull=providers__isnull, providers_by_pk=providers_by_pk, search=search, service_connection__name__icontains=service_connection__name__icontains, service_connection__name__iexact=service_connection__name__iexact)

Get outposts current health

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.outpost_health import OutpostHealth
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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Outpost.
    managed__icontains = 'managed__icontains_example' # str |  (optional)
    managed__iexact = 'managed__iexact_example' # str |  (optional)
    name__icontains = 'name__icontains_example' # str |  (optional)
    name__iexact = 'name__iexact_example' # str |  (optional)
    ordering = 'ordering_example' # str | Which field to use when ordering the results. (optional)
    providers__isnull = True # bool |  (optional)
    providers_by_pk = [56] # List[int] |  (optional)
    search = 'search_example' # str | A search term. (optional)
    service_connection__name__icontains = 'service_connection__name__icontains_example' # str |  (optional)
    service_connection__name__iexact = 'service_connection__name__iexact_example' # str |  (optional)

    try:
        api_response = api_instance.outposts_instances_health_list(uuid, managed__icontains=managed__icontains, managed__iexact=managed__iexact, name__icontains=name__icontains, name__iexact=name__iexact, ordering=ordering, providers__isnull=providers__isnull, providers_by_pk=providers_by_pk, search=search, service_connection__name__icontains=service_connection__name__icontains, service_connection__name__iexact=service_connection__name__iexact)
        print("The response of OutpostsApi->outposts_instances_health_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OutpostsApi->outposts_instances_health_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost.
managed__icontains	str		[optional]
managed__iexact	str		[optional]
name__icontains	str		[optional]
name__iexact	str		[optional]
ordering	str	Which field to use when ordering the results.	[optional]
providers__isnull	bool		[optional]
providers_by_pk	List[int]		[optional]
search	str	A search term.	[optional]
service_connection__name__icontains	str		[optional]
service_connection__name__iexact	str		[optional]

Return type

List[OutpostHealth]

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]

outposts_instances_list

PaginatedOutpostList outposts_instances_list(managed__icontains=managed__icontains, managed__iexact=managed__iexact, name__icontains=name__icontains, name__iexact=name__iexact, ordering=ordering, page=page, page_size=page_size, providers__isnull=providers__isnull, providers_by_pk=providers_by_pk, search=search, service_connection__name__icontains=service_connection__name__icontains, service_connection__name__iexact=service_connection__name__iexact)

Outpost Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.paginated_outpost_list import PaginatedOutpostList
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.OutpostsApi(api_client)
    managed__icontains = 'managed__icontains_example' # str |  (optional)
    managed__iexact = 'managed__iexact_example' # str |  (optional)
    name__icontains = 'name__icontains_example' # str |  (optional)
    name__iexact = 'name__iexact_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)
    providers__isnull = True # bool |  (optional)
    providers_by_pk = [56] # List[int] |  (optional)
    search = 'search_example' # str | A search term. (optional)
    service_connection__name__icontains = 'service_connection__name__icontains_example' # str |  (optional)
    service_connection__name__iexact = 'service_connection__name__iexact_example' # str |  (optional)

    try:
        api_response = api_instance.outposts_instances_list(managed__icontains=managed__icontains, managed__iexact=managed__iexact, name__icontains=name__icontains, name__iexact=name__iexact, ordering=ordering, page=page, page_size=page_size, providers__isnull=providers__isnull, providers_by_pk=providers_by_pk, search=search, service_connection__name__icontains=service_connection__name__icontains, service_connection__name__iexact=service_connection__name__iexact)
        print("The response of OutpostsApi->outposts_instances_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OutpostsApi->outposts_instances_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
managed__icontains	str		[optional]
managed__iexact	str		[optional]
name__icontains	str		[optional]
name__iexact	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]
providers__isnull	bool		[optional]
providers_by_pk	List[int]		[optional]
search	str	A search term.	[optional]
service_connection__name__icontains	str		[optional]
service_connection__name__iexact	str		[optional]

Return type

PaginatedOutpostList

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]

outposts_instances_partial_update

Outpost outposts_instances_partial_update(uuid, patched_outpost_request=patched_outpost_request)

Outpost Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.outpost import Outpost
from authentik_client.models.patched_outpost_request import PatchedOutpostRequest
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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Outpost.
    patched_outpost_request = authentik_client.PatchedOutpostRequest() # PatchedOutpostRequest |  (optional)

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost.
patched_outpost_request	PatchedOutpostRequest		[optional]

Return type

Outpost

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]

outposts_instances_retrieve

Outpost outposts_instances_retrieve(uuid)

Outpost Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.outpost import Outpost
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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Outpost.

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

Parameters

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

Return type

Outpost

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]

outposts_instances_update

Outpost outposts_instances_update(uuid, outpost_request)

Outpost Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.outpost import Outpost
from authentik_client.models.outpost_request import OutpostRequest
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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Outpost.
    outpost_request = authentik_client.OutpostRequest() # OutpostRequest | 

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost.
outpost_request	OutpostRequest

Return type

Outpost

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]

outposts_instances_used_by_list

List[UsedBy] outposts_instances_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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Outpost.

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

Parameters

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

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]

outposts_ldap_access_check

LDAPCheckAccess outposts_ldap_access_check(id, app_slug=app_slug)

Check access to a single application by slug

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.ldap_check_access import LDAPCheckAccess
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.OutpostsApi(api_client)
    id = 56 # int | A unique integer value identifying this LDAP Provider.
    app_slug = 'app_slug_example' # str |  (optional)

    try:
        api_response = api_instance.outposts_ldap_access_check(id, app_slug=app_slug)
        print("The response of OutpostsApi->outposts_ldap_access_check:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OutpostsApi->outposts_ldap_access_check: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this LDAP Provider.
app_slug	str		[optional]

Return type

LDAPCheckAccess

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]

outposts_ldap_list

PaginatedLDAPOutpostConfigList outposts_ldap_list(name=name, ordering=ordering, page=page, page_size=page_size, search=search)

LDAPProvider Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.paginated_ldap_outpost_config_list import PaginatedLDAPOutpostConfigList
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.OutpostsApi(api_client)
    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)

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

Parameters

Name	Type	Description	Notes
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]

Return type

PaginatedLDAPOutpostConfigList

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]

outposts_proxy_list

PaginatedProxyOutpostConfigList outposts_proxy_list(name=name, ordering=ordering, page=page, page_size=page_size, search=search)

ProxyProvider Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.paginated_proxy_outpost_config_list import PaginatedProxyOutpostConfigList
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.OutpostsApi(api_client)
    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)

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

Parameters

Name	Type	Description	Notes
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]

Return type

PaginatedProxyOutpostConfigList

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]

outposts_radius_access_check

RadiusCheckAccess outposts_radius_access_check(id, app_slug=app_slug)

Check access to a single application by slug

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.radius_check_access import RadiusCheckAccess
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.OutpostsApi(api_client)
    id = 56 # int | A unique integer value identifying this Radius Provider.
    app_slug = 'app_slug_example' # str |  (optional)

    try:
        api_response = api_instance.outposts_radius_access_check(id, app_slug=app_slug)
        print("The response of OutpostsApi->outposts_radius_access_check:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OutpostsApi->outposts_radius_access_check: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this Radius Provider.
app_slug	str		[optional]

Return type

RadiusCheckAccess

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]

outposts_radius_list

PaginatedRadiusOutpostConfigList outposts_radius_list(name=name, ordering=ordering, page=page, page_size=page_size, search=search)

RadiusProvider Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.paginated_radius_outpost_config_list import PaginatedRadiusOutpostConfigList
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.OutpostsApi(api_client)
    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)

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

Parameters

Name	Type	Description	Notes
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]

Return type

PaginatedRadiusOutpostConfigList

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]

outposts_service_connections_all_destroy

outposts_service_connections_all_destroy(uuid)

ServiceConnection 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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Outpost Service-Connection.

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost Service-Connection.

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]

outposts_service_connections_all_list

PaginatedServiceConnectionList outposts_service_connections_all_list(name=name, ordering=ordering, page=page, page_size=page_size, search=search)

ServiceConnection Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.paginated_service_connection_list import PaginatedServiceConnectionList
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.OutpostsApi(api_client)
    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)

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

Parameters

Name	Type	Description	Notes
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]

Return type

PaginatedServiceConnectionList

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]

outposts_service_connections_all_retrieve

ServiceConnection outposts_service_connections_all_retrieve(uuid)

ServiceConnection Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.service_connection import ServiceConnection
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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Outpost Service-Connection.

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost Service-Connection.

Return type

ServiceConnection

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]

outposts_service_connections_all_state_retrieve

ServiceConnectionState outposts_service_connections_all_state_retrieve(uuid)

Get the service connection's state

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.service_connection_state import ServiceConnectionState
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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Outpost Service-Connection.

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost Service-Connection.

Return type

ServiceConnectionState

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]

outposts_service_connections_all_types_list

List[TypeCreate] outposts_service_connections_all_types_list()

Get all creatable types

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.OutpostsApi(api_client)

    try:
        api_response = api_instance.outposts_service_connections_all_types_list()
        print("The response of OutpostsApi->outposts_service_connections_all_types_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OutpostsApi->outposts_service_connections_all_types_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]

outposts_service_connections_all_used_by_list

List[UsedBy] outposts_service_connections_all_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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Outpost Service-Connection.

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Outpost Service-Connection.

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]

outposts_service_connections_docker_create

DockerServiceConnection outposts_service_connections_docker_create(docker_service_connection_request)

DockerServiceConnection Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.docker_service_connection import DockerServiceConnection
from authentik_client.models.docker_service_connection_request import DockerServiceConnectionRequest
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.OutpostsApi(api_client)
    docker_service_connection_request = authentik_client.DockerServiceConnectionRequest() # DockerServiceConnectionRequest | 

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

Parameters

Name	Type	Description	Notes
docker_service_connection_request	DockerServiceConnectionRequest

Return type

DockerServiceConnection

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]

outposts_service_connections_docker_destroy

outposts_service_connections_docker_destroy(uuid)

DockerServiceConnection 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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Docker Service-Connection.

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Docker Service-Connection.

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]

outposts_service_connections_docker_list

PaginatedDockerServiceConnectionList outposts_service_connections_docker_list(local=local, name=name, ordering=ordering, page=page, page_size=page_size, search=search, tls_authentication=tls_authentication, tls_verification=tls_verification, url=url)

DockerServiceConnection Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.paginated_docker_service_connection_list import PaginatedDockerServiceConnectionList
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.OutpostsApi(api_client)
    local = True # bool |  (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)
    tls_authentication = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |  (optional)
    tls_verification = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID |  (optional)
    url = 'url_example' # str |  (optional)

    try:
        api_response = api_instance.outposts_service_connections_docker_list(local=local, name=name, ordering=ordering, page=page, page_size=page_size, search=search, tls_authentication=tls_authentication, tls_verification=tls_verification, url=url)
        print("The response of OutpostsApi->outposts_service_connections_docker_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OutpostsApi->outposts_service_connections_docker_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
local	bool		[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]
tls_authentication	UUID		[optional]
tls_verification	UUID		[optional]
url	str		[optional]

Return type

PaginatedDockerServiceConnectionList

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]

outposts_service_connections_docker_partial_update

DockerServiceConnection outposts_service_connections_docker_partial_update(uuid, patched_docker_service_connection_request=patched_docker_service_connection_request)

DockerServiceConnection Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.docker_service_connection import DockerServiceConnection
from authentik_client.models.patched_docker_service_connection_request import PatchedDockerServiceConnectionRequest
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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Docker Service-Connection.
    patched_docker_service_connection_request = authentik_client.PatchedDockerServiceConnectionRequest() # PatchedDockerServiceConnectionRequest |  (optional)

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Docker Service-Connection.
patched_docker_service_connection_request	PatchedDockerServiceConnectionRequest		[optional]

Return type

DockerServiceConnection

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]

outposts_service_connections_docker_retrieve

DockerServiceConnection outposts_service_connections_docker_retrieve(uuid)

DockerServiceConnection Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.docker_service_connection import DockerServiceConnection
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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Docker Service-Connection.

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Docker Service-Connection.

Return type

DockerServiceConnection

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]

outposts_service_connections_docker_update

DockerServiceConnection outposts_service_connections_docker_update(uuid, docker_service_connection_request)

DockerServiceConnection Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.docker_service_connection import DockerServiceConnection
from authentik_client.models.docker_service_connection_request import DockerServiceConnectionRequest
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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Docker Service-Connection.
    docker_service_connection_request = authentik_client.DockerServiceConnectionRequest() # DockerServiceConnectionRequest | 

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Docker Service-Connection.
docker_service_connection_request	DockerServiceConnectionRequest

Return type

DockerServiceConnection

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]

outposts_service_connections_docker_used_by_list

List[UsedBy] outposts_service_connections_docker_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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Docker Service-Connection.

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Docker Service-Connection.

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]

outposts_service_connections_kubernetes_create

KubernetesServiceConnection outposts_service_connections_kubernetes_create(kubernetes_service_connection_request)

KubernetesServiceConnection Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.kubernetes_service_connection import KubernetesServiceConnection
from authentik_client.models.kubernetes_service_connection_request import KubernetesServiceConnectionRequest
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.OutpostsApi(api_client)
    kubernetes_service_connection_request = authentik_client.KubernetesServiceConnectionRequest() # KubernetesServiceConnectionRequest | 

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

Parameters

Name	Type	Description	Notes
kubernetes_service_connection_request	KubernetesServiceConnectionRequest

Return type

KubernetesServiceConnection

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]

outposts_service_connections_kubernetes_destroy

outposts_service_connections_kubernetes_destroy(uuid)

KubernetesServiceConnection 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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Kubernetes Service-Connection.

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Kubernetes Service-Connection.

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]

outposts_service_connections_kubernetes_list

PaginatedKubernetesServiceConnectionList outposts_service_connections_kubernetes_list(local=local, name=name, ordering=ordering, page=page, page_size=page_size, search=search)

KubernetesServiceConnection Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.paginated_kubernetes_service_connection_list import PaginatedKubernetesServiceConnectionList
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.OutpostsApi(api_client)
    local = True # bool |  (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)

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

Parameters

Name	Type	Description	Notes
local	bool		[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]

Return type

PaginatedKubernetesServiceConnectionList

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]

outposts_service_connections_kubernetes_partial_update

KubernetesServiceConnection outposts_service_connections_kubernetes_partial_update(uuid, patched_kubernetes_service_connection_request=patched_kubernetes_service_connection_request)

KubernetesServiceConnection Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.kubernetes_service_connection import KubernetesServiceConnection
from authentik_client.models.patched_kubernetes_service_connection_request import PatchedKubernetesServiceConnectionRequest
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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Kubernetes Service-Connection.
    patched_kubernetes_service_connection_request = authentik_client.PatchedKubernetesServiceConnectionRequest() # PatchedKubernetesServiceConnectionRequest |  (optional)

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Kubernetes Service-Connection.
patched_kubernetes_service_connection_request	PatchedKubernetesServiceConnectionRequest		[optional]

Return type

KubernetesServiceConnection

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]

outposts_service_connections_kubernetes_retrieve

KubernetesServiceConnection outposts_service_connections_kubernetes_retrieve(uuid)

KubernetesServiceConnection Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.kubernetes_service_connection import KubernetesServiceConnection
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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Kubernetes Service-Connection.

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Kubernetes Service-Connection.

Return type

KubernetesServiceConnection

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]

outposts_service_connections_kubernetes_update

KubernetesServiceConnection outposts_service_connections_kubernetes_update(uuid, kubernetes_service_connection_request)

KubernetesServiceConnection Viewset

Example

• Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.kubernetes_service_connection import KubernetesServiceConnection
from authentik_client.models.kubernetes_service_connection_request import KubernetesServiceConnectionRequest
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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Kubernetes Service-Connection.
    kubernetes_service_connection_request = authentik_client.KubernetesServiceConnectionRequest() # KubernetesServiceConnectionRequest | 

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Kubernetes Service-Connection.
kubernetes_service_connection_request	KubernetesServiceConnectionRequest

Return type

KubernetesServiceConnection

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]

outposts_service_connections_kubernetes_used_by_list

List[UsedBy] outposts_service_connections_kubernetes_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.OutpostsApi(api_client)
    uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Kubernetes Service-Connection.

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

Parameters

Name	Type	Description	Notes
uuid	UUID	A UUID string identifying this Kubernetes Service-Connection.

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]