v3.2024122.3: Update API Client

Update API Client

What's Changed

---

GET /sources/kerberos/

Parameters:

Added: pbm_uuid in query

GET /sources/ldap/

Parameters:

Added: pbm_uuid in query

GET /sources/oauth/

Parameters:

Added: pbm_uuid in query

GET /sources/plex/

Parameters:

Added: pbm_uuid in query

GET /sources/saml/

Parameters:

Added: pbm_uuid in query

GET /sources/scim/

Parameters:

Added: pbm_uuid in query

v3.2024122.2: Update API Client

Update API Client

What's Changed

---

GET /authenticators/admin/duo/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user

  • Added property user (object)

    • Property pk (integer)

    • Property username (string)

      Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

    • Property name (string)

      User's display name.

    • Property is_active (boolean)

      Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

    • Property last_login (string)

    • Property email (string)

    • Property attributes (object)

    • Property uid (string)

PUT /authenticators/admin/duo/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PATCH /authenticators/admin/duo/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

GET /authenticators/admin/sms/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PUT /authenticators/admin/sms/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PATCH /authenticators/admin/sms/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

GET /authenticators/admin/totp/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PUT /authenticators/admin/totp/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PATCH /authenticators/admin/totp/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

GET /authenticators/admin/webauthn/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PUT /authenticators/admin/webauthn/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PATCH /authenticators/admin/webauthn/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

GET /authenticators/duo/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PUT /authenticators/duo/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PATCH /authenticators/duo/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

GET /authenticators/sms/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PUT /authenticators/sms/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PATCH /authenticators/sms/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

GET /authenticators/totp/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PUT /authenticators/totp/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PATCH /authenticators/totp/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

GET /authenticators/webauthn/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PUT /authenticators/webauthn/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PATCH /authenticators/webauthn/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

POST /authenticators/admin/duo/

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

GET /authenticators/admin/duo/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Serializer for Duo authenticator devices

    New required properties:

    • user
    • Added property user (object)

POST /authenticators/admin/sms/

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

GET /authenticators/admin/sms/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Serializer for sms authenticator devices

    New required properties:

    • user
    • Added property user (object)

GET /authenticators/admin/static/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PUT /authenticators/admin/static/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PATCH /authenticators/admin/static/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

POST /authenticators/admin/totp/

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

GET /authenticators/admin/totp/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Serializer for totp authenticator devices

    New required properties:

    • user
    • Added property user (object)

POST /authenticators/admin/webauthn/

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

GET /authenticators/admin/webauthn/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Serializer for WebAuthn authenticator devices

    New required properties:

    • user
    • Added property user (object)

GET /authenticators/duo/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Serializer for Duo authenticator devices

    New required properties:

    • user
    • Added property user (object)

GET /authenticators/sms/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Serializer for sms authenticator devices

    New required properties:

    • user
    • Added property user (object)

GET /authenticators/static/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • user
  • Added property user (object)

PUT /authenticators/static/{id}/

Return Type:

Ch...

v3.2024122.1

Update API Client

v3.2024121.3: Update API Client

Update API Client

What's Changed

---

GET /providers/saml/{id}/metadata/

Return Type:

Changed response : 200 OK

• New content type : application/xml

v3.2024121.2: Update API Client

Update API Client

What's Changed

---

GET /admin/workers/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

v3.2024121.1

Update API Client

v3.2024120.2: Update API Client

Update API Client

What's Changed

---

GET /flows/bindings/{fsb_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property re_evaluate_policies (boolean)

    Evaluate policies when the Stage is presented to the user.

PUT /flows/bindings/{fsb_uuid}/

Request:

Changed content type : application/json

• Changed property re_evaluate_policies (boolean)

  Evaluate policies when the Stage is presented to the user.

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property re_evaluate_policies (boolean)

    Evaluate policies when the Stage is presented to the user.

PATCH /flows/bindings/{fsb_uuid}/

Request:

Changed content type : application/json

• Changed property re_evaluate_policies (boolean)

  Evaluate policies when the Stage is presented to the user.

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property re_evaluate_policies (boolean)

    Evaluate policies when the Stage is presented to the user.

POST /flows/bindings/

Request:

Changed content type : application/json

• Changed property re_evaluate_policies (boolean)

  Evaluate policies when the Stage is presented to the user.

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property re_evaluate_policies (boolean)

    Evaluate policies when the Stage is presented to the user.

GET /flows/bindings/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > FlowStageBinding Serializer

    • Changed property re_evaluate_policies (boolean)

      Evaluate policies when the Stage is presented to the user.

GET /flows/inspector/{flow_slug}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property plans (array)

    Changed items (object):
    > Serializer for an active FlowPlan

    • Changed property next_planned_stage (object)

      FlowStageBinding Serializer

      • Changed property re_evaluate_policies (boolean)

        Evaluate policies when the Stage is presented to the user.

    • Changed property current_stage (object)

      FlowStageBinding Serializer

      • Changed property re_evaluate_policies (boolean)

        Evaluate policies when the Stage is presented to the user.

v3.2024120.1

Update API Client

v3.2024105.5: Update API Client

Update API Client

What's New

---

GET /core/application_entitlements/

POST /core/application_entitlements/

GET /core/application_entitlements/{pbm_uuid}/

PUT /core/application_entitlements/{pbm_uuid}/

DELETE /core/application_entitlements/{pbm_uuid}/

PATCH /core/application_entitlements/{pbm_uuid}/

GET /core/application_entitlements/{pbm_uuid}/used_by/

What's Changed

---

GET /policies/event_matcher/{policy_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • 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_core.applicationentitlement

PUT /policies/event_matcher/{policy_uuid}/

Request:

Changed content type : application/json

• 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_core.applicationentitlement

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • 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_core.applicationentitlement

PATCH /policies/event_matcher/{policy_uuid}/

Request:

Changed content type : application/json

• 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_core.applicationentitlement

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • 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_core.applicationentitlement

POST /policies/event_matcher/

Request:

Changed content type : application/json

• 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_core.applicationentitlement

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • 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_core.applicationentitlement

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 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_core.applicationentitlement

POST /rbac/permissions/assigned_by_roles/{uuid}/assign/

Request:

Changed content type : application/json

• Changed property model (string)

  Added enum value:

  • authentik_core.applicationentitlement

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

Request:

Changed content type : application/json

• Changed property model (string)

  Added enum value:

  • authentik_core.applicationentitlement

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

Request:

Changed content type : application/json

• Changed property model (string)

  Added enum value:

  • authentik_core.applicationentitlement

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

Request:

Changed content type : application/json

• Changed property model (string)

  Added enum value:

  • authentik_core.applicationentitlement

GET /rbac/permissions/assigned_by_roles/

Parameters:

Changed: model in query

GET /rbac/permissions/assigned_by_users/

Parameters:

Changed: model in query

GET /flows/executor/{flow_slug}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  Updated ak-stage-identification component:

  • Changed property captcha_stage (object -> object)

    Site public key

POST /flows/executor/{flow_slug}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  Updated ak-stage-identification component:

  • Changed property captcha_stage (object -> object)

    Site public key

v3.2024105.4: Update API Client

Update API Client

What's Changed

---

GET /sources/group_connections/kerberos/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

    • Property pk (string)

    • Property name (string)

      Source's display Name.

    • Property slug (string)

      Internal source name, used in URLs.

    • Property enabled (boolean)

    • Property authentication_flow (string)

      Flow to use when authenticating existing users.

    • Property enrollment_flow (string)

      Flow to use when enrolling new users.

    • Property user_property_mappings (array)

      Items (string):

    • Property group_property_mappings (array)

    • Property component (string)

      Get object component so that we know how to edit the object

    • Property verbose_name (string)

      Return object's verbose_name

    • Property verbose_name_plural (string)

      Return object's plural verbose_name

    • Property meta_model_name (string)

      Return internal model name

    • Property policy_engine_mode (string)

      Enum values:

      • all
      • any

    • Property user_matching_mode (string)

      How the source determines if an existing user should be authenticated or a new user enrolled.

      Enum values:

      • identifier
      • email_link
      • email_deny
      • username_link
      • username_deny

    • Property managed (string)

      Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.

    • Property user_path_template (string)

    • Property icon (string)

      Get the URL to the Icon. If the name is /static or
      starts with http it is returned as-is

  • Changed property group (string)

  • Changed property source (object -> string)

  • Changed property identifier (string)

PUT /sources/group_connections/kerberos/{id}/

Request:

New content type : application/json

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property group (string)

  • Changed property source (object -> string)

  • Changed property identifier (string)

PATCH /sources/group_connections/kerberos/{id}/

Request:

New content type : application/json

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property group (string)

  • Changed property source (object -> string)

  • Changed property identifier (string)

GET /sources/group_connections/oauth/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property group (string)

  • Changed property source (object -> string)

  • Changed property identifier (string)

PUT /sources/group_connections/oauth/{id}/

Request:

New content type : application/json

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property group (string)

  • Changed property source (object -> string)

  • Changed property identifier (string)

PATCH /sources/group_connections/oauth/{id}/

Request:

New content type : application/json

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property group (string)

  • Changed property source (object -> string)

  • Changed property identifier (string)

GET /sources/group_connections/plex/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property group (string)

  • Changed property source (object -> string)

  • Changed property identifier (string)

PUT /sources/group_connections/plex/{id}/

Request:

New content type : application/json

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property group (string)

  • Changed property source (object -> string)

  • Changed property identifier (string)

PATCH /sources/group_connections/plex/{id}/

Request:

New content type : application/json

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property group (string)

  • Changed property source (object -> string)

  • Changed property identifier (string)

GET /sources/group_connections/saml/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property group (string)

  • Changed property source (object -> string)

  • Changed property identifier (string)

PUT /sources/group_connections/saml/{id}/

Request:

New content type : application/json

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property group (string)

  • Changed property source (object -> string)

  • Changed property identifier (string)

PATCH /sources/group_connections/saml/{id}/

Request:

New content type : application/json

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property group (string)

  • Changed property source (object -> string)

  • Changed property identifier (string)

GET /sources/user_connections/all/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property user (integer)

  • Changed property source (object -> string)

PUT /sources/user_connections/all/{id}/

Request:

New content type : application/json

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property user (integer)

  • Changed property source (object -> string)

PATCH /sources/user_connections/all/{id}/

Request:

New content type : application/json

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property user (integer)

  • Changed property source (object -> string)

GET /sources/user_connections/kerberos/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property source (object -> string)

PUT /sources/user_connections/kerberos/{id}/

Request:

Changed content type : application/json

New required properties:

• source

• Added property source (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property source (object -> string)

PATCH /sources/user_connections/kerberos/{id}/

Request:

Changed content type : application/json

• Added property source (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property source (object -> string)

GET /sources/user_connections/oauth/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property user (integer)

  • Changed property source (object -> string)

PUT /sources/user_connections/oauth/{id}/

Request:

Changed content type : application/json

New required properties:

• source
• user

• Added property user (integer)

• Added property source (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • source_obj
  • Added prop...