Skip to content

v3.2024083.6: Update API Client

Compare
Choose a tag to compare
@authentik-automation authentik-automation released this 14 Oct 13:38
· 8 commits to main since this release

Update API Client

What's Changed


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

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed content type : application/json

New required properties:

  • invalidation_flow
  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed content type : application/json

  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed content type : application/json

New required properties:

  • invalidation_flow
  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed content type : application/json

  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed content type : application/json

New required properties:

  • invalidation_flow
  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed content type : application/json

  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed content type : application/json

New required properties:

  • invalidation_flow
  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed content type : application/json

  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

POST /providers/saml/import_metadata/
Request:

Changed content type : multipart/form-data

New required properties:

  • invalidation_flow
  • Added property invalidation_flow (string)
GET /core/applications/{slug}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_obj (object)

      Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

    • Changed property backchannel_providers_obj (array)

      Changed items (object):
      > Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_obj (object)

      Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

    • Changed property backchannel_providers_obj (array)

      Changed items (object):
      > Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_obj (object)

      Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

    • Changed property backchannel_providers_obj (array)

      Changed items (object):
      > Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property providers_obj (array)

      Changed items (object):
      > Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property providers_obj (array)

      Changed items (object):
      > Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property providers_obj (array)

      Changed items (object):
      > Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

GET /providers/all/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed content type : application/json

New required properties:

  • invalidation_flow
  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed content type : application/json

  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

POST /providers/oauth2/
Request:

Changed content type : application/json

New required properties:

  • invalidation_flow
  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

GET /providers/oauth2/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > OAuth2Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

POST /providers/proxy/
Request:

Changed content type : application/json

New required properties:

  • invalidation_flow
  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

GET /providers/proxy/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > ProxyProvider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

POST /providers/rac/
Request:

Changed content type : application/json

New required properties:

  • invalidation_flow
  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

GET /providers/rac/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > RACProvider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

POST /providers/radius/
Request:

Changed content type : application/json

New required properties:

  • invalidation_flow
  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

GET /providers/radius/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > RadiusProvider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed content type : application/json

New required properties:

  • invalidation_flow
  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

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

Changed content type : application/json

  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

GET /rac/connection_tokens/{connection_token_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_obj (object)

      RACProvider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

    • Changed property endpoint_obj (object)

      Endpoint Serializer

      • Changed property provider_obj (object)

        RACProvider Serializer

        New required properties:

        • invalidation_flow
        • Added property invalidation_flow (string)

          Flow used ending the session from a provider.

PUT /rac/connection_tokens/{connection_token_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_obj (object)

      RACProvider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

    • Changed property endpoint_obj (object)

      Endpoint Serializer

      • Changed property provider_obj (object)

        RACProvider Serializer

        New required properties:

        • invalidation_flow
        • Added property invalidation_flow (string)

          Flow used ending the session from a provider.

PATCH /rac/connection_tokens/{connection_token_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_obj (object)

      RACProvider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

    • Changed property endpoint_obj (object)

      Endpoint Serializer

      • Changed property provider_obj (object)

        RACProvider Serializer

        New required properties:

        • invalidation_flow
        • Added property invalidation_flow (string)

          Flow used ending the session from a provider.

GET /rac/endpoints/{pbm_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_obj (object)

      RACProvider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

PUT /rac/endpoints/{pbm_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_obj (object)

      RACProvider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

PATCH /rac/endpoints/{pbm_uuid}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider_obj (object)

      RACProvider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

POST /core/applications/
Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property provider_obj (object)

      Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

    • Changed property backchannel_providers_obj (array)

      Changed items (object):
      > Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

GET /core/applications/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > Application Serializer

      • Changed property provider_obj (object)

        Provider Serializer

        New required properties:

        • invalidation_flow
        • Added property invalidation_flow (string)

          Flow used ending the session from a provider.

      • Changed property backchannel_providers_obj (array)

        Changed items (object):
        > Provider Serializer

        New required properties:

        • invalidation_flow
        • Added property invalidation_flow (string)

          Flow used ending the session from a provider.

GET /core/user_consent/{id}/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property application (object)

      Application Serializer

      • Changed property provider_obj (object)

        Provider Serializer

        New required properties:

        • invalidation_flow
        • Added property invalidation_flow (string)

          Flow used ending the session from a provider.

      • Changed property backchannel_providers_obj (array)

        Changed items (object):
        > Provider Serializer

        New required properties:

        • invalidation_flow
        • Added property invalidation_flow (string)

          Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider (object)

      OAuth2Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider (object)

      OAuth2Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property provider (object)

      OAuth2Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

POST /outposts/instances/
Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property providers_obj (array)

      Changed items (object):
      > Provider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

GET /outposts/instances/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > Outpost Serializer

      • Changed property providers_obj (array)

        Changed items (object):
        > Provider Serializer

        New required properties:

        • invalidation_flow
        • Added property invalidation_flow (string)

          Flow used ending the session from a provider.

GET /outposts/ldap/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > LDAPProvider Serializer

      New required properties:

      • unbind_flow_slug
      • Added property unbind_flow_slug (string)

        Get slug for unbind flow, defaulting to brand's default flow.

POST /providers/ldap/
Request:

Changed content type : application/json

New required properties:

  • invalidation_flow
  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

GET /providers/ldap/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > LDAPProvider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

POST /providers/saml/
Request:

Changed content type : application/json

New required properties:

  • invalidation_flow
  • Added property invalidation_flow (string)

    Flow used ending the session from a provider.

Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

GET /providers/saml/
Parameters:

Added: invalidation_flow in query

Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > SAMLProvider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

GET /rac/connection_tokens/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > ConnectionToken Serializer

      • Changed property provider_obj (object)

        RACProvider Serializer

        New required properties:

        • invalidation_flow
        • Added property invalidation_flow (string)

          Flow used ending the session from a provider.

      • Changed property endpoint_obj (object)

        Endpoint Serializer

        • Changed property provider_obj (object)

          RACProvider Serializer

          New required properties:

          • invalidation_flow
          • Added property invalidation_flow (string)

            Flow used ending the session from a provider.

POST /rac/endpoints/
Return Type:

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property provider_obj (object)

      RACProvider Serializer

      New required properties:

      • invalidation_flow
      • Added property invalidation_flow (string)

        Flow used ending the session from a provider.

GET /rac/endpoints/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > Endpoint Serializer

      • Changed property provider_obj (object)

        RACProvider Serializer

        New required properties:

        • invalidation_flow
        • Added property invalidation_flow (string)

          Flow used ending the session from a provider.

PUT /core/transactional/applications/
Request:

Changed content type : application/json

  • Changed property provider (object)

    Updated authentik_providers_oauth2.oauth2provider provider_model:
    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

    Updated authentik_providers_radius.radiusprovider provider_model:
    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

    Updated authentik_providers_proxy.proxyprovider provider_model:
    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

    Updated authentik_providers_rac.racprovider provider_model:
    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

    Updated authentik_providers_saml.samlprovider provider_model:
    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

    Updated authentik_providers_ldap.ldapprovider provider_model:
    New required properties:

    • invalidation_flow
    • Added property invalidation_flow (string)

      Flow used ending the session from a provider.

GET /core/user_consent/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object):
      > UserConsent Serializer

      • Changed property application (object)

        Application Serializer

        • Changed property provider_obj (object)

          Provider Serializer

          New required properties:

          • invalidation_flow
          • Added property invalidation_flow (string)

            Flow used ending the session from a provider.

        • Changed property backchannel_providers_obj (array)

          Changed items (object):
          > Provider Serializer

          New required properties:

          • invalidation_flow
          • Added property invalidation_flow (string)

            Flow used ending the session from a provider.

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

Changed response : 200 OK

  • Changed content type : application/json

    Added 'ak-stage-session-end' 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 pending_user (string)

    • Property pending_user_avatar (string)

    • Property application_name (string)

    • Property application_launch_url (string)

    • Property invalidation_flow_url (string)

    • Property brand_name (string)

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

Changed response : 200 OK

  • Changed content type : application/json

    Added 'ak-stage-session-end' component:

GET /oauth2/access_tokens/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

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

      • Changed property provider (object)

        OAuth2Provider Serializer

        New required properties:

        • invalidation_flow
        • Added property invalidation_flow (string)

          Flow used ending the session from a provider.

GET /oauth2/authorization_codes/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

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

      • Changed property provider (object)

        OAuth2Provider Serializer

        New required properties:

        • invalidation_flow
        • Added property invalidation_flow (string)

          Flow used ending the session from a provider.

GET /oauth2/refresh_tokens/
Return Type:

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

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

      • Changed property provider (object)

        OAuth2Provider Serializer

        New required properties:

        • invalidation_flow
        • Added property invalidation_flow (string)

          Flow used ending the session from a provider.