3.2025120.3: Update API Client

Update API Client

What's Changed

---

GET /crypto/certificatekeypairs/{kp_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • key_type

  New optional properties:

  • private_key_type

  • Added property key_type (object)

    Enum values:

    • rsa
    • ec
    • dsa
    • ed25519
    • ed448

  • Deleted property private_key_type (string)

    Get the private key's type, if set

PUT /crypto/certificatekeypairs/{kp_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • key_type

  New optional properties:

  • private_key_type

  • Added property key_type (object)

  • Deleted property private_key_type (string)

    Get the private key's type, if set

PATCH /crypto/certificatekeypairs/{kp_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • key_type

  New optional properties:

  • private_key_type

  • Added property key_type (object)

  • Deleted property private_key_type (string)

    Get the private key's type, if set

POST /crypto/certificatekeypairs/generate/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • key_type

  New optional properties:

  • private_key_type

  • Added property key_type (object)

  • Deleted property private_key_type (string)

    Get the private key's type, if set

POST /crypto/certificatekeypairs/

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  New required properties:

  • key_type

  New optional properties:

  • private_key_type

  • Added property key_type (object)

  • Deleted property private_key_type (string)

    Get the private key's type, if set

GET /crypto/certificatekeypairs/

Parameters:

Added: key_type in query

Filter by key algorithm type (RSA, EC, DSA, etc). Can be specified multiple times (e.g. '?key_type=rsa&key_type=ec')

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > CertificateKeyPair Serializer

    New required properties:

    • key_type

    New optional properties:

    • private_key_type

    • Added property key_type (object)

    • Deleted property private_key_type (string)

      Get the private key's type, if set

GET /policies/geoip/{policy_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PUT /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PATCH /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

POST /policies/geoip/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property countries (array)

GET /policies/geoip/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > GeoIP Policy Serializer

    • Changed property countries (array)

3.2025120.2: Update API Client

Update API Client

What's Changed

---

GET /policies/geoip/{policy_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PUT /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PATCH /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

GET /providers/google_workspace/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property sync_page_size (integer)

    Controls the number of objects synced in a single task

  • Added property sync_page_timeout (string)

    Timeout for synchronization of a single page

PUT /providers/google_workspace/{id}/

Request:

Changed content type : application/json

• Added property sync_page_size (integer)

  Controls the number of objects synced in a single task

• Added property sync_page_timeout (string)

  Timeout for synchronization of a single page

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property sync_page_size (integer)

    Controls the number of objects synced in a single task

  • Added property sync_page_timeout (string)

    Timeout for synchronization of a single page

PATCH /providers/google_workspace/{id}/

Request:

Changed content type : application/json

• Added property sync_page_size (integer)

  Controls the number of objects synced in a single task

• Added property sync_page_timeout (string)

  Timeout for synchronization of a single page

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property sync_page_size (integer)

    Controls the number of objects synced in a single task

  • Added property sync_page_timeout (string)

    Timeout for synchronization of a single page

GET /providers/microsoft_entra/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property sync_page_size (integer)

    Controls the number of objects synced in a single task

  • Added property sync_page_timeout (string)

    Timeout for synchronization of a single page

PUT /providers/microsoft_entra/{id}/

Request:

Changed content type : application/json

• Added property sync_page_size (integer)

  Controls the number of objects synced in a single task

• Added property sync_page_timeout (string)

  Timeout for synchronization of a single page

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property sync_page_size (integer)

    Controls the number of objects synced in a single task

  • Added property sync_page_timeout (string)

    Timeout for synchronization of a single page

PATCH /providers/microsoft_entra/{id}/

Request:

Changed content type : application/json

• Added property sync_page_size (integer)

  Controls the number of objects synced in a single task

• Added property sync_page_timeout (string)

  Timeout for synchronization of a single page

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property sync_page_size (integer)

    Controls the number of objects synced in a single task

  • Added property sync_page_timeout (string)

    Timeout for synchronization of a single page

GET /providers/scim/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property sync_page_size (integer)

    Controls the number of objects synced in a single task

  • Added property sync_page_timeout (string)

    Timeout for synchronization of a single page

PUT /providers/scim/{id}/

Request:

Changed content type : application/json

• Added property sync_page_size (integer)

  Controls the number of objects synced in a single task

• Added property sync_page_timeout (string)

  Timeout for synchronization of a single page

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property sync_page_size (integer)

    Controls the number of objects synced in a single task

  • Added property sync_page_timeout (string)

    Timeout for synchronization of a single page

PATCH /providers/scim/{id}/

Request:

Changed content type : application/json

• Added property sync_page_size (integer)

  Controls the number of objects synced in a single task

• Added property sync_page_timeout (string)

  Timeout for synchronization of a single page

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property sync_page_size (integer)

    Controls the number of objects synced in a single task

  • Added property sync_page_timeout (string)

    Timeout for synchronization of a single page

POST /policies/geoip/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property countries (array)

GET /policies/geoip/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > GeoIP Policy Serializer

    • Changed property countries (array)

POST /providers/google_workspace/

Request:

Changed content type : application/json

• Added property sync_page_size (integer)

  Controls the number of objects synced in a single task

• Added property sync_page_timeout (string)

  Timeout for synchronization of a single page

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property sync_page_size (integer)

    Controls the number of objects synced in a single task

  • Added property sync_page_timeout (string)

    Timeout for synchronization of a single page

GET /providers/google_workspace/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > GoogleWorkspaceProvider Serializer

    • Added property sync_page_size (integer)

      Controls the number of objects synced in a single task

    • Added property sync_page_timeout (string)

      Timeout for synchronization of a single page

POST /providers/microsoft_entra/

Request:

Changed content type : application/json

• Added property sync_page_size (integer)

  Controls the number of objects synced in a single task

• Added property sync_page_timeout (string)

  Timeout for synchronization of a single page

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property sync_page_size (integer)

    Controls the number of objects synced in a single task

  • Added property sync_page_timeout (string)

    Timeout for synchronization of a single page

GET /providers/microsoft_entra/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > MicrosoftEntraProvider Serializer

    • Added property sync_page_size (integer)

      Controls the number of objects synced in a single task

    • Added property sync_page_timeout (string)

      Timeout for synchronization of a single page

POST /providers/scim/

Request:

Changed content type : application/json

• Added property sync_page_size (integer)

  Controls the number of objects synced in a single task

• Added property sync_page_timeout (string)

  Timeout for synchronization of a single page

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property sync_page_size (integer)

    Controls the number of objects synced in a single task

  • Added property sync_page_timeout (string)

    Timeout for synchronization of a single page

GET /providers/scim/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > SCIMProvider Serializer

    • Added property sync_page_size (integer)

      Controls the number of objects synced in a single task

    • Added property sync_page_timeout (string)

      Timeout for synchronization of a single page

PUT /core/transactional/applications/

Request:

Changed content type : application/json

• Changed property provider (object)

  Updated authentik_providers_microsoft_entra.microsoftentraprovider provider_model:

  • Added property sync_page_size (integer)

    Controls the number of objects synced in a single task

  • Added property `sync_page_t...

3.2025120.1: Update API Client

Update API Client

What's Changed

---

GET /policies/geoip/{policy_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PUT /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PATCH /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

POST /policies/geoip/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property countries (array)

GET /policies/geoip/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > GeoIP Policy Serializer

    • Changed property countries (array)

3.2025100.25: Update API Client

Update API Client

What's Changed

---

GET /policies/geoip/{policy_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PUT /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PATCH /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

GET /sources/oauth/{slug}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property pkce (string)

    Enum values:

    • none
    • plain
    • S256

PUT /sources/oauth/{slug}/

Request:

Changed content type : application/json

• Added property pkce (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property pkce (string)

PATCH /sources/oauth/{slug}/

Request:

Changed content type : application/json

• Added property pkce (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property pkce (string)

POST /policies/geoip/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property countries (array)

GET /policies/geoip/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > GeoIP Policy Serializer

    • Changed property countries (array)

POST /sources/oauth/

Request:

Changed content type : application/json

• Added property pkce (string)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property pkce (string)

GET /sources/oauth/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > OAuth Source Serializer

    • Added property pkce (string)

3.2025100.24: Update API Client

Update API Client

What's Changed

---

GET /policies/geoip/{policy_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PUT /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PATCH /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

POST /policies/geoip/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property countries (array)

GET /policies/geoip/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > GeoIP Policy Serializer

    • Changed property countries (array)

POST /stages/prompt/prompts/preview/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property fields (array)

    Changed items (object):
    > Serializer for a single Prompt field

    • Changed property choices (array)

      Changed items (string -> object):
      > Serializer for a single Choice field

GET /flows/executor/{flow_slug}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  Updated ak-stage-prompt component:

  • Changed property fields (array)

    Changed items (object):
    > Serializer for a single Prompt field

    • Changed property choices (array)

      Changed items (string -> object):
      > Serializer for a single Choice field

POST /flows/executor/{flow_slug}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  Updated ak-stage-prompt component:

  • Changed property fields (array)

    Changed items (object):
    > Serializer for a single Prompt field

    • Changed property choices (array)

      Changed items (string -> object):
      > Serializer for a single Choice field

3.2025100.23: Update API Client

Update API Client

What's Changed

---

GET /policies/geoip/{policy_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PUT /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PATCH /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

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)

POST /policies/geoip/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property countries (array)

GET /policies/geoip/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > GeoIP Policy Serializer

    • Changed property countries (array)

3.2025100.22: Update API Client

Update API Client

What's Changed

---

GET /policies/geoip/{policy_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PUT /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PATCH /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

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)

POST /policies/geoip/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property countries (array)

GET /policies/geoip/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > GeoIP Policy Serializer

    • Changed property countries (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)

3.2025100.21: Update API Client

Update API Client

What's Changed

---

GET /policies/geoip/{policy_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PUT /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PATCH /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

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).

POST /policies/geoip/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property countries (array)

GET /policies/geoip/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > GeoIP Policy Serializer

    • Changed property countries (array)

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 propert...

3.2025100.20: Update API Client

Update API Client

What's Changed

---

GET /policies/geoip/{policy_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PUT /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PATCH /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

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 /policies/geoip/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property countries (array)

GET /policies/geoip/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > GeoIP Policy Serializer

    • Changed property countries (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)

3.2025100.19: Update API Client

Update API Client

What's Changed

---

GET /policies/geoip/{policy_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PUT /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

PATCH /policies/geoip/{policy_uuid}/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property countries (array)

GET /rbac/roles/

Parameters:

Added: name in query

Deleted: group__name in query

POST /policies/geoip/

Request:

Changed content type : application/json

• Changed property countries (array)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property countries (array)

GET /policies/geoip/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > GeoIP Policy Serializer

    • Changed property countries (array)

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