v3.2025023.1

Update API Client

v3.2025022.6: Update API Client

Update API Client

What's Changed

---

GET /events/transports/{uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property webhook_mapping_body (string)

    Customize the body of the request. Mapping should return data that is JSON-serializable.

  • Added property webhook_mapping_headers (string)

    Configure additional headers to be sent. Mapping should return a dictionary of key-value pairs

  • Deleted property webhook_mapping (string)

PUT /events/transports/{uuid}/

Request:

Changed content type : application/json

• Added property webhook_mapping_body (string)

  Customize the body of the request. Mapping should return data that is JSON-serializable.

• Added property webhook_mapping_headers (string)

  Configure additional headers to be sent. Mapping should return a dictionary of key-value pairs

• Deleted property webhook_mapping (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property webhook_mapping_body (string)

    Customize the body of the request. Mapping should return data that is JSON-serializable.

  • Added property webhook_mapping_headers (string)

    Configure additional headers to be sent. Mapping should return a dictionary of key-value pairs

  • Deleted property webhook_mapping (string)

PATCH /events/transports/{uuid}/

Request:

Changed content type : application/json

• Added property webhook_mapping_body (string)

  Customize the body of the request. Mapping should return data that is JSON-serializable.

• Added property webhook_mapping_headers (string)

  Configure additional headers to be sent. Mapping should return a dictionary of key-value pairs

• Deleted property webhook_mapping (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property webhook_mapping_body (string)

    Customize the body of the request. Mapping should return data that is JSON-serializable.

  • Added property webhook_mapping_headers (string)

    Configure additional headers to be sent. Mapping should return a dictionary of key-value pairs

  • Deleted property webhook_mapping (string)

POST /events/transports/

Request:

Changed content type : application/json

• Added property webhook_mapping_body (string)

  Customize the body of the request. Mapping should return data that is JSON-serializable.

• Added property webhook_mapping_headers (string)

  Configure additional headers to be sent. Mapping should return a dictionary of key-value pairs

• Deleted property webhook_mapping (string)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property webhook_mapping_body (string)

    Customize the body of the request. Mapping should return data that is JSON-serializable.

  • Added property webhook_mapping_headers (string)

    Configure additional headers to be sent. Mapping should return a dictionary of key-value pairs

  • Deleted property webhook_mapping (string)

GET /events/transports/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > NotificationTransport Serializer

    • Added property webhook_mapping_body (string)

      Customize the body of the request. Mapping should return data that is JSON-serializable.

    • Added property webhook_mapping_headers (string)

      Configure additional headers to be sent. Mapping should return a dictionary of key-value pairs

    • Deleted property webhook_mapping (string)

v3.2025022.5: Update API Client

Update API Client

What's Changed

---

GET /core/brands/{brand_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property branding_default_flow_background (string)

PUT /core/brands/{brand_uuid}/

Request:

Changed content type : application/json

• Added property branding_default_flow_background (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property branding_default_flow_background (string)

PATCH /core/brands/{brand_uuid}/

Request:

Changed content type : application/json

• Added property branding_default_flow_background (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property branding_default_flow_background (string)

POST /core/brands/

Request:

Changed content type : application/json

• Added property branding_default_flow_background (string)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property branding_default_flow_background (string)

GET /core/brands/

Parameters:

Added: branding_default_flow_background in query

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Brand Serializer

    • Added property branding_default_flow_background (string)

v3.2025022.4: Update API Client

Update API Client

What's Changed

---

GET /core/brands/{brand_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property branding_custom_css (string)

PUT /core/brands/{brand_uuid}/

Request:

Changed content type : application/json

• Added property branding_custom_css (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property branding_custom_css (string)

PATCH /core/brands/{brand_uuid}/

Request:

Changed content type : application/json

• Added property branding_custom_css (string)

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property branding_custom_css (string)

POST /core/brands/

Request:

Changed content type : application/json

• Added property branding_custom_css (string)

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property branding_custom_css (string)

GET /core/brands/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > Brand Serializer

    • Added property branding_custom_css (string)

GET /core/brands/current/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • branding_custom_css
  • Added property branding_custom_css (string)

v3.2025022.3: Update API Client

Update API Client

What's Changed

---

GET /providers/saml/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property authn_context_class_ref_mapping (string)

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

PUT /providers/saml/{id}/

Request:

Changed content type : application/json

• Added property authn_context_class_ref_mapping (string)

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

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property authn_context_class_ref_mapping (string)

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

PATCH /providers/saml/{id}/

Request:

Changed content type : application/json

• Added property authn_context_class_ref_mapping (string)

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

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property authn_context_class_ref_mapping (string)

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

DELETE /sources/all/{slug}/

POST /providers/saml/

Request:

Changed content type : application/json

• Added property authn_context_class_ref_mapping (string)

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

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property authn_context_class_ref_mapping (string)

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

GET /providers/saml/

Parameters:

Added: authn_context_class_ref_mapping in query

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > SAMLProvider Serializer

    • Added property authn_context_class_ref_mapping (string)

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

PUT /core/transactional/applications/

Request:

Changed content type : application/json

• Changed property provider (object)

  Updated authentik_providers_saml.samlprovider provider_model:

  • Added property authn_context_class_ref_mapping (string)

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

v3.2025022.2: Update API Client

Update API Client

What's Changed

---

GET /providers/scim_groups/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • attributes
  • Added property attributes (object)

GET /providers/scim_users/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  New required properties:

  • attributes
  • Added property attributes (object)

POST /providers/scim_groups/

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  New required properties:

  • attributes
  • Added property attributes (object)

GET /providers/scim_groups/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > SCIMProviderGroup Serializer

    New required properties:

    • attributes
    • Added property attributes (object)

POST /providers/scim_users/

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  New required properties:

  • attributes
  • Added property attributes (object)

GET /providers/scim_users/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > SCIMProviderUser Serializer

    New required properties:

    • attributes
    • Added property attributes (object)

v3.2025022.1

Update API Client

v3.2025021.4: Update API Client

Update API Client

What's Changed

---

GET /providers/scim/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property compatibility_mode (object)

    Alter authentik behavior for vendor-specific SCIM implementations.

    Enum values:

    • default
    • aws
    • slack

PUT /providers/scim/{id}/

Request:

Changed content type : application/json

• Added property compatibility_mode (object)

  Alter authentik behavior for vendor-specific SCIM implementations.

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property compatibility_mode (object)

    Alter authentik behavior for vendor-specific SCIM implementations.

PATCH /providers/scim/{id}/

Request:

Changed content type : application/json

• Added property compatibility_mode (object)

  Alter authentik behavior for vendor-specific SCIM implementations.

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property compatibility_mode (object)

    Alter authentik behavior for vendor-specific SCIM implementations.

POST /providers/scim/

Request:

Changed content type : application/json

• Added property compatibility_mode (object)

  Alter authentik behavior for vendor-specific SCIM implementations.

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property compatibility_mode (object)

    Alter authentik behavior for vendor-specific SCIM implementations.

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 compatibility_mode (object)

      Alter authentik behavior for vendor-specific SCIM implementations.

PUT /core/transactional/applications/

Request:

Changed content type : application/json

• Changed property provider (object)

  Updated authentik_providers_scim.scimprovider provider_model:

  • Added property compatibility_mode (object)

    Alter authentik behavior for vendor-specific SCIM implementations.

v3.2025021.3: Update API Client

Update API Client

What's Changed

---

GET /stages/email/{stage_uuid}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property token_expiry (integer -> string)

    Time the token sent is valid (Format: hours=3,minutes=17,seconds=300).

PUT /stages/email/{stage_uuid}/

Request:

Changed content type : application/json

• Changed property token_expiry (integer -> string)

  Time the token sent is valid (Format: hours=3,minutes=17,seconds=300).

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property token_expiry (integer -> string)

    Time the token sent is valid (Format: hours=3,minutes=17,seconds=300).

PATCH /stages/email/{stage_uuid}/

Request:

Changed content type : application/json

• Changed property token_expiry (integer -> string)

  Time the token sent is valid (Format: hours=3,minutes=17,seconds=300).

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property token_expiry (integer -> string)

    Time the token sent is valid (Format: hours=3,minutes=17,seconds=300).

POST /stages/email/

Request:

Changed content type : application/json

• Changed property token_expiry (integer -> string)

  Time the token sent is valid (Format: hours=3,minutes=17,seconds=300).

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Changed property token_expiry (integer -> string)

    Time the token sent is valid (Format: hours=3,minutes=17,seconds=300).

GET /stages/email/

Parameters:

Changed: token_expiry in query

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > EmailStage Serializer

    • Changed property token_expiry (integer -> string)

      Time the token sent is valid (Format: hours=3,minutes=17,seconds=300).

v3.2025021.2: Update API Client

Update API Client

What's Changed

---

GET /providers/scim/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.

PUT /providers/scim/{id}/

Request:

Changed content type : application/json

• Added property dry_run (boolean)

  When enabled, provider will not modify or create objects in the remote system.

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.

PATCH /providers/scim/{id}/

Request:

Changed content type : application/json

• Added property dry_run (boolean)

  When enabled, provider will not modify or create objects in the remote system.

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.

GET /providers/google_workspace/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.

PUT /providers/google_workspace/{id}/

Request:

Changed content type : application/json

• Added property dry_run (boolean)

  When enabled, provider will not modify or create objects in the remote system.

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.

PATCH /providers/google_workspace/{id}/

Request:

Changed content type : application/json

• Added property dry_run (boolean)

  When enabled, provider will not modify or create objects in the remote system.

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.

GET /providers/microsoft_entra/{id}/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.

PUT /providers/microsoft_entra/{id}/

Request:

Changed content type : application/json

• Added property dry_run (boolean)

  When enabled, provider will not modify or create objects in the remote system.

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.

PATCH /providers/microsoft_entra/{id}/

Request:

Changed content type : application/json

• Added property dry_run (boolean)

  When enabled, provider will not modify or create objects in the remote system.

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.

POST /providers/scim/

Request:

Changed content type : application/json

• Added property dry_run (boolean)

  When enabled, provider will not modify or create objects in the remote system.

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.

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 dry_run (boolean)

      When enabled, provider will not modify or create objects in the remote system.

POST /providers/google_workspace/

Request:

Changed content type : application/json

• Added property dry_run (boolean)

  When enabled, provider will not modify or create objects in the remote system.

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.

GET /providers/google_workspace/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > GoogleWorkspaceProvider Serializer

    • Added property dry_run (boolean)

      When enabled, provider will not modify or create objects in the remote system.

POST /providers/google_workspace/{id}/sync/object/

Request:

Changed content type : application/json

• Added property override_dry_run (boolean)

POST /providers/microsoft_entra/

Request:

Changed content type : application/json

• Added property dry_run (boolean)

  When enabled, provider will not modify or create objects in the remote system.

Return Type:

Changed response : 201 Created

• Changed content type : application/json

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.

GET /providers/microsoft_entra/

Return Type:

Changed response : 200 OK

• Changed content type : application/json

  • Changed property results (array)

    Changed items (object):
    > MicrosoftEntraProvider Serializer

    • Added property dry_run (boolean)

      When enabled, provider will not modify or create objects in the remote system.

POST /providers/microsoft_entra/{id}/sync/object/

Request:

Changed content type : application/json

• Added property override_dry_run (boolean)

POST /providers/scim/{id}/sync/object/

Request:

Changed content type : application/json

• Added property override_dry_run (boolean)

PUT /core/transactional/applications/

Request:

Changed content type : application/json

• Changed property provider (object)

  Updated authentik_providers_microsoft_entra.microsoftentraprovider provider_model:

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.

  Updated authentik_providers_scim.scimprovider provider_model:

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.

  Updated authentik_providers_google_workspace.googleworkspaceprovider provider_model:

  • Added property dry_run (boolean)

    When enabled, provider will not modify or create objects in the remote system.