authentik_client.LifecycleApi

All URIs are relative to /api/v3

Method	HTTP request	Description
lifecycle_iterations_create	POST /lifecycle/iterations/
lifecycle_iterations_latest_retrieve	GET /lifecycle/iterations/latest/{content_type}/{object_id}/
lifecycle_iterations_list_open	GET /lifecycle/iterations/open/
lifecycle_reviews_create	POST /lifecycle/reviews/
lifecycle_rules_create	POST /lifecycle/rules/
lifecycle_rules_destroy	DELETE /lifecycle/rules/{id}/
lifecycle_rules_list	GET /lifecycle/rules/
lifecycle_rules_partial_update	PATCH /lifecycle/rules/{id}/
lifecycle_rules_retrieve	GET /lifecycle/rules/{id}/
lifecycle_rules_update	PUT /lifecycle/rules/{id}/

lifecycle_iterations_create

LifecycleIteration lifecycle_iterations_create(lifecycle_iteration_request)

Mixin to validate that a valid enterprise license exists before allowing to save the object

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.lifecycle_iteration import LifecycleIteration
from authentik_client.models.lifecycle_iteration_request import LifecycleIterationRequest
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.LifecycleApi(api_client)
    lifecycle_iteration_request = authentik_client.LifecycleIterationRequest() # LifecycleIterationRequest | 

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

Parameters

Name	Type	Description	Notes
lifecycle_iteration_request	LifecycleIterationRequest

Return type

LifecycleIteration

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]

lifecycle_iterations_latest_retrieve

LifecycleIteration lifecycle_iterations_latest_retrieve(content_type, object_id)

Mixin to validate that a valid enterprise license exists before allowing to save the object

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.lifecycle_iteration import LifecycleIteration
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.LifecycleApi(api_client)
    content_type = 'content_type_example' # str | 
    object_id = 'object_id_example' # str | 

    try:
        api_response = api_instance.lifecycle_iterations_latest_retrieve(content_type, object_id)
        print("The response of LifecycleApi->lifecycle_iterations_latest_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LifecycleApi->lifecycle_iterations_latest_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
content_type	str
object_id	str

Return type

LifecycleIteration

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]

lifecycle_iterations_list_open

PaginatedLifecycleIterationList lifecycle_iterations_list_open(ordering=ordering, page=page, page_size=page_size, search=search, user_is_reviewer=user_is_reviewer)

Mixin to validate that a valid enterprise license exists before allowing to save the object

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.paginated_lifecycle_iteration_list import PaginatedLifecycleIterationList
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.LifecycleApi(api_client)
    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)
    user_is_reviewer = True # bool |  (optional)

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

Parameters

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

Return type

PaginatedLifecycleIterationList

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]

lifecycle_reviews_create

Review lifecycle_reviews_create(review_request)

Mixin to validate that a valid enterprise license exists before allowing to save the object

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.review import Review
from authentik_client.models.review_request import ReviewRequest
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.LifecycleApi(api_client)
    review_request = authentik_client.ReviewRequest() # ReviewRequest | 

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

Parameters

Name	Type	Description	Notes
review_request	ReviewRequest

Return type

Review

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]

lifecycle_rules_create

LifecycleRule lifecycle_rules_create(lifecycle_rule_request)

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.lifecycle_rule import LifecycleRule
from authentik_client.models.lifecycle_rule_request import LifecycleRuleRequest
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.LifecycleApi(api_client)
    lifecycle_rule_request = authentik_client.LifecycleRuleRequest() # LifecycleRuleRequest | 

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

Parameters

Name	Type	Description	Notes
lifecycle_rule_request	LifecycleRuleRequest

Return type

LifecycleRule

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]

lifecycle_rules_destroy

lifecycle_rules_destroy(id)

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

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

Parameters

Name	Type	Description	Notes
id	UUID	A UUID string identifying this lifecycle rule.

Return type

void (empty response body)

Authorization

authentik

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

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

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

lifecycle_rules_list

PaginatedLifecycleRuleList lifecycle_rules_list(content_type__model=content_type__model, ordering=ordering, page=page, page_size=page_size, search=search)

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.paginated_lifecycle_rule_list import PaginatedLifecycleRuleList
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.LifecycleApi(api_client)
    content_type__model = 'content_type__model_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.lifecycle_rules_list(content_type__model=content_type__model, ordering=ordering, page=page, page_size=page_size, search=search)
        print("The response of LifecycleApi->lifecycle_rules_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling LifecycleApi->lifecycle_rules_list: %s\n" % e)

Parameters

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

PaginatedLifecycleRuleList

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]

lifecycle_rules_partial_update

LifecycleRule lifecycle_rules_partial_update(id, patched_lifecycle_rule_request=patched_lifecycle_rule_request)

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.lifecycle_rule import LifecycleRule
from authentik_client.models.patched_lifecycle_rule_request import PatchedLifecycleRuleRequest
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.LifecycleApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this lifecycle rule.
    patched_lifecycle_rule_request = authentik_client.PatchedLifecycleRuleRequest() # PatchedLifecycleRuleRequest |  (optional)

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

Parameters

Name	Type	Description	Notes
id	UUID	A UUID string identifying this lifecycle rule.
patched_lifecycle_rule_request	PatchedLifecycleRuleRequest		[optional]

Return type

LifecycleRule

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]

lifecycle_rules_retrieve

LifecycleRule lifecycle_rules_retrieve(id)

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.lifecycle_rule import LifecycleRule
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.LifecycleApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this lifecycle rule.

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

Parameters

Name	Type	Description	Notes
id	UUID	A UUID string identifying this lifecycle rule.

Return type

LifecycleRule

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]

lifecycle_rules_update

LifecycleRule lifecycle_rules_update(id, lifecycle_rule_request)

Example

Bearer Authentication (authentik):

import authentik_client
from authentik_client.models.lifecycle_rule import LifecycleRule
from authentik_client.models.lifecycle_rule_request import LifecycleRuleRequest
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.LifecycleApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | A UUID string identifying this lifecycle rule.
    lifecycle_rule_request = authentik_client.LifecycleRuleRequest() # LifecycleRuleRequest | 

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

Parameters

Name	Type	Description	Notes
id	UUID	A UUID string identifying this lifecycle rule.
lifecycle_rule_request	LifecycleRuleRequest

Return type

LifecycleRule

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]

FilesExpand file tree

LifecycleApi.md

Latest commit

History

LifecycleApi.md

File metadata and controls

authentik_client.LifecycleApi

lifecycle_iterations_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lifecycle_iterations_latest_retrieve

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lifecycle_iterations_list_open

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lifecycle_reviews_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lifecycle_rules_create

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lifecycle_rules_destroy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lifecycle_rules_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lifecycle_rules_partial_update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lifecycle_rules_retrieve

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

lifecycle_rules_update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details