Skip to content
This repository was archived by the owner on Feb 3, 2026. It is now read-only.
/ client-swift Public archive

Releases: goauthentik/client-swift

3.2026020.24: Update API Client

03 Feb 13:51

Choose a tag to compare

Update API Client

What's Changed


POST /crypto/certificatekeypairs/generate/
Request:

Changed content type : application/json

  • Changed property alg (string)

    Added enum values:

    • ed25519
    • ed448
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.2026020.23: Update API Client

29 Jan 18:17

Choose a tag to compare

Update API Client

What's Changed


POST /events/events/export/
Parameters:

Changed: actions in query

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

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property action (string)

      Match created events with this action type. When left empty, all action types will be matched.

      Added enum value:

      • configuration_warning
PUT /policies/event_matcher/{policy_uuid}/
Request:

Changed content type : application/json

  • Changed property action (string)

    Match created events with this action type. When left empty, all action types will be matched.

    Added enum value:

    • configuration_warning
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property action (string)

      Match created events with this action type. When left empty, all action types will be matched.

      Added enum value:

      • configuration_warning
PATCH /policies/event_matcher/{policy_uuid}/
Request:

Changed content type : application/json

  • Changed property action (string)

    Match created events with this action type. When left empty, all action types will be matched.

    Added enum value:

    • configuration_warning
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property action (string)

      Match created events with this action type. When left empty, all action types will be matched.

      Added enum value:

      • configuration_warning
GET /rbac/roles/{uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property name (string)
PUT /rbac/roles/{uuid}/
Request:

Changed content type : application/json

  • Changed property name (string)
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property name (string)
PATCH /rbac/roles/{uuid}/
Request:

Changed content type : application/json

  • Changed property name (string)
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property name (string)
GET /core/groups/{group_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property roles_obj (array)

      Changed items (object):
      > Role serializer

      • Changed property name (string)
PUT /core/groups/{group_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property roles_obj (array)

      Changed items (object):
      > Role serializer

      • Changed property name (string)
PATCH /core/groups/{group_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property roles_obj (array)

      Changed items (object):
      > Role serializer

      • Changed property name (string)
GET /core/tokens/{identifier}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property user_obj (object)

      User Serializer

      • Changed property roles_obj (array)

        Changed items (object):
        > Role serializer

        • Changed property name (string)
PUT /core/tokens/{identifier}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property user_obj (object)

      User Serializer

      • Changed property roles_obj (array)

        Changed items (object):
        > Role serializer

        • Changed property name (string)
PATCH /core/tokens/{identifier}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property user_obj (object)

      User Serializer

      • Changed property roles_obj (array)

        Changed items (object):
        > Role serializer

        • Changed property name (string)
GET /core/users/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property roles_obj (array)

      Changed items (object):
      > Role serializer

      • Changed property name (string)
PUT /core/users/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property roles_obj (array)

      Changed items (object):
      > Role serializer

      • Changed property name (string)
PATCH /core/users/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property roles_obj (array)

      Changed items (object):
      > Role serializer

      • Changed property name (string)
GET /events/events/{event_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property action (string)

      Added enum value:

      • configuration_warning
PUT /events/events/{event_uuid}/
Request:

Changed content type : application/json

  • Changed property action (string)

    Added enum value:

    • configuration_warning
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property action (string)

      Added enum value:

      • configuration_warning
PATCH /events/events/{event_uuid}/
Request:

Changed content type : application/json

  • Changed property action (string)

    Added enum value:

    • configuration_warning
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property action (string)

      Added enum value:

      • configuration_warning
GET /events/events/volume/
Parameters:

Changed: actions in query

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object):
    > Count of events of action created on day

    • Changed property action (string)

      Added enum value:

      • configuration_warning
GET /events/rules/{pbm_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property destination_group_obj (object)

      Group Serializer

      • Changed property roles_obj (array)

        Changed items (object):
        > Role serializer

        • Changed property name (string)
PUT /events/rules/{pbm_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property destination_group_obj (object)

      Group Serializer

      • Changed property roles_obj (array)

        Changed items (object):
        > Role serializer

        • Changed property name (string)
PATCH /events/rules/{pbm_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property destination_group_obj (object)

      Group Serializer

      • Changed property roles_obj (array)

        Changed items (object):
        > Role serializer

        • Changed property name (string)
POST /policies/event_matcher/
Request:

Changed content type : application/json

  • Changed property action (string)

    Match created events with this action type. When left empty, all action types will be matched.

    Added enum value:

    • configuration_warning
Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property action (string)

      Match created events with this action type. When left empty, all action types will be matched.

      Added enum value:

      • configuration_warning
GET /policies/event_matcher/
Parameters:

Changed: action in query

Match created events with this action type. When left empty, all action types will be matched.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > Event Matcher Policy Serializer

      • Changed property action (string)

        Match created events with this action type. When left empty, all action types will be matched.

        Added enum value:

        • configuration_warning
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 proper...
Read more

3.2026020.22: Update API Client

29 Jan 16:15

Choose a tag to compare

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/scim/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property group_filters (array)

      Group filters used to define sync-scope for groups.

      Items (string):

    • Deleted property filter_group (string)

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

Changed content type : application/json

  • Added property group_filters (array)

    Group filters used to define sync-scope for groups.

  • Deleted property filter_group (string)

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property group_filters (array)

      Group filters used to define sync-scope for groups.

    • Deleted property filter_group (string)

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

Changed content type : application/json

  • Added property group_filters (array)

    Group filters used to define sync-scope for groups.

  • Deleted property filter_group (string)

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property group_filters (array)

      Group filters used to define sync-scope for groups.

    • Deleted property filter_group (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/scim/
Request:

Changed content type : application/json

  • Added property group_filters (array)

    Group filters used to define sync-scope for groups.

  • Deleted property filter_group (string)

Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Added property group_filters (array)

      Group filters used to define sync-scope for groups.

    • Deleted property filter_group (string)

GET /providers/scim/
Parameters:

Added: group_filters in query

Deleted: filter_group in query

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > SCIMProvider Serializer

      • Added property group_filters (array)

        Group filters used to define sync-scope for groups.

      • Deleted property filter_group (string)

PUT /core/transactional/applications/
Request:

Changed content type : application/json

  • Changed property provider (object)

    Updated authentik_providers_scim.scimprovider provider_model:

    • Added property group_filters (array)

      Group filters used to define sync-scope for groups.

    • Deleted property filter_group (string)

3.2026020.21: Update API Client

29 Jan 02:35

Choose a tag to compare

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/wsfed/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property assigned_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_application_name (string)

      Application's display Name.

    • Changed property assigned_backchannel_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_backchannel_application_name (string)

      Application's display Name.

PUT /providers/wsfed/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property assigned_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_application_name (string)

      Application's display Name.

    • Changed property assigned_backchannel_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_backchannel_application_name (string)

      Application's display Name.

PATCH /providers/wsfed/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property assigned_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_application_name (string)

      Application's display Name.

    • Changed property assigned_backchannel_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_backchannel_application_name (string)

      Application's display Name.

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/wsfed/
Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property assigned_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_application_name (string)

      Application's display Name.

    • Changed property assigned_backchannel_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_backchannel_application_name (string)

      Application's display Name.

GET /providers/wsfed/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > WSFederationProvider Serializer

      • Changed property assigned_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_application_name (string)

        Application's display Name.

      • Changed property assigned_backchannel_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_backchannel_application_name (string)

        Application's display Name.

3.2026020.20: Update API Client

28 Jan 17:01

Choose a tag to compare

Update API Client

What's New


GET /providers/wsfed/
POST /providers/wsfed/
GET /providers/wsfed/{id}/
PUT /providers/wsfed/{id}/
DELETE /providers/wsfed/{id}/
PATCH /providers/wsfed/{id}/
GET /providers/wsfed/{id}/metadata/
GET /providers/wsfed/{id}/preview_user/
GET /providers/wsfed/{id}/used_by/

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.enterprise.providers.ws_federation
    • 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_providers_ws_federation.wsfederationprovider
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.enterprise.providers.ws_federation
  • 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_providers_ws_federation.wsfederationprovider
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.enterprise.providers.ws_federation
    • 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_providers_ws_federation.wsfederationprovider
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.enterprise.providers.ws_federation
  • 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_providers_ws_federation.wsfederationprovider
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.enterprise.providers.ws_federation
    • 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_providers_ws_federation.wsfederationprovider
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.enterprise.providers.ws_federation
  • 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_providers_ws_federation.wsfederationprovider
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.enterprise.providers.ws_federation
    • 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_providers_ws_federation.wsfederationprovider
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.enterprise.providers.ws_federation
      • 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_providers_ws_federation.wsfederationprovider
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_providers_ws_federation.wsfederationprovider
PATCH /rbac/permissions/assigned_by_roles/{uuid}/unassign/
Request:

Changed content type : application/json

  • Changed property model (string)

    Added enum value:

    • authentik_providers_ws_federation.wsfederationprovider
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 /rbac/permissions/assigned_by_roles/
Parameters:

Changed: model in query

PUT /core/transactional/applications/
Request:

Changed content type : application/json

  • Changed property provider_model (string)

    Added enum value:

    • authentik_providers_ws_federation.wsfederationprovider
  • Changed property provider (object)

    Added 'authentik_providers_ws_federation.wsfederationprovider' provider_model:

    • Property name (string)

    • Property authentication_flow (string)

      Flow used for authentication when the associated application is accessed by an un-authenticated user.

    • Property authorization_flow (string)

      Flow used when authorizing this provider.

    • Property invalidation_flow (string)

      Flow used ending the session from a provider.

    • Property property_mappings (array)

      Items (string):

    • Property reply_url (string)

    • Property assertion_valid_not_before (string)

      Assertion valid not before current time + this value (Format: hours=-1;minutes=-2;seconds=-3).

    • Property assertion_valid_not_on_or_after (string)

      Assertion not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).

    • Property session_valid_not_on_or_after (string)

      Session not valid on or after current time + this value (Format: hours=1;minutes=2;seconds=3).

    • Property name_id_mapping (string)

      Configure how the NameID value will be created. When left empty, the NameIDPolicy of the incoming request will be considered

    • Property authn_context_class_ref_mapping (string)

      Configure how the AuthnContextClassRef value will be created. When left empty, the AuthnContextClassRef will be set based on which authentication methods the user used to authenticate.

    • Property digest_algorithm (string)

      Enum values:

      • http://www.w3.org/2000/09/xmldsig#sha1
      • http://www.w3.org/2001/04/xmlenc#sha256
      • http://www.w3.org/2001/04/xmldsig-more#sha384
      • http://www.w3.org/2001/04/xmlenc#sha512
    • Property signature_algorithm (string)

      Enum values:

      • http://www.w3.org/2000/09/xmldsig#rsa-sha1
      • http://www.w3.org/2001/04/xmldsig-more#rsa-sha256
      • http://www.w3.org/2001/04/xmldsig-more#rsa-sha384
      • http://www.w3.org/2001/04/xmldsig-more#rsa-sha512
      • http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha1
      • http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256
        ...
Read more

3.2026020.19: Update API Client

27 Jan 14:27

Choose a tag to compare

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-identification component:

    • Added property pending_user_identifier (string)
POST /flows/executor/{flow_slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Updated ak-stage-identification component:

    • Added property pending_user_identifier (string)

3.2026020.18: Update API Client

27 Jan 13:10

Choose a tag to compare

Update API Client

What's Changed


GET /admin/file/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object):
    > Base serializer class which doesn't implement create/update methods

    • Added property themed_urls (object)

      • Property light (string)

      • Property dark (string)

GET /core/applications/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • meta_icon_themed_urls
    • Added property meta_icon_themed_urls (object)
PUT /core/applications/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • meta_icon_themed_urls
    • Added property meta_icon_themed_urls (object)
PATCH /core/applications/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • meta_icon_themed_urls
    • Added property meta_icon_themed_urls (object)
GET /core/brands/current/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • branding_favicon_themed_urls
    • branding_logo_themed_urls
    • Added property branding_logo_themed_urls (object)

    • Added property branding_favicon_themed_urls (object)

GET /flows/instances/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • background_themed_urls
    • Added property background_themed_urls (object)
PUT /flows/instances/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • background_themed_urls
    • Added property background_themed_urls (object)
PATCH /flows/instances/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • background_themed_urls
    • Added property background_themed_urls (object)
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/all/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_themed_urls
    • Added property icon_themed_urls (object)
GET /sources/group_connections/all/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
PUT /sources/group_connections/all/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
PATCH /sources/group_connections/all/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
GET /sources/group_connections/kerberos/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
PUT /sources/group_connections/kerberos/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
PATCH /sources/group_connections/kerberos/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
GET /sources/group_connections/ldap/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
PUT /sources/group_connections/ldap/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
PATCH /sources/group_connections/ldap/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
GET /sources/group_connections/oauth/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
PUT /sources/group_connections/oauth/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
PATCH /sources/group_connections/oauth/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
GET /sources/group_connections/plex/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
PUT /sources/group_connections/plex/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
PATCH /sources/group_connections/plex/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
GET /sources/group_connections/saml/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
PUT /sources/group_connections/saml/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
PATCH /sources/group_connections/saml/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
GET /sources/group_connections/telegram/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_themed_urls
      • Added property icon_themed_urls (object)
PUT /sources/group_connections/telegram/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serial...

Read more

3.2026020.17: Update API Client

26 Jan 18:58

Choose a tag to compare

Update API Client

What's Changed


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

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property assigned_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_application_name (string)

      Application's display Name.

    • Changed property assigned_backchannel_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_backchannel_application_name (string)

      Application's display Name.

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

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property assigned_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_application_name (string)

      Application's display Name.

    • Changed property assigned_backchannel_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_backchannel_application_name (string)

      Application's display Name.

PUT /providers/rac/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property assigned_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_application_name (string)

      Application's display Name.

    • Changed property assigned_backchannel_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_backchannel_application_name (string)

      Application's display Name.

PATCH /providers/rac/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property assigned_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_application_name (string)

      Application's display Name.

    • Changed property assigned_backchannel_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_backchannel_application_name (string)

      Application's display Name.

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

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property assigned_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_application_name (string)

      Application's display Name.

    • Changed property assigned_backchannel_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_backchannel_application_name (string)

      Application's display Name.

PUT /providers/radius/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property assigned_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_application_name (string)

      Application's display Name.

    • Changed property assigned_backchannel_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_backchannel_application_name (string)

      Application's display Name.

PATCH /providers/radius/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property assigned_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_application_name (string)

      Application's display Name.

    • Changed property assigned_backchannel_application_slug (string)

      Internal application name, used in URLs.

    • Changed property assigned_backchannel_application_name (string)

      Application's display Name.

GET /core/applications/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_obj (object)

      Provider Serializer

      • Changed property assigned_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_application_name (string)

        Application's display Name.

      • Changed property assigned_backchannel_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_backchannel_application_name (string)

        Application's display Name.

    • Changed property backchannel_providers_obj (array)

      Changed items (object):
      > Provider Serializer

      • Changed property assigned_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_application_name (string)

        Application's display Name.

      • Changed property assigned_backchannel_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_backchannel_application_name (string)

        Application's display Name.

PUT /core/applications/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_obj (object)

      Provider Serializer

      • Changed property assigned_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_application_name (string)

        Application's display Name.

      • Changed property assigned_backchannel_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_backchannel_application_name (string)

        Application's display Name.

    • Changed property backchannel_providers_obj (array)

      Changed items (object):
      > Provider Serializer

      • Changed property assigned_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_application_name (string)

        Application's display Name.

      • Changed property assigned_backchannel_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_backchannel_application_name (string)

        Application's display Name.

PATCH /core/applications/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_obj (object)

      Provider Serializer

      • Changed property assigned_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_application_name (string)

        Application's display Name.

      • Changed property assigned_backchannel_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_backchannel_application_name (string)

        Application's display Name.

    • Changed property backchannel_providers_obj (array)

      Changed items (object):
      > Provider Serializer

      • Changed property assigned_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_application_name (string)

        Application's display Name.

      • Changed property assigned_backchannel_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_backchannel_application_name (string)

        Application's display Name.

GET /outposts/instances/{uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property service_connection_obj (object)

      ServiceConnection Serializer

    • Changed property providers_obj (array)

      Changed items (object):
      > Provider Serializer

      • Changed property assigned_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_application_name (string)

        Application's display Name.

      • Changed property assigned_backchannel_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_backchannel_application_name (string)

        Application's display Name.

PUT /outposts/instances/{uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property service_connection_obj (object)

      ServiceConnection Serializer

    • Changed property providers_obj (array)

      Changed items (object):
      > Provider Serializer

      • Changed property assigned_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_application_name (string)

        Application's display Name.

      • Changed property assigned_backchannel_application_slug (string)

        Internal application name, used in URLs.

      • Changed property assigned_backchannel_application_name (string)

        Application's display Name.

PATCH /outposts/instances/{uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property service_connection_obj (object)

      ServiceConnection Serializer

    • Changed property `pro...

Read more

3.2026020.16: Update API Client

26 Jan 13:56

Choose a tag to compare

Update API Client

What's Changed


GET /admin/settings/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property flags (object)

      New required properties:

      • enterprise_audit_include_expanded_diff
      • Added property enterprise_audit_include_expanded_diff (boolean)
PUT /admin/settings/
Request:

Changed content type : application/json

  • Changed property flags (object)

    New required properties:

    • enterprise_audit_include_expanded_diff
    • Added property enterprise_audit_include_expanded_diff (boolean)
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property flags (object)

      New required properties:

      • enterprise_audit_include_expanded_diff
      • Added property enterprise_audit_include_expanded_diff (boolean)
PATCH /admin/settings/
Request:

Changed content type : application/json

  • Changed property flags (object)

    New required properties:

    • enterprise_audit_include_expanded_diff
    • Added property enterprise_audit_include_expanded_diff (boolean)
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property flags (object)

      New required properties:

      • enterprise_audit_include_expanded_diff
      • Added property enterprise_audit_include_expanded_diff (boolean)
GET /core/brands/current/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property flags (object)

      New required properties:

      • enterprise_audit_include_expanded_diff
      • Added property enterprise_audit_include_expanded_diff (boolean)
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.2026020.15: Update API Client

23 Jan 20:50

Choose a tag to compare

Update API Client

What's New


GET /endpoints/fleet/connectors/
POST /endpoints/fleet/connectors/
GET /endpoints/fleet/connectors/{connector_uuid}/
PUT /endpoints/fleet/connectors/{connector_uuid}/
DELETE /endpoints/fleet/connectors/{connector_uuid}/
PATCH /endpoints/fleet/connectors/{connector_uuid}/
GET /endpoints/fleet/connectors/{connector_uuid}/used_by/

What's Changed


GET /endpoints/agents/enrollment_tokens/{token_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property device_group_obj (object)

      • Added property attributes (object)
PUT /endpoints/agents/enrollment_tokens/{token_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property device_group_obj (object)

      • Added property attributes (object)
PATCH /endpoints/agents/enrollment_tokens/{token_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property device_group_obj (object)

      • Added property attributes (object)
GET /endpoints/device_access_groups/{pbm_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property attributes (object)
PUT /endpoints/device_access_groups/{pbm_uuid}/
Request:

Changed content type : application/json

  • Added property attributes (object)
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property attributes (object)
PATCH /endpoints/device_access_groups/{pbm_uuid}/
Request:

Changed content type : application/json

  • Added property attributes (object)
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property attributes (object)
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.enterprise.endpoints.connectors.fleet
    • 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_endpoints_connectors_fleet.fleetconnector
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.enterprise.endpoints.connectors.fleet
  • 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_endpoints_connectors_fleet.fleetconnector
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.enterprise.endpoints.connectors.fleet
    • 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_endpoints_connectors_fleet.fleetconnector
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.enterprise.endpoints.connectors.fleet
  • 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_endpoints_connectors_fleet.fleetconnector
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.enterprise.endpoints.connectors.fleet
    • 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_endpoints_connectors_fleet.fleetconnector
POST /endpoints/agents/connectors/check_in/
Request:

Changed content type : application/json

  • Changed property os (object)

    For example:
    {"family":"linux","name":"Ubuntu","version":"24.04.3 LTS (Noble Numbat)","arch":"amd64"}
    {"family": "windows","name":"Server 2022 Datacenter","version":"10.0.20348.4405","arch":"amd64"}
    {"family": "windows","name":"Server 2022 Datacenter","version":"10.0.20348.4405","arch":"amd64"}
    {"family": "mac_os", "name": "", "version": "26.2", "arch": "arm64"}

    • Changed property name (string)

      Operating System name, such as 'Server 2022' or 'Ubuntu'

    • Changed property version (string)

      Operating System version, must always be the version number but may contain build name

POST /endpoints/agents/enrollment_tokens/
Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property device_group_obj (object)

      • Added property attributes (object)
GET /endpoints/agents/enrollment_tokens/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):

      • Changed property device_group_obj (object)

        • Added property attributes (object)
POST /endpoints/device_access_groups/
Request:

Changed content type : application/json

  • Added property attributes (object)
Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Added property attributes (object)
GET /endpoints/device_access_groups/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):

      • Added property attributes (object)
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.enterprise.endpoints.connectors.fleet
  • 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_endpoints_connectors_fleet.fleetconnector
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.enterprise.endpoints.connectors.fleet
    • 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_endpoints_connectors_fleet.fleetconnector
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.enterprise.endpoints.connectors.fleet
      • 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_endpoints_connectors_fleet.fleetconnector
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 : `appli...

Read more