Skip to content

Releases: goauthentik/client-go

v3.2025120.16: Update API Client

03 Dec 13:18

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 service_provider_config_cache_timeout (string)

      Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.

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

Changed content type : application/json

  • Added property service_provider_config_cache_timeout (string)

    Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property service_provider_config_cache_timeout (string)

      Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.

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

Changed content type : application/json

  • Added property service_provider_config_cache_timeout (string)

    Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property service_provider_config_cache_timeout (string)

      Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.

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 service_provider_config_cache_timeout (string)

    Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.

Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Added property service_provider_config_cache_timeout (string)

      Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.

GET /providers/scim/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > SCIMProvider Serializer

      • Added property service_provider_config_cache_timeout (string)

        Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.

PUT /core/transactional/applications/
Request:

Changed content type : application/json

  • Changed property provider (object)

    Updated authentik_providers_scim.scimprovider provider_model:

    • Added property service_provider_config_cache_timeout (string)

      Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.

v3.2025120.15: Update API Client

02 Dec 21:35

Choose a tag to compare

Update API Client

What's Changed


GET /endpoints/agents/connectors/{connector_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property challenge_idle_timeout (string)

    • Added property challenge_trigger_check_in (boolean)

PUT /endpoints/agents/connectors/{connector_uuid}/
Request:

Changed content type : application/json

  • Added property challenge_idle_timeout (string)

  • Added property challenge_trigger_check_in (boolean)

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property challenge_idle_timeout (string)

    • Added property challenge_trigger_check_in (boolean)

PATCH /endpoints/agents/connectors/{connector_uuid}/
Request:

Changed content type : application/json

  • Added property challenge_idle_timeout (string)

  • Added property challenge_trigger_check_in (boolean)

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property challenge_idle_timeout (string)

    • Added property challenge_trigger_check_in (boolean)

POST /endpoints/agents/connectors/
Request:

Changed content type : application/json

  • Added property challenge_idle_timeout (string)

  • Added property challenge_trigger_check_in (boolean)

Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Added property challenge_idle_timeout (string)

    • Added property challenge_trigger_check_in (boolean)

GET /endpoints/agents/connectors/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):

      • Added property challenge_idle_timeout (string)

      • Added property challenge_trigger_check_in (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)
GET /flows/executor/{flow_slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Updated ak-stage-endpoint-agent component:
    New required properties:

    • challenge_idle_timeout
    • Added property challenge_idle_timeout (integer)
POST /flows/executor/{flow_slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Updated ak-stage-endpoint-agent component:
    New required properties:

    • challenge_idle_timeout
    • Added property challenge_idle_timeout (integer)

v3.2025120.14: Update API Client

02 Dec 18:26

Choose a tag to compare

Update API Client

What's New


GET /endpoints/devices/summary/
GET /stages/endpoints/
POST /stages/endpoints/
GET /stages/endpoints/{stage_uuid}/
PUT /stages/endpoints/{stage_uuid}/
DELETE /stages/endpoints/{stage_uuid}/
PATCH /stages/endpoints/{stage_uuid}/
GET /stages/endpoints/{stage_uuid}/used_by/

What's Changed


GET /endpoints/connectors/types/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object):
    > Types of an object that can be created

    • Added property deprecated (boolean)
GET /events/events/actions/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object):
    > Types of an object that can be created

    • Added property deprecated (boolean)
GET /outposts/service_connections/all/types/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object):
    > Types of an object that can be created

    • Added property deprecated (boolean)
GET /policies/all/types/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object):
    > Types of an object that can be created

    • Added property deprecated (boolean)
GET /propertymappings/all/types/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object):
    > Types of an object that can be created

    • Added property deprecated (boolean)
GET /providers/all/types/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object):
    > Types of an object that can be created

    • Added property deprecated (boolean)
GET /sources/all/types/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object):
    > Types of an object that can be created

    • Added property deprecated (boolean)
GET /stages/all/types/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object):
    > Types of an object that can be created

    • Added property deprecated (boolean)
GET /stages/email/templates/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object):
    > Types of an object that can be created

    • Added property deprecated (boolean)
GET /endpoints/agents/connectors/agent_config/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • jwks_auth
    • jwks_challenge

    New optional properties:

    • jwks
    • Added property jwks_auth (object)

    • Added property jwks_challenge (object)

    • Deleted property jwks (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)
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

    Added 'ak-stage-endpoint-agent' component:

    • Property flow_info (object)

      Contextual flow information for a challenge

      • Property title (string)

      • Property background (string)

      • Property cancel_url (string)

      • Property layout (string)

        Enum values:

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

    • Property response_errors (object)

    • Property challenge (string)

POST /flows/executor/{flow_slug}/
Request:

Changed content type : application/json

Added 'ak-stage-endpoint-agent' component:

  • Property component (string)

  • Property response (string)

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    Added 'ak-stage-endpoint-agent' component:

v3.2025120.13: Update API Client

02 Dec 17:51

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 /sources/oauth/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_type (string)

      Added enum value:

      • slack
PUT /sources/oauth/{slug}/
Request:

Changed content type : application/json

  • Changed property provider_type (string)

    Added enum value:

    • slack
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_type (string)

      Added enum value:

      • slack
PATCH /sources/oauth/{slug}/
Request:

Changed content type : application/json

  • Changed property provider_type (string)

    Added enum value:

    • slack
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_type (string)

      Added enum value:

      • slack
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:

    • slack
Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property provider_type (string)

      Added enum value:

      • slack
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:

        • slack

v3.2025120.11: Update API Client

30 Nov 23:35

Choose a tag to compare

Update API Client

What's New


POST /endpoints/agents/psso/register/device/
POST /endpoints/agents/psso/register/user/

What's Changed


GET /endpoints/agents/connectors/{connector_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property auth_session_duration (string)
PUT /endpoints/agents/connectors/{connector_uuid}/
Request:

Changed content type : application/json

  • Added property auth_session_duration (string)
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property auth_session_duration (string)
PATCH /endpoints/agents/connectors/{connector_uuid}/
Request:

Changed content type : application/json

  • Added property auth_session_duration (string)
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property auth_session_duration (string)
POST /endpoints/agents/connectors/
Request:

Changed content type : application/json

  • Added property auth_session_duration (string)
Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Added property auth_session_duration (string)
GET /endpoints/agents/connectors/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):

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

v3.2025120.10: Update API Client

28 Nov 16:40

Choose a tag to compare

Update API Client

What's Changed


GET /endpoints/agents/connectors/agent_config/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property authorization_flow (string)
POST /endpoints/agents/connectors/check_in/
Request:

Changed content type : application/json

  • Changed property hardware (object)

    New optional properties:

    • manufacturer
    • model
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 /endpoints/devices/{device_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New optional properties:

    • access_group_obj
    • Changed property facts (object)

      • Changed property data (object)

        • Changed property hardware (object)

          New optional properties:

          • manufacturer
          • model
PUT /endpoints/devices/{device_uuid}/
Request:

Changed content type : application/json

New optional properties:

  • access_group_obj
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New optional properties:

    • access_group_obj
    • Changed property facts (object)

      • Changed property data (object)

        • Changed property hardware (object)

          New optional properties:

          • manufacturer
          • model
PATCH /endpoints/devices/{device_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New optional properties:

    • access_group_obj
    • Changed property facts (object)

      • Changed property data (object)

        • Changed property hardware (object)

          New optional properties:

          • manufacturer
          • model
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 /endpoints/devices/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):

      New optional properties:

      • access_group_obj
      • Changed property facts (object)

        • Changed property data (object)

          • Changed property hardware (object)

            New optional properties:

            • manufacturer
            • model

v3.2025120.9: Update API Client

27 Nov 18:26

Choose a tag to compare

Update API Client

What's Changed


POST /core/tokens/{identifier}/set_key/
Request:

Changed content type : application/json

GET /endpoints/agents/connectors/agent_config/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • device_id
    • Added property device_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 /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)

v3.2025120.8: Update API Client

27 Nov 18:09

Choose a tag to compare

Update API Client

What's New


POST /endpoints/agents/connectors/auth_fed/
POST /endpoints/agents/connectors/auth_ia/
GET /endpoints/device_access_groups/
POST /endpoints/device_access_groups/
GET /endpoints/device_access_groups/{pbm_uuid}/
PUT /endpoints/device_access_groups/{pbm_uuid}/
DELETE /endpoints/device_access_groups/{pbm_uuid}/
PATCH /endpoints/device_access_groups/{pbm_uuid}/
GET /endpoints/device_access_groups/{pbm_uuid}/used_by/

What's Deleted


GET /endpoints/device_groups/
POST /endpoints/device_groups/
GET /endpoints/device_groups/{pbm_uuid}/
PUT /endpoints/device_groups/{pbm_uuid}/
DELETE /endpoints/device_groups/{pbm_uuid}/
PATCH /endpoints/device_groups/{pbm_uuid}/
GET /endpoints/device_groups/{pbm_uuid}/used_by/

What's Changed


GET /endpoints/agents/connectors/{connector_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property authorization_flow (string)

    • Added property jwt_federation_providers (array)

      Items (integer):

    • Deleted property authentication_flow (string)

PUT /endpoints/agents/connectors/{connector_uuid}/
Request:

Changed content type : application/json

  • Added property authorization_flow (string)

  • Added property jwt_federation_providers (array)

  • Deleted property authentication_flow (string)

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property authorization_flow (string)

    • Added property jwt_federation_providers (array)

    • Deleted property authentication_flow (string)

PATCH /endpoints/agents/connectors/{connector_uuid}/
Request:

Changed content type : application/json

  • Added property authorization_flow (string)

  • Added property jwt_federation_providers (array)

  • Deleted property authentication_flow (string)

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property authorization_flow (string)

    • Added property jwt_federation_providers (array)

    • Deleted property authentication_flow (string)

GET /endpoints/agents/connectors/agent_config/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • authorization_flow
    • jwks
    • system_config

    New optional properties:

    • authentication_flow
    • Added property authorization_flow (string)

    • Added property jwks (object)

    • Added property system_config (object)

      • Property error_reporting (object)

        Config for error reporting

        • Property enabled (boolean)

        • Property sentry_dsn (string)

        • Property environment (string)

        • Property send_pii (boolean)

        • Property traces_sample_rate (number)

      • Property capabilities (array)

        Items (string):

        Enum values:

        • can_save_media
        • can_geo_ip
        • can_asn
        • can_impersonate
        • can_debug
        • is_enterprise
      • Property cache_timeout (integer)

      • Property cache_timeout_flows (integer)

      • Property cache_timeout_policies (integer)

    • Deleted property authentication_flow (string)

POST /endpoints/agents/connectors/enroll/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property expires_in (integer)
GET /endpoints/device_bindings/{policy_binding_uuid}/
Parameters:

Changed: policy_binding_uuid in path

A UUID string identifying this Device User binding.

PUT /endpoints/device_bindings/{policy_binding_uuid}/
Parameters:

Changed: policy_binding_uuid in path

A UUID string identifying this Device User binding.

DELETE /endpoints/device_bindings/{policy_binding_uuid}/
Parameters:

Changed: policy_binding_uuid in path

A UUID string identifying this Device User binding.

PATCH /endpoints/device_bindings/{policy_binding_uuid}/
Parameters:

Changed: policy_binding_uuid in path

A UUID string identifying this Device User binding.

POST /endpoints/agents/connectors/
Request:

Changed content type : application/json

  • Added property authorization_flow (string)

  • Added property jwt_federation_providers (array)

  • Deleted property authentication_flow (string)

Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Added property authorization_flow (string)

    • Added property jwt_federation_providers (array)

    • Deleted property authentication_flow (string)

GET /endpoints/agents/connectors/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):

      • Added property authorization_flow (string)

      • Added property jwt_federation_providers (array)

      • Deleted property authentication_flow (string)

POST /endpoints/agents/connectors/check_in/
Request:

Changed content type : application/json

  • Added property users (array)

    Items (object):

    • Property id (string)

    • Property username (string)

    • Property name (string)

    • Property home (string)

  • Added property groups (array)

    Items (object):

    • Property id (string)

    • Property name (string)

GET /endpoints/device_bindings/{policy_binding_uuid}/used_by/
Parameters:

Changed: policy_binding_uuid in path

A UUID string identifying this Device User binding.

GET /endpoints/devices/{device_uuid}/used_by/
Parameters:

Changed: device_uuid in path

A UUID string identifying this Device.

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)
DELETE /endpoints/devices/{device_uuid}/
Parameters:

Changed: device_uuid in path

A UUID string identifying this Device.

GET /endpoints/devices/{device_uuid}/
Parameters:

Changed: device_uuid in path

A UUID string identifying this Device.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • access_group_obj

    New optional properties:

    • group_obj
    • Added property access_group (string)

    • Added property access_group_obj (object)

      • Property pbm_uuid (string)

      • Property name (string)

    • Deleted property group (string)

    • Deleted property group_obj (object)

    • Changed property facts (object)

      • Changed property data (object)

        • Added property users (array)

          Items (object):

          • Property id (string)

          • Property username (string)

          • Property name (string)

          • Property home (string)

        • Added property groups (array)

          Items (object):

          • Property id (string)

          • Property name (string)

PUT /endpoints/devices/{device_uuid}/
Parameters:

Changed: device_uuid in path

A UUID string identifying this Device.

Request:

Changed content type : application/json

New required properties:

  • access_group_obj

New optional properties:

  • group_obj
  • Added property access_group (string)

  • Added property access_group_obj (object)

    • Property name (string)
  • Deleted property group (string)

  • Deleted property group_obj (object)

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • access_group_obj

    New optional properties:

    • group_obj
    • Added property access_group (string)

    • Added property access_group_obj (object)

    • Deleted property group (string)

    • Deleted property group_obj (object)

    • Changed property facts (object)

      • Changed property data (object)

        • Added property users (array)

        • Added property groups (array)

PATCH /endpoints/devices/{device_uuid}/
Parameters:

Changed: device_uuid in path

A UUID string identifying this Device.

Request:

Changed content type : application/json

  • Added property access_group (string)

  • Added property access_group_obj (object)

  • Deleted property group (string)

  • Deleted property group_obj (object)

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • access_group_obj

    New optional properties:

    • group_obj
    • Added property access_group (string)

    • Added property access_group_obj (object)

    • Deleted property group (string)

    • Deleted propert...

Read more

v3.2025120.7: Update API Client

25 Nov 18:09

Choose a tag to compare

Update API Client

What's Changed


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

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property slug (string)

      Internal application name, used in URLs.

PUT /core/applications/{slug}/
Request:

Changed content type : application/json

  • Changed property slug (string)

    Internal application name, used in URLs.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property slug (string)

      Internal application name, used in URLs.

PATCH /core/applications/{slug}/
Request:

Changed content type : application/json

  • Changed property slug (string)

    Internal application name, used in URLs.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property slug (string)

      Internal application name, used in URLs.

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

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property slug (string)

      Visible in the URL.

PUT /flows/instances/{slug}/
Request:

Changed content type : application/json

  • Changed property slug (string)

    Visible in the URL.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property slug (string)

      Visible in the URL.

PATCH /flows/instances/{slug}/
Request:

Changed content type : application/json

  • Changed property slug (string)

    Visible in the URL.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property slug (string)

      Visible in the URL.

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

    • Changed property slug (string)

      Internal source name, used in URLs.

GET /sources/group_connections/all/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

PUT /sources/group_connections/all/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

PATCH /sources/group_connections/all/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

GET /sources/group_connections/kerberos/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

PUT /sources/group_connections/kerberos/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

PATCH /sources/group_connections/kerberos/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

GET /sources/group_connections/ldap/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

PUT /sources/group_connections/ldap/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

PATCH /sources/group_connections/ldap/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

GET /sources/group_connections/oauth/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

PUT /sources/group_connections/oauth/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

PATCH /sources/group_connections/oauth/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

GET /sources/group_connections/plex/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

PUT /sources/group_connections/plex/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

PATCH /sources/group_connections/plex/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

GET /sources/group_connections/saml/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

PUT /sources/group_connections/saml/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

PATCH /sources/group_connections/saml/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

GET /sources/group_connections/telegram/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

PUT /sources/group_connections/telegram/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

PATCH /sources/group_connections/telegram/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Changed property slug (string)

        Internal source name, used in URLs.

GET /sources/kerberos/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property slug (string)

      Internal source name, used in URLs.

PUT /sources/kerberos/{slug}/
Request:

Changed content type : application/json

  • Changed property slug (string)

    Internal source name, ...

Read more

v3.2025120.6: Update API Client

25 Nov 16:08

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 /sources/all/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property promoted (boolean)

      When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

GET /sources/group_connections/all/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PUT /sources/group_connections/all/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PATCH /sources/group_connections/all/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

GET /sources/group_connections/kerberos/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PUT /sources/group_connections/kerberos/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PATCH /sources/group_connections/kerberos/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

GET /sources/group_connections/ldap/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PUT /sources/group_connections/ldap/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PATCH /sources/group_connections/ldap/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

GET /sources/group_connections/oauth/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PUT /sources/group_connections/oauth/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PATCH /sources/group_connections/oauth/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

GET /sources/group_connections/plex/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PUT /sources/group_connections/plex/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PATCH /sources/group_connections/plex/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

GET /sources/group_connections/saml/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PUT /sources/group_connections/saml/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PATCH /sources/group_connections/saml/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

GET /sources/group_connections/telegram/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PUT /sources/group_connections/telegram/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PATCH /sources/group_connections/telegram/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      • Added property promoted (boolean)

        When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

GET /sources/kerberos/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Added property promoted (boolean)

      When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

PUT /sources/kerberos/{slug}/
Request:

Changed content type : application/json

  • Added property promoted (boolean)

    When enabled, this source will be displayed as a prominent button on the login page, instead of a...

Read more