authentik_client.ManagedApi

All URIs are relative to /api/v3

Method	HTTP request	Description
managed_blueprints_apply_create	POST /managed/blueprints/{instance_uuid}/apply/
managed_blueprints_available_list	GET /managed/blueprints/available/
managed_blueprints_create	POST /managed/blueprints/
managed_blueprints_destroy	DELETE /managed/blueprints/{instance_uuid}/
managed_blueprints_list	GET /managed/blueprints/
managed_blueprints_partial_update	PATCH /managed/blueprints/{instance_uuid}/
managed_blueprints_retrieve	GET /managed/blueprints/{instance_uuid}/
managed_blueprints_update	PUT /managed/blueprints/{instance_uuid}/
managed_blueprints_used_by_list	GET /managed/blueprints/{instance_uuid}/used_by/

managed_blueprints_apply_create

BlueprintInstance managed_blueprints_apply_create(instance_uuid)

Apply a blueprint

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.blueprint_instance import BlueprintInstance
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.ManagedApi(api_client)
    instance_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Blueprint Instance.

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

Parameters

Name	Type	Description	Notes
instance_uuid	UUID	A UUID string identifying this Blueprint Instance.

Return type

BlueprintInstance

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]

managed_blueprints_available_list

List[BlueprintFile] managed_blueprints_available_list()

Get blueprints

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.blueprint_file import BlueprintFile
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.ManagedApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

List[BlueprintFile]

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]

managed_blueprints_create

BlueprintInstance managed_blueprints_create(blueprint_instance_request)

Blueprint instances

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.blueprint_instance import BlueprintInstance
from authentik_client.models.blueprint_instance_request import BlueprintInstanceRequest
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.ManagedApi(api_client)
    blueprint_instance_request = authentik_client.BlueprintInstanceRequest() # BlueprintInstanceRequest | 

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

Parameters

Name	Type	Description	Notes
blueprint_instance_request	BlueprintInstanceRequest

Return type

BlueprintInstance

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]

managed_blueprints_destroy

managed_blueprints_destroy(instance_uuid)

Blueprint instances

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

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

Parameters

Name	Type	Description	Notes
instance_uuid	UUID	A UUID string identifying this Blueprint Instance.

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]

managed_blueprints_list

PaginatedBlueprintInstanceList managed_blueprints_list(name=name, ordering=ordering, page=page, page_size=page_size, path=path, search=search)

Blueprint instances

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.paginated_blueprint_instance_list import PaginatedBlueprintInstanceList
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.ManagedApi(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)
    path = 'path_example' # str |  (optional)
    search = 'search_example' # str | A search term. (optional)

    try:
        api_response = api_instance.managed_blueprints_list(name=name, ordering=ordering, page=page, page_size=page_size, path=path, search=search)
        print("The response of ManagedApi->managed_blueprints_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ManagedApi->managed_blueprints_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]
path	str		[optional]
search	str	A search term.	[optional]

Return type

PaginatedBlueprintInstanceList

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]

managed_blueprints_partial_update

BlueprintInstance managed_blueprints_partial_update(instance_uuid, patched_blueprint_instance_request=patched_blueprint_instance_request)

Blueprint instances

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.blueprint_instance import BlueprintInstance
from authentik_client.models.patched_blueprint_instance_request import PatchedBlueprintInstanceRequest
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.ManagedApi(api_client)
    instance_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Blueprint Instance.
    patched_blueprint_instance_request = authentik_client.PatchedBlueprintInstanceRequest() # PatchedBlueprintInstanceRequest |  (optional)

    try:
        api_response = api_instance.managed_blueprints_partial_update(instance_uuid, patched_blueprint_instance_request=patched_blueprint_instance_request)
        print("The response of ManagedApi->managed_blueprints_partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ManagedApi->managed_blueprints_partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
instance_uuid	UUID	A UUID string identifying this Blueprint Instance.
patched_blueprint_instance_request	PatchedBlueprintInstanceRequest		[optional]

Return type

BlueprintInstance

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]

managed_blueprints_retrieve

BlueprintInstance managed_blueprints_retrieve(instance_uuid)

Blueprint instances

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.blueprint_instance import BlueprintInstance
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.ManagedApi(api_client)
    instance_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Blueprint Instance.

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

Parameters

Name	Type	Description	Notes
instance_uuid	UUID	A UUID string identifying this Blueprint Instance.

Return type

BlueprintInstance

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]

managed_blueprints_update

BlueprintInstance managed_blueprints_update(instance_uuid, blueprint_instance_request)

Blueprint instances

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.blueprint_instance import BlueprintInstance
from authentik_client.models.blueprint_instance_request import BlueprintInstanceRequest
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.ManagedApi(api_client)
    instance_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Blueprint Instance.
    blueprint_instance_request = authentik_client.BlueprintInstanceRequest() # BlueprintInstanceRequest | 

    try:
        api_response = api_instance.managed_blueprints_update(instance_uuid, blueprint_instance_request)
        print("The response of ManagedApi->managed_blueprints_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ManagedApi->managed_blueprints_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
instance_uuid	UUID	A UUID string identifying this Blueprint Instance.
blueprint_instance_request	BlueprintInstanceRequest

Return type

BlueprintInstance

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]

managed_blueprints_used_by_list

List[UsedBy] managed_blueprints_used_by_list(instance_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.ManagedApi(api_client)
    instance_uuid = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this Blueprint Instance.

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

Parameters

Name	Type	Description	Notes
instance_uuid	UUID	A UUID string identifying this Blueprint Instance.

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]

FilesExpand file tree

ManagedApi.md

Latest commit

History

ManagedApi.md

File metadata and controls

authentik_client.ManagedApi

managed_blueprints_apply_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

managed_blueprints_available_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

managed_blueprints_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

managed_blueprints_destroy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

managed_blueprints_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

managed_blueprints_partial_update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

managed_blueprints_retrieve

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

managed_blueprints_update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

managed_blueprints_used_by_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details