3.2025064.7: 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)

GET /stages/email/{stage_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property recovery_max_attempts (integer)

  • Added property recovery_cache_timeout (string)

    The time window used to count recent account recovery attempts. If the number of attempts exceed recovery_max_attempts within this period, further attempts will be rate-limited. (Format: hours=1;minutes=2;seconds=3).

PUT /stages/email/{stage_uuid}/

Request:

Changed content type : application/json

• Added property recovery_max_attempts (integer)

• Added property recovery_cache_timeout (string)

  The time window used to count recent account recovery attempts. If the number of attempts exceed recovery_max_attempts within this period, further attempts will be rate-limited. (Format: hours=1;minutes=2;seconds=3).

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property recovery_max_attempts (integer)

  • Added property recovery_cache_timeout (string)

    The time window used to count recent account recovery attempts. If the number of attempts exceed recovery_max_attempts within this period, further attempts will be rate-limited. (Format: hours=1;minutes=2;seconds=3).

PATCH /stages/email/{stage_uuid}/

Request:

Changed content type : application/json

• Added property recovery_max_attempts (integer)

• Added property recovery_cache_timeout (string)

  The time window used to count recent account recovery attempts. If the number of attempts exceed recovery_max_attempts within this period, further attempts will be rate-limited. (Format: hours=1;minutes=2;seconds=3).

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property recovery_max_attempts (integer)

  • Added property recovery_cache_timeout (string)

    The time window used to count recent account recovery attempts. If the number of attempts exceed recovery_max_attempts within this period, further attempts will be rate-limited. (Format: hours=1;minutes=2;seconds=3).

POST /stages/email/

Request:

Changed content type : application/json

• Added property recovery_max_attempts (integer)

• Added property recovery_cache_timeout (string)

  The time window used to count recent account recovery attempts. If the number of attempts exceed recovery_max_attempts within this period, further attempts will be rate-limited. (Format: hours=1;minutes=2;seconds=3).

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property recovery_max_attempts (integer)

  • Added property recovery_cache_timeout (string)

    The time window used to count recent account recovery attempts. If the number of attempts exceed recovery_max_attempts within this period, further attempts will be rate-limited. (Format: hours=1;minutes=2;seconds=3).

GET /stages/email/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > EmailStage Serializer

    • Added property recovery_max_attempts (integer)

    • Added property recovery_cache_timeout (string)

      The time window used to count recent account recovery attempts. If the number of attempts exceed recovery_max_attempts within this period, further attempts will be rate-limited. (Format: hours=1;minutes=2;seconds=3).

3.2025064.6: 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)

GET /providers/oauth2/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property backchannel_logout_uri (string)

PUT /providers/oauth2/{id}/

Request:

Changed content type : application/json

• Added property backchannel_logout_uri (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property backchannel_logout_uri (string)

PATCH /providers/oauth2/{id}/

Request:

Changed content type : application/json

• Added property backchannel_logout_uri (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property backchannel_logout_uri (string)

GET /oauth2/access_tokens/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property provider (object)

    OAuth2Provider Serializer

    • Added property backchannel_logout_uri (string)

GET /oauth2/authorization_codes/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property provider (object)

    OAuth2Provider Serializer

    • Added property backchannel_logout_uri (string)

GET /oauth2/refresh_tokens/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property provider (object)

    OAuth2Provider Serializer

    • Added property backchannel_logout_uri (string)

POST /providers/oauth2/

Request:

Changed content type : application/json

• Added property backchannel_logout_uri (string)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property backchannel_logout_uri (string)

GET /providers/oauth2/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > OAuth2Provider Serializer

    • Added property backchannel_logout_uri (string)

PUT /core/transactional/applications/

Request:

Changed content type : application/json

• Changed property provider (object)

  Updated authentik_providers_oauth2.oauth2provider provider_model:

  • Added property backchannel_logout_uri (string)

GET /oauth2/access_tokens/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Serializer for BaseGrantModel and RefreshToken

    • Changed property provider (object)

      OAuth2Provider Serializer

      • Added property backchannel_logout_uri (string)

GET /oauth2/authorization_codes/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Serializer for BaseGrantModel and ExpiringBaseGrant

    • Changed property provider (object)

      OAuth2Provider Serializer

      • Added property backchannel_logout_uri (string)

GET /oauth2/refresh_tokens/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Serializer for BaseGrantModel and RefreshToken

    • Changed property provider (object)

      OAuth2Provider Serializer

      • Added property backchannel_logout_uri (string)

3.2025064.5: Update API Client

Update API Client

What's Changed

---

GET /core/tokens/{identifier}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property user_obj (object)

    User Serializer

    New required properties:

    • last_updated
    • Added property last_updated (string)

PUT /core/tokens/{identifier}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property user_obj (object)

    User Serializer

    New required properties:

    • last_updated
    • Added property last_updated (string)

PATCH /core/tokens/{identifier}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property user_obj (object)

    User Serializer

    New required properties:

    • last_updated
    • Added property last_updated (string)

GET /core/users/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • last_updated
  • Added property last_updated (string)

PUT /core/users/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • last_updated
  • Added property last_updated (string)

PATCH /core/users/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • last_updated
  • Added property last_updated (string)

GET /policies/bindings/{policy_binding_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property user_obj (object)

    User Serializer

    New required properties:

    • last_updated
    • Added property last_updated (string)

PUT /policies/bindings/{policy_binding_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property user_obj (object)

    User Serializer

    New required properties:

    • last_updated
    • Added property last_updated (string)

PATCH /policies/bindings/{policy_binding_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property user_obj (object)

    User Serializer

    New required properties:

    • last_updated
    • Added property last_updated (string)

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/ssf/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property token_obj (object)

    Token Serializer

    • Changed property user_obj (object)

      User Serializer

      New required properties:

      • last_updated
      • Added property last_updated (string)

PUT /providers/ssf/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property token_obj (object)

    Token Serializer

    • Changed property user_obj (object)

      User Serializer

      New required properties:

      • last_updated
      • Added property last_updated (string)

PATCH /providers/ssf/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property token_obj (object)

    Token Serializer

    • Changed property user_obj (object)

      User Serializer

      New required properties:

      • last_updated
      • Added property last_updated (string)

GET /sources/scim/{slug}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property token_obj (object)

    Token Serializer

    • Changed property user_obj (object)

      User Serializer

      New required properties:

      • last_updated
      • Added property last_updated (string)

PUT /sources/scim/{slug}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property token_obj (object)

    Token Serializer

    • Changed property user_obj (object)

      User Serializer

      New required properties:

      • last_updated
      • Added property last_updated (string)

PATCH /sources/scim/{slug}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property token_obj (object)

    Token Serializer

    • Changed property user_obj (object)

      User Serializer

      New required properties:

      • last_updated
      • Added property last_updated (string)

GET /ssf/streams/{uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property provider_obj (object)

    SSFProvider Serializer

    • Changed property token_obj (object)

      Token Serializer

      • Changed property user_obj (object)

        User Serializer

        New required properties:

        • last_updated
        • Added property last_updated (string)

POST /core/tokens/

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property user_obj (object)

    User Serializer

    New required properties:

    • last_updated
    • Added property last_updated (string)

GET /core/tokens/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Token Serializer

    • Changed property user_obj (object)

      User Serializer

      New required properties:

      • last_updated
      • Added property last_updated (string)

GET /core/user_consent/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property user (object)

    User Serializer

    New required properties:

    • last_updated
    • Added property last_updated (string)

POST /core/users/

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  New required properties:

  • last_updated
  • Added property last_updated (string)

GET /core/users/

Parameters:

Added: date_joined in query

Added: date_joined__gt in query

Added: date_joined__lt in query

Added: last_updated in query

Added: last_updated__gt in query

Added: last_updated__lt in query

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > User Serializer

    New required properties:

    • last_updated
    • Added property last_updated (string)

POST /policies/bindings/

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property user_obj (object)

    User Serializer

    New required properties:

    • last_updated
    • Added property last_updated (string)

GET /policies/bindings/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > PolicyBinding Serializer

    • Changed property user_obj (object)

      User Serializer

      New required properties:

      • last_updated
      • Added property last_updated (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 /providers/ssf/

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property token_obj (object)

    Token Serializer

    • Changed property user_obj (object)

      User Serializer

      New required properties:

      • last_updated
      • Added property last_updated (string)

`G...

3.2025064.4: Update API Client

Update API Client

What's Changed

---

GET /core/groups/{group_uuid}/

Parameters:

Added: include_children in query

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • children_obj

  • Added property children (array)

    Items (string):

  • Added property children_obj (array)

    Items (object):
    > Stripped down group serializer to show relevant children for groups

    • Property pk (string)

    • Property name (string)

    • Property is_superuser (boolean)

      Users added to this group will be superusers.

    • Property attributes (object)

    • Property group_uuid (string)

PUT /core/groups/{group_uuid}/

Request:

Changed content type : application/json

• Added property children (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • children_obj

  • Added property children (array)

  • Added property children_obj (array)

PATCH /core/groups/{group_uuid}/

Request:

Changed content type : application/json

• Added property children (array)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • children_obj

  • Added property children (array)

  • Added property children_obj (array)

GET /events/rules/{pbm_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property destination_group_obj (object)

    Group Serializer

    New required properties:

    • children_obj

    • Added property children (array)

    • Added property children_obj (array)

PUT /events/rules/{pbm_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property destination_group_obj (object)

    Group Serializer

    New required properties:

    • children_obj

    • Added property children (array)

    • Added property children_obj (array)

PATCH /events/rules/{pbm_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property destination_group_obj (object)

    Group Serializer

    New required properties:

    • children_obj

    • Added property children (array)

    • Added property children_obj (array)

GET /policies/bindings/{policy_binding_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property group_obj (object)

    Group Serializer

    New required properties:

    • children_obj

    • Added property children (array)

    • Added property children_obj (array)

PUT /policies/bindings/{policy_binding_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property group_obj (object)

    Group Serializer

    New required properties:

    • children_obj

    • Added property children (array)

    • Added property children_obj (array)

PATCH /policies/bindings/{policy_binding_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property group_obj (object)

    Group Serializer

    New required properties:

    • children_obj

    • Added property children (array)

    • Added property children_obj (array)

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 /core/groups/

Request:

Changed content type : application/json

• Added property children (array)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  New required properties:

  • children_obj

  • Added property children (array)

  • Added property children_obj (array)

GET /core/groups/

Parameters:

Added: include_children in query

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Group Serializer

    New required properties:

    • children_obj

    • Added property children (array)

    • Added property children_obj (array)

POST /events/rules/

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property destination_group_obj (object)

    Group Serializer

    New required properties:

    • children_obj

    • Added property children (array)

    • Added property children_obj (array)

GET /events/rules/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > NotificationRule Serializer

    • Changed property destination_group_obj (object)

      Group Serializer

      New required properties:

      • children_obj

      • Added property children (array)

      • Added property children_obj (array)

POST /policies/bindings/

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property group_obj (object)

    Group Serializer

    New required properties:

    • children_obj

    • Added property children (array)

    • Added property children_obj (array)

GET /policies/bindings/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > PolicyBinding Serializer

    • Changed property group_obj (object)

      Group Serializer

      New required properties:

      • children_obj

      • Added property children (array)

      • Added property children_obj (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.2025064.3: 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 default_name_id_policy (string)

    Enum values:

    • urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
    • urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
    • urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName
    • urn:oasis:names:tc:SAML:2.0:nameid-format:WindowsDomainQualifiedName
    • urn:oasis:names:tc:SAML:2.0:nameid-format:transient
    • urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

PUT /providers/saml/{id}/

Request:

Changed content type : application/json

• Added property default_name_id_policy (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property default_name_id_policy (string)

PATCH /providers/saml/{id}/

Request:

Changed content type : application/json

• Added property default_name_id_policy (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property default_name_id_policy (string)

GET /sources/saml/{slug}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property name_id_policy (string)

    NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.

    Added enum value:

    • urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

PUT /sources/saml/{slug}/

Request:

Changed content type : application/json

• Changed property name_id_policy (string)

  NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.

  Added enum value:

  • urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property name_id_policy (string)

    NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.

    Added enum value:

    • urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

PATCH /sources/saml/{slug}/

Request:

Changed content type : application/json

• Changed property name_id_policy (string)

  NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.

  Added enum value:

  • urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property name_id_policy (string)

    NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.

    Added enum value:

    • urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

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/saml/

Request:

Changed content type : application/json

• Added property default_name_id_policy (string)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property default_name_id_policy (string)

GET /providers/saml/

Parameters:

Added: default_name_id_policy in query

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > SAMLProvider Serializer

    • Added property default_name_id_policy (string)

POST /sources/saml/

Request:

Changed content type : application/json

• Changed property name_id_policy (string)

  NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.

  Added enum value:

  • urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property name_id_policy (string)

    NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.

    Added enum value:

    • urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

GET /sources/saml/

Parameters:

Changed: name_id_policy in query

NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > SAMLSource Serializer

    • Changed property name_id_policy (string)

      NameID Policy sent to the IdP. Can be unset, in which case no Policy is sent.

      Added enum value:

      • urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

PUT /core/transactional/applications/

Request:

Changed content type : application/json

• Changed property provider (object)

  Updated authentik_providers_saml.samlprovider provider_model:

  • Added property default_name_id_policy (string)

3.2025064.2: Update API Client

Update API Client

What's New

---

GET /tasks/schedules/

GET /tasks/schedules/{id}/

PUT /tasks/schedules/{id}/

PATCH /tasks/schedules/{id}/

POST /tasks/schedules/{id}/send/

GET /tasks/tasks/

GET /tasks/tasks/{message_id}/

POST /tasks/tasks/{message_id}/retry/

GET /tasks/workers

What's Deleted

---

GET /admin/workers/

GET /events/system_tasks/

GET /events/system_tasks/{uuid}/

POST /events/system_tasks/{uuid}/run/

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 values:

    • authentik.tasks
    • authentik.tasks.schedules

  • Changed property model (string)

    Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

    Added enum value:

    • authentik_tasks_schedules.schedule

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 values:

  • authentik.tasks
  • authentik.tasks.schedules

• Changed property model (string)

  Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

  Added enum value:

  • authentik_tasks_schedules.schedule

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 values:

    • authentik.tasks
    • authentik.tasks.schedules

  • Changed property model (string)

    Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

    Added enum value:

    • authentik_tasks_schedules.schedule

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 values:

  • authentik.tasks
  • authentik.tasks.schedules

• Changed property model (string)

  Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

  Added enum value:

  • authentik_tasks_schedules.schedule

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 values:

    • authentik.tasks
    • authentik.tasks.schedules

  • Changed property model (string)

    Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

    Added enum value:

    • authentik_tasks_schedules.schedule

GET /providers/google_workspace/{id}/sync/status/

Return Type:

Deleted response : 404 Not Found

Task not found

Changed response : 200 OK

• Changed content type : application/json

  New optional properties:

  • tasks

  • Added property last_successful_sync (string)

  • Added property last_sync_status (string)

    Enum values:

    • queued
    • consumed
    • rejected
    • done
    • info
    • warning
    • error

  • Deleted property tasks (array)

  • Changed property is_running (boolean)

GET /providers/microsoft_entra/{id}/sync/status/

Return Type:

Deleted response : 404 Not Found

Task not found

Changed response : 200 OK

• Changed content type : application/json

  New optional properties:

  • tasks

  • Added property last_successful_sync (string)

  • Added property last_sync_status (string)

  • Deleted property tasks (array)

  • Changed property is_running (boolean)

GET /providers/scim/{id}/sync/status/

Return Type:

Deleted response : 404 Not Found

Task not found

Changed response : 200 OK

• Changed content type : application/json

  New optional properties:

  • tasks

  • Added property last_successful_sync (string)

  • Added property last_sync_status (string)

  • Deleted property tasks (array)

  • Changed property is_running (boolean)

GET /sources/kerberos/{slug}/sync/status/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New optional properties:

  • tasks

  • Added property last_successful_sync (string)

  • Added property last_sync_status (string)

  • Deleted property tasks (array)

  • Changed property is_running (boolean)

GET /sources/ldap/{slug}/sync/status/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New optional properties:

  • tasks

  • Added property last_successful_sync (string)

  • Added property last_sync_status (string)

  • Deleted property tasks (array)

  • Changed property is_running (boolean)

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 values:

  • authentik.tasks
  • authentik.tasks.schedules

• Changed property model (string)

  Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

  Added enum value:

  • authentik_tasks_schedules.schedule

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 values:

    • authentik.tasks
    • authentik.tasks.schedules

  • Changed property model (string)

    Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

    Added enum value:

    • authentik_tasks_schedules.schedule

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 values:

      • authentik.tasks
      • authentik.tasks.schedules

    • Changed property model (string)

      Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

      Added enum value:

      • authentik_tasks_schedules.schedule

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 /rbac/permissions/assigned_by_roles/{uuid}/assign/

Request:

Changed content type : application/json

• Changed property model (string)

  Added enum value:

  • authentik_tasks_schedules.schedule

PATCH /rbac/permissions/assigned_by_roles/{uuid}/unassign/

Request:

Changed content type : application/json

• Changed property model (string)

  Added enum value:

  • authentik_tasks_schedules.schedule

POST /rbac/permissions/assigned_by_users/{id}/assign/

Request:

Changed content type : application/json

• Changed property model (string)

  Added enum value:

  • authentik_tasks_schedules.schedule

PATCH /rbac/permissions/assigned_by_users/{id}/unassign/

Request:

Changed content type : application/json

• Changed property model (string)

  Added enum value:

  • authentik_tasks_schedules.schedule

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 (ar...

3.2025064.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.2025063.6: Update API Client

Update API Client

What's Changed

---

GET /sources/scim_groups/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New optional properties:

  • id

PUT /sources/scim_groups/{id}/

Request:

Changed content type : application/json

New optional properties:

• id

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New optional properties:

  • id

PATCH /sources/scim_groups/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New optional properties:

  • id

GET /sources/scim_users/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New optional properties:

  • id

PUT /sources/scim_users/{id}/

Request:

Changed content type : application/json

New optional properties:

• id

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New optional properties:

  • id

PATCH /sources/scim_users/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New optional properties:

  • id

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

  • Changed property provider_type (string)

    Added enum value:

    • entraid

PUT /sources/oauth/{slug}/

Request:

Changed content type : application/json

• Changed property provider_type (string)

  Added enum value:

  • entraid

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property provider_type (string)

    Added enum value:

    • entraid

PATCH /sources/oauth/{slug}/

Request:

Changed content type : application/json

• Changed property provider_type (string)

  Added enum value:

  • entraid

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property provider_type (string)

    Added enum value:

    • entraid

POST /sources/scim_groups/

Request:

Changed content type : application/json

New optional properties:

• id

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  New optional properties:

  • id

GET /sources/scim_groups/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > SCIMSourceGroup Serializer

    New optional properties:

    • id

POST /sources/scim_users/

Request:

Changed content type : application/json

New optional properties:

• id

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  New optional properties:

  • id

GET /sources/scim_users/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > SCIMSourceUser Serializer

    New optional properties:

    • id

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

• Changed property provider_type (string)

  Added enum value:

  • entraid

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property provider_type (string)

    Added enum value:

    • entraid

GET /sources/oauth/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > OAuth Source Serializer

    • Changed property provider_type (string)

      Added enum value:

      • entraid

3.2025063.5: Update API Client

Update API Client

What's Changed

---

GET /sources/scim_groups/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • external_id
  • Added property external_id (string)

PUT /sources/scim_groups/{id}/

Request:

Changed content type : application/json

New required properties:

• external_id

• Added property external_id (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • external_id
  • Added property external_id (string)

PATCH /sources/scim_groups/{id}/

Request:

Changed content type : application/json

• Added property external_id (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • external_id
  • Added property external_id (string)

GET /sources/scim_users/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • external_id
  • Added property external_id (string)

PUT /sources/scim_users/{id}/

Request:

Changed content type : application/json

New required properties:

• external_id

• Added property external_id (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • external_id
  • Added property external_id (string)

PATCH /sources/scim_users/{id}/

Request:

Changed content type : application/json

• Added property external_id (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • external_id
  • Added property external_id (string)

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 /sources/scim_groups/

Request:

Changed content type : application/json

New required properties:

• external_id

• Added property external_id (string)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  New required properties:

  • external_id
  • Added property external_id (string)

GET /sources/scim_groups/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > SCIMSourceGroup Serializer

    New required properties:

    • external_id
    • Added property external_id (string)

POST /sources/scim_users/

Request:

Changed content type : application/json

New required properties:

• external_id

• Added property external_id (string)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  New required properties:

  • external_id
  • Added property external_id (string)

GET /sources/scim_users/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > SCIMSourceUser Serializer

    New required properties:

    • external_id
    • Added property external_id (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)

3.2025063.4: 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)

GET /flows/executor/{flow_slug}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  Updated ak-stage-authenticator-validate component:

  • Changed property device_challenges (array)

    Changed items (object):
    > Single device challenge

    • Changed property device_class (string)

      Added enum values:

      • static
      • totp
      • webauthn
      • duo
      • sms
      • email

POST /flows/executor/{flow_slug}/

Request:

Changed content type : application/json

Updated ak-stage-authenticator-validate component:

• Changed property selected_challenge (object)

  Single device challenge

  • Changed property device_class (string)

    Added enum values:

    • static
    • totp
    • webauthn
    • duo
    • sms
    • email

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  Updated ak-stage-authenticator-validate component:

  • Changed property device_challenges (array)

    Changed items (object):
    > Single device challenge

    • Changed property device_class (string)

      Added enum values:

      • static
      • totp
      • webauthn
      • duo
      • sms
      • email