v3.2024105.3: 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 property source_obj (object)

  • Changed property user (integer)

  • Changed property source (object -> string)

PATCH /sources/user_connections/oauth/{id}/

Request:

Changed content type : application/json

• 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 property source_obj (object)

  • Changed property user (integer)

  • Changed property source (object -> string)

GET /sources/user_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 user (integer)

  • Changed property source (object -> string)

PUT /sources/user_connections/plex/{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 property source_obj (object)

  • Changed property user (integer)

  • Changed property source (object -> string)

PATCH /sources/user_connections/plex/{id}/

Request:

Changed content type : application/json

• 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 property source_obj (object)

  • Changed property user (integer)

  • Changed property source (object -> string)

GET /sources/user_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 user (integer)

  • Changed property source (object -> string)

PUT /sources/user_connections/saml/{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 property source_obj (object)

  • Changed property user (integer)

  • Changed property source (object -> string)

PATCH /sources/user_connections/saml/{id}/

Request:

Changed content type : application/json

• 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 property source_obj (object)

  • Changed property user (integer)

  • Changed property source (object -> string)

GET /sources/group_connections/kerberos/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > OAuth Group-Source connection Serializer

    New required properties:

    • source_obj

    • Added property source_obj (object)

    • Changed property group (string)

    • Changed property source (object -> string)

    • Changed property identifier (string)

POST /sources/group_connections/oauth/

Request:

New content type : application/json

Return Type:

Changed response : 201 Created

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

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > OAuth Group-Source connection Serializer

    New required properties:

    • source_obj

    • Added property source_obj (object)

    • Changed property group (string)

    • Changed property source (object -> string)

    • Changed property identifier (string)

POST /sources/group_connections/plex/

Request:

New content type : application/json

Return Type:

Changed response : 201 Created

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

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Plex Group-Source connection Serializer

    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/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > OAuth Group-Source connection Serializer

    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/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > User source connection

    New required properties:

    • source_obj

    • Added property source_obj (object)

    • Changed property user (integer)

    • Changed property source (object -> string)

POST /sources/user_connections/kerberos/

Request:

Changed content type : application/json

New required properties:

• source

• Added property source (string)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  New required properties:

  • source_obj

  • Added property source_obj (object)

  • Changed property source (object -> string)

GET /sources/user_connections/kerberos/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Kerberos Source Serializer

    New required properties:

    • source_obj

    • Added property source_obj (object)

    • Changed property source (object -> string)

POST /sources/user_connections/oauth/

Request:

Changed content type : application/json

New required properties:

• source
• user

• Added property user (integer)

• Added property source (string)

Return Type:

Changed response : 201 Created

• 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/oauth/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > OAuth Source Serializer

    New required properties:

    • source_obj

    • Added property source_obj (object)

    • Changed property user (integer)

    • Changed property source (object -> string)

POST /sources/user_connections/plex/

Request:

Changed content type : application/json

New required properties:

• source
• user

• Added property user (integer)

• Added property source (string)

Return Type:

Changed response : 201 Created

• 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/plex/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Plex Source connection Serializer

    New required properties:

    • source_obj

    • Added property source_obj (object)

    • Changed property user (integer)

    • Changed property source (object -> string)

POST /sources/user_connections/saml/

Request:

Changed content type : application/json

New required properties:

• source
• user

• Added property user (integer)

• Added property source (string)

Return Type:

Changed response : 201 Created

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

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > SAML Source Serializer

    New required properties:

    • source_obj

    • Added property source_obj (object)

    • Changed property user (integer)

    • Changed property source (object -> string)