SchemaApi.md

authentik_client.SchemaApi

All URIs are relative to /api/v3

Method	HTTP request	Description
schema_retrieve	GET /schema/

schema_retrieve

Dict[str, object] schema_retrieve(format=format, lang=lang)

OpenApi3 schema for this API. Format can be selected via content negotiation.

• YAML: application/vnd.oai.openapi
• JSON: application/vnd.oai.openapi+json

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.SchemaApi(api_client)
    format = 'format_example' # str |  (optional)
    lang = 'lang_example' # str |  (optional)

    try:
        api_response = api_instance.schema_retrieve(format=format, lang=lang)
        print("The response of SchemaApi->schema_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SchemaApi->schema_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
format	str		[optional]
lang	str		[optional]

Return type

Dict[str, object]

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.oai.openapi, application/yaml, application/vnd.oai.openapi+json, 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]