Skip to content

Releases: goauthentik/client-python

2025.10.1

03 Nov 17:22

Choose a tag to compare

version/2025.10.1

Version 2025.10.1

2025.10.0

27 Oct 20:22

Choose a tag to compare

version/2025.10.0

Version 2025.10.0

2025.10.0-rc3

21 Oct 14:22

Choose a tag to compare

version/2025.10.0-rc3

Version 2025.10.0-rc3

v2025.10.0-rc1-1760140185: -e Update API Client

10 Oct 23:50

Choose a tag to compare

-e Update API Client

What's Changed


GET /root/config/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New optional properties:

    • cache_timeout_reputation
    • Deleted property cache_timeout_reputation (integer)

v2025.10.0-rc1-1760107121: -e Update API Client

10 Oct 14:39

Choose a tag to compare

-e Update API Client

What's Changed


GET /tasks/tasks/{message_id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • logs
    • previous_logs

    New optional properties:

    • messages
    • previous_messages
    • Added property logs (array)

      Items (object):
      > Single log message with all context logged.

      • Property timestamp (string)

      • Property log_level (string)

        Enum values:

        • critical
        • exception
        • error
        • warn
        • warning
        • info
        • debug
        • notset
      • Property logger (string)

      • Property event (string)

      • Property attributes (object)

    • Added property previous_logs (array)

    • Deleted property messages (array)

    • Deleted property previous_messages (array)

GET /tasks/tasks/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):

      New required properties:

      • logs
      • previous_logs

      New optional properties:

      • messages
      • previous_messages
      • Added property logs (array)

      • Added property previous_logs (array)

      • Deleted property messages (array)

      • Deleted property previous_messages (array)

v2025.10.0-rc1-1760098401: -e Update API Client

10 Oct 12:13

Choose a tag to compare

-e Update API Client

What's Changed


GET /providers/saml/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property sls_url (string)

      Single Logout Service URL where the logout response should be sent.

    • Added property sign_logout_request (boolean)

    • Added property sls_binding (object)

      This determines how authentik sends the logout response back to the Service Provider.

      Enum values:

      • redirect
      • post
    • Added property logout_method (object)

      Method to use for logout. Front-channel iframe loads all logout URLs simultaneously in hidden iframes. Front-channel native uses your active browser tab to send post requests and redirect to providers. Back-channel sends logout requests directly from the server without user interaction (requires POST SLS binding).

      Enum values:

      • frontchannel_iframe
      • frontchannel_native
      • backchannel
PUT /providers/saml/{id}/
Request:

Changed content type : application/json

  • Added property sls_url (string)

    Single Logout Service URL where the logout response should be sent.

  • Added property sign_logout_request (boolean)

  • Added property sls_binding (object)

    This determines how authentik sends the logout response back to the Service Provider.

  • Added property logout_method (object)

    Method to use for logout. Front-channel iframe loads all logout URLs simultaneously in hidden iframes. Front-channel native uses your active browser tab to send post requests and redirect to providers. Back-channel sends logout requests directly from the server without user interaction (requires POST SLS binding).

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property sls_url (string)

      Single Logout Service URL where the logout response should be sent.

    • Added property sign_logout_request (boolean)

    • Added property sls_binding (object)

      This determines how authentik sends the logout response back to the Service Provider.

    • Added property logout_method (object)

      Method to use for logout. Front-channel iframe loads all logout URLs simultaneously in hidden iframes. Front-channel native uses your active browser tab to send post requests and redirect to providers. Back-channel sends logout requests directly from the server without user interaction (requires POST SLS binding).

PATCH /providers/saml/{id}/
Request:

Changed content type : application/json

  • Added property sls_url (string)

    Single Logout Service URL where the logout response should be sent.

  • Added property sign_logout_request (boolean)

  • Added property sls_binding (object)

    This determines how authentik sends the logout response back to the Service Provider.

  • Added property logout_method (object)

    Method to use for logout. Front-channel iframe loads all logout URLs simultaneously in hidden iframes. Front-channel native uses your active browser tab to send post requests and redirect to providers. Back-channel sends logout requests directly from the server without user interaction (requires POST SLS binding).

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property sls_url (string)

      Single Logout Service URL where the logout response should be sent.

    • Added property sign_logout_request (boolean)

    • Added property sls_binding (object)

      This determines how authentik sends the logout response back to the Service Provider.

    • Added property logout_method (object)

      Method to use for logout. Front-channel iframe loads all logout URLs simultaneously in hidden iframes. Front-channel native uses your active browser tab to send post requests and redirect to providers. Back-channel sends logout requests directly from the server without user interaction (requires POST SLS binding).

GET /providers/oauth2/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property logout_uri (string)

    • Added property logout_method (object)

      Backchannel logs out with server to server calls. Frontchannel uses iframes in your browser

      Enum values:

      • backchannel
      • frontchannel
    • Deleted property backchannel_logout_uri (string)

PUT /providers/oauth2/{id}/
Request:

Changed content type : application/json

  • Added property logout_uri (string)

  • Added property logout_method (object)

    Backchannel logs out with server to server calls. Frontchannel uses iframes in your browser

  • Deleted property backchannel_logout_uri (string)

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property logout_uri (string)

    • Added property logout_method (object)

      Backchannel logs out with server to server calls. Frontchannel uses iframes in your browser

    • Deleted property backchannel_logout_uri (string)

PATCH /providers/oauth2/{id}/
Request:

Changed content type : application/json

  • Added property logout_uri (string)

  • Added property logout_method (object)

    Backchannel logs out with server to server calls. Frontchannel uses iframes in your browser

  • Deleted property backchannel_logout_uri (string)

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property logout_uri (string)

    • Added property logout_method (object)

      Backchannel logs out with server to server calls. Frontchannel uses iframes in your browser

    • Deleted property backchannel_logout_uri (string)

POST /providers/saml/
Request:

Changed content type : application/json

  • Added property sls_url (string)

    Single Logout Service URL where the logout response should be sent.

  • Added property sign_logout_request (boolean)

  • Added property sls_binding (object)

    This determines how authentik sends the logout response back to the Service Provider.

  • Added property logout_method (object)

    Method to use for logout. Front-channel iframe loads all logout URLs simultaneously in hidden iframes. Front-channel native uses your active browser tab to send post requests and redirect to providers. Back-channel sends logout requests directly from the server without user interaction (requires POST SLS binding).

Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Added property sls_url (string)

      Single Logout Service URL where the logout response should be sent.

    • Added property sign_logout_request (boolean)

    • Added property sls_binding (object)

      This determines how authentik sends the logout response back to the Service Provider.

    • Added property logout_method (object)

      Method to use for logout. Front-channel iframe loads all logout URLs simultaneously in hidden iframes. Front-channel native uses your active browser tab to send post requests and redirect to providers. Back-channel sends logout requests directly from the server without user interaction (requires POST SLS binding).

GET /providers/saml/
Parameters:

Added: logout_method in query

Method to use for logout. Front-channel iframe loads all logout URLs simultaneously in hidden iframes. Front-channel native uses your active browser tab to send post requests and redirect to providers. Back-channel sends logout requests directly from the server without user interaction (requires POST SLS binding).

Added: sign_logout_request in query

Added: sls_binding in query

This determines how authentik sends the logout response back to the Service Provider.

Added: sls_url in query

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > SAMLProvider Serializer

      • Added property sls_url (string)

        Single Logout Service URL where the logout response should be sent.

      • Added property sign_logout_request (boolean)

      • Added property sls_binding (object)

        This determines how authentik sends the logout response back to the Service Provider.

      • Added property logout_method (object)

        Method to use for logout. Front-channel iframe loads all logout URLs simultaneously in hidden iframes. Front-channel native uses your active browser tab to send post requests and redirect to providers. Back-channel sends logout requests directly from the server without user interaction (requires POST SLS binding).

GET /flows/executor/{flow_slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Added 'ak-provider-iframe-logout' component:

    • Property flow_info (object)

      Contextual flow information for a challenge

      • Property title (string)

      • Property background (string)

      • Property cancel_url (string)

      • Property layout (string)

        Enum values:

        • stacked
        • content_left
        • content_right
        • sidebar_left
        • sidebar_right
    • Property component (string)

    • Property response_errors (object)

    • Property logout_urls (array)

      Items (object):

    Added 'ak-provider-saml-native-logout' component:

    • Property flow_info (object)

      Contextual flow information for a challenge

    • Property component (string)

    • Property response_errors...

Read more

v2025.10.0-rc1-1759955829: -e Update API Client

08 Oct 20:37

Choose a tag to compare

-e Update API Client

What's Changed


GET /stages/prompt/prompts/{prompt_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • prompt_stages_obj
    • Added property prompt_stages_obj (array)

      Items (object):
      > PromptStage Serializer

      • Property pk (string)

      • Property name (string)

      • Property component (string)

        Get object type so that we know how to edit the object

      • Property verbose_name (string)

        Return object's verbose_name

      • Property verbose_name_plural (string)

        Return object's plural verbose_name

      • Property meta_model_name (string)

        Return internal model name

      • Property flow_set (array)

        Items (object):
        > Stripped down flow serializer

        • Property pk (string)

        • Property policybindingmodel_ptr_id (string)

        • Property name (string)

        • Property slug (string)

          Visible in the URL.

        • Property title (string)

          Shown as the Title in Flow pages.

        • Property designation (string)

          Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.

          Enum values:

          • authentication
          • authorization
          • invalidation
          • enrollment
          • unenrollment
          • recovery
          • stage_configuration
        • Property background (string)

          Get the URL to the background image. If the name is /static or starts with http
          it is returned as-is

        • Property policy_engine_mode (string)

          Enum values:

          • all
          • any
        • Property compatibility_mode (boolean)

          Enable compatibility mode, increases compatibility with password managers on mobile devices.

        • Property export_url (string)

          Get export URL for flow

        • Property layout (string)

          Enum values:

          • stacked
          • content_left
          • content_right
          • sidebar_left
          • sidebar_right
        • Property denied_action (string)

          Configure what should happen when a flow denies access to a user.

          Enum values:

          • message_continue
          • message
          • continue
      • Property fields (array)

        Items (string):

      • Property validation_policies (array)

    • Deleted property promptstage_set (array)

PUT /stages/prompt/prompts/{prompt_uuid}/
Request:

Changed content type : application/json

  • Deleted property promptstage_set (array)
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • prompt_stages_obj
    • Added property prompt_stages_obj (array)

    • Deleted property promptstage_set (array)

PATCH /stages/prompt/prompts/{prompt_uuid}/
Request:

Changed content type : application/json

  • Deleted property promptstage_set (array)
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • prompt_stages_obj
    • Added property prompt_stages_obj (array)

    • Deleted property promptstage_set (array)

POST /stages/prompt/prompts/
Request:

Changed content type : application/json

  • Deleted property promptstage_set (array)
Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • prompt_stages_obj
    • Added property prompt_stages_obj (array)

    • Deleted property promptstage_set (array)

GET /stages/prompt/prompts/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > Prompt Serializer

      New required properties:

      • prompt_stages_obj
      • Added property prompt_stages_obj (array)

      • Deleted property promptstage_set (array)

POST /stages/prompt/prompts/preview/
Request:

Changed content type : application/json

  • Deleted property promptstage_set (array)

v2025.10.0-rc1-1759935059: -e Update API Client

08 Oct 14:51

Choose a tag to compare

-e Update API Client

What's Changed


GET /rbac/roles/
Parameters:

Added: name in query

Deleted: group__name in query

GET /tasks/tasks/{message_id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property retries (integer)

      Number of retries

    • Added property eta (string)

      Planned execution time

GET /tasks/tasks/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):

      • Added property retries (integer)

        Number of retries

      • Added property eta (string)

        Planned execution time

v2025.10.0-rc1-1759854394: -e Update API Client

07 Oct 16:27

Choose a tag to compare

-e Update API Client

What's New


GET /tasks/tasks/status/

v2025.10.0-rc1-1759847168: -e Update API Client

07 Oct 14:26

Choose a tag to compare

-e Update API Client

What's Changed


GET /policies/event_matcher/{policy_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property app (string)

      Match events created by selected application. When left empty, all applications are matched.

      Added enum value:

      • authentik.commands
PUT /policies/event_matcher/{policy_uuid}/
Request:

Changed content type : application/json

  • Changed property app (string)

    Match events created by selected application. When left empty, all applications are matched.

    Added enum value:

    • authentik.commands
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property app (string)

      Match events created by selected application. When left empty, all applications are matched.

      Added enum value:

      • authentik.commands
PATCH /policies/event_matcher/{policy_uuid}/
Request:

Changed content type : application/json

  • Changed property app (string)

    Match events created by selected application. When left empty, all applications are matched.

    Added enum value:

    • authentik.commands
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property app (string)

      Match events created by selected application. When left empty, all applications are matched.

      Added enum value:

      • authentik.commands
GET /tasks/schedules/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property last_task_status (string)

      Added enum values:

      • preprocess
      • running
      • postprocess
PUT /tasks/schedules/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property last_task_status (string)

      Added enum values:

      • preprocess
      • running
      • postprocess
PATCH /tasks/schedules/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property last_task_status (string)

      Added enum values:

      • preprocess
      • running
      • postprocess
POST /policies/event_matcher/
Request:

Changed content type : application/json

  • Changed property app (string)

    Match events created by selected application. When left empty, all applications are matched.

    Added enum value:

    • authentik.commands
Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property app (string)

      Match events created by selected application. When left empty, all applications are matched.

      Added enum value:

      • authentik.commands
GET /policies/event_matcher/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > Event Matcher Policy Serializer

      • Changed property app (string)

        Match events created by selected application. When left empty, all applications are matched.

        Added enum value:

        • authentik.commands
GET /providers/google_workspace/{id}/sync/status/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property last_sync_status (string)

      Added enum values:

      • preprocess
      • running
      • postprocess
GET /providers/microsoft_entra/{id}/sync/status/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property last_sync_status (string)

      Added enum values:

      • preprocess
      • running
      • postprocess
GET /providers/scim/{id}/sync/status/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property last_sync_status (string)

      Added enum values:

      • preprocess
      • running
      • postprocess
GET /sources/kerberos/{slug}/sync/status/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property last_sync_status (string)

      Added enum values:

      • preprocess
      • running
      • postprocess
GET /sources/ldap/{slug}/sync/status/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property last_sync_status (string)

      Added enum values:

      • preprocess
      • running
      • postprocess
GET /tasks/schedules/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):

      • Changed property last_task_status (string)

        Added enum values:

        • preprocess
        • running
        • postprocess
GET /tasks/tasks/{message_id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property state (string)

      Task status

      Added enum values:

      • preprocess
      • running
      • postprocess
    • Changed property aggregated_status (string)

      Added enum values:

      • preprocess
      • running
      • postprocess
GET /tasks/tasks/
Parameters:

Changed: aggregated_status in query

Changed: state in query

Task status

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):

      • Changed property state (string)

        Task status

        Added enum values:

        • preprocess
        • running
        • postprocess
      • Changed property aggregated_status (string)

        Added enum values:

        • preprocess
        • running
        • postprocess