website/docs/releases/2024/v2024.8.md
LDAP property mappings simplification
LDAP property mappings have been reworked to remove Object field. With this release, instead of returning a single user or group attribute for each property mapping, you can now return several of them. Here is an example of what new property mappings look like:
return {
"username": ldap.get("uid"), # list_flatten is automatically applied to top-level attributes
"attributes": {
"phone": list_flatten(ldap.get("phoneNumber")), # but not for attributes!
},
}
This property mapping populates the username and attributes.phone attributes of a user at the same time, reducing the number of mappings that are run and thus improving performance. Additionally, they are more straightforward to read, and this change allowed us to implement property mappings for OAuth and SAML sources as well.
authentik will automatically convert existing property mappings to this new format, by generating some Python code for each of the existing property mappings expressions. Property mappings that are managed by authentik will automatically get updated to the new format.
If you have any custom property mappings, we recommend converting them to this new format.
OAuth and SAML sources now sync groups by default
OAuth (specifically OpenID and Okta) sources now sync groups by default when a groups claim is available.
SAML sources now sync groups by default when a http://schemas.xmlsoap.org/claims/Group attribute is available in the assertion.
To disable that behavior, create an OAuth/SAML source property mapping with the expression below and assign it as a user property mapping on the source.
return {
"groups": [],
}
Terraform Resource rename
Several resources in the Terraform provider have been renamed to align with new functionality. This mainly applies to property mapping-related resources. With the authentik version 2024.8.1 of the Terraform provider, both the old and new resources are available, and resources can be moved to the new name using terraform state mv.
These resources have been renamed:
authentik_property_mapping_google_workspaceauthentik_property_mapping_ldapauthentik_property_mapping_microsoft_entraauthentik_property_mapping_racauthentik_property_mapping_radiusauthentik_property_mapping_samlauthentik_property_mapping_scimChanges to the external user type
Since the introduction of user types with 2023.8, the main difference between internal and external users has mostly been relevant when using the Enterprise version of authentik.
With this release, authentik improves support for B2C use-cases, which external users are intended for. It is now possible to configure a default application. External users not attempting to access a specific application will always be redirected to this default application.
As part of this, external users will no longer have access to the User and Admin interfaces. If you're using the open-source version and you require this workflow, you can change users to be Internal, which will have no side-effects. For Enterprise customers, please reach out to us with any questions.
<details><summary>Bulk changing the user type</summary>In the container, run the command `ak change_user_type --all --type internal` to change all users to Internal. Instead of using `--all` you can also pass usernames to the command to only change individual users to internal.</details>
Changed HTTP healthcheck endpoints status code
For increased compatibility, the /-/health/live/ and /-/health/ready/ endpoints return 200 HTTP Status codes for successful checks. Previously these endpoints returned 204, which means in most cases no changes are required.
Source property mappings for SCIM, OAuth, SAML and Plex sources
All source types now support property mappings to customize how authentik should interpret the data the source provides. In addition to that, it is also now possible to sync groups and group membership from sources that provide group information. See Property Mappings.
RADIUS provider custom attribute support
With 2024.8 it is possible to define custom attributes for the RADIUS provider, for example vendor-specific attributes like Cisco's AV-Pair attribute. These attributes are defined in property mappings which means they can be dynamically defined based on the user authenticating. See RADIUS Provider
SAML encryption support
It is now possible to configure SAML sources and providers to decrypt and validate encrypted assertions. This can be configured by creating a Certificate-keypair and selecting it in the SAML source or provider.
GeoIP Policy
With the new GeoIP Policy it is possible to grant/deny access based on Country and ASN, without having to write an expression policy.
Simplification of LDAP Provider permissions
The LDAP provider now uses RBAC to assign the appropriate permission to search the full directory instead of requiring a dedicated group to be created. As part of the upgrade, existing search groups' users are migrated to grant the required permission to search the full directory.
RBAC support for blueprints and Terraform
RBAC permissions for global/object level permissions for users/roles can now be managed via blueprints and Terraform. This allows for the automatic configuration of permissions.
UX improvements
In previous versions of authentik, there were several places in the Admin interface where you could not select more than 100 items. With this change, it is now possible to search for items and select more than 100 items.
WebFinger support
With the addition of the default application setting, when the default application uses an OIDC provider, a WebFinger endpoint is available now.
This release does not introduce any new requirements. You can follow the upgrade instructions below; for more detailed information about upgrading authentik, refer to our Upgrade documentation.
:::warning When you upgrade, be aware that the version of the authentik instance and of any outposts must be the same. We recommended that you always upgrade any outposts at the same time you upgrade your authentik instance. :::
To upgrade, download the new docker-compose file and update the Docker stack with the new version, using these commands:
wget -O docker-compose.yml https://goauthentik.io/version/2024.8/docker-compose.yml
docker compose up -d
The -O flag retains the downloaded file's name, overwriting any existing local file with the same name.
Upgrade the Helm Chart to the new version, using the following commands:
helm repo update
helm upgrade authentik authentik/authentik -f values.yaml --version ^2024.8
outpost_connection_discovery runs on worker startup (cherry-pick #11260) (#11270)GET /outposts/ldap/{id}/check_access/GET /outposts/radius/{id}/check_access/GET /policies/geoip/POST /policies/geoip/GET /policies/geoip/{policy_uuid}/PUT /policies/geoip/{policy_uuid}/DELETE /policies/geoip/{policy_uuid}/PATCH /policies/geoip/{policy_uuid}/GET /policies/geoip/{policy_uuid}/used_by/GET /policies/geoip_iso3166/GET /propertymappings/provider/rac/POST /propertymappings/provider/rac/GET /propertymappings/provider/rac/{pm_uuid}/PUT /propertymappings/provider/rac/{pm_uuid}/DELETE /propertymappings/provider/rac/{pm_uuid}/PATCH /propertymappings/provider/rac/{pm_uuid}/GET /propertymappings/provider/rac/{pm_uuid}/used_by/GET /propertymappings/provider/radius/POST /propertymappings/provider/radius/GET /propertymappings/provider/radius/{pm_uuid}/PUT /propertymappings/provider/radius/{pm_uuid}/DELETE /propertymappings/provider/radius/{pm_uuid}/PATCH /propertymappings/provider/radius/{pm_uuid}/GET /propertymappings/provider/radius/{pm_uuid}/used_by/GET /propertymappings/provider/saml/POST /propertymappings/provider/saml/GET /propertymappings/provider/saml/{pm_uuid}/PUT /propertymappings/provider/saml/{pm_uuid}/DELETE /propertymappings/provider/saml/{pm_uuid}/PATCH /propertymappings/provider/saml/{pm_uuid}/GET /propertymappings/provider/saml/{pm_uuid}/used_by/GET /propertymappings/provider/scim/POST /propertymappings/provider/scim/GET /propertymappings/provider/scim/{pm_uuid}/PUT /propertymappings/provider/scim/{pm_uuid}/DELETE /propertymappings/provider/scim/{pm_uuid}/PATCH /propertymappings/provider/scim/{pm_uuid}/GET /propertymappings/provider/scim/{pm_uuid}/used_by/GET /propertymappings/provider/scope/POST /propertymappings/provider/scope/GET /propertymappings/provider/scope/{pm_uuid}/PUT /propertymappings/provider/scope/{pm_uuid}/DELETE /propertymappings/provider/scope/{pm_uuid}/PATCH /propertymappings/provider/scope/{pm_uuid}/GET /propertymappings/provider/scope/{pm_uuid}/used_by/GET /propertymappings/source/ldap/POST /propertymappings/source/ldap/GET /propertymappings/source/ldap/{pm_uuid}/PUT /propertymappings/source/ldap/{pm_uuid}/DELETE /propertymappings/source/ldap/{pm_uuid}/PATCH /propertymappings/source/ldap/{pm_uuid}/GET /propertymappings/source/ldap/{pm_uuid}/used_by/GET /propertymappings/source/oauth/POST /propertymappings/source/oauth/GET /propertymappings/source/oauth/{pm_uuid}/PUT /propertymappings/source/oauth/{pm_uuid}/DELETE /propertymappings/source/oauth/{pm_uuid}/PATCH /propertymappings/source/oauth/{pm_uuid}/GET /propertymappings/source/oauth/{pm_uuid}/used_by/GET /propertymappings/source/plex/POST /propertymappings/source/plex/GET /propertymappings/source/plex/{pm_uuid}/PUT /propertymappings/source/plex/{pm_uuid}/DELETE /propertymappings/source/plex/{pm_uuid}/PATCH /propertymappings/source/plex/{pm_uuid}/GET /propertymappings/source/plex/{pm_uuid}/used_by/GET /propertymappings/source/saml/POST /propertymappings/source/saml/GET /propertymappings/source/saml/{pm_uuid}/PUT /propertymappings/source/saml/{pm_uuid}/DELETE /propertymappings/source/saml/{pm_uuid}/PATCH /propertymappings/source/saml/{pm_uuid}/GET /propertymappings/source/saml/{pm_uuid}/used_by/GET /propertymappings/source/scim/POST /propertymappings/source/scim/GET /propertymappings/source/scim/{pm_uuid}/PUT /propertymappings/source/scim/{pm_uuid}/DELETE /propertymappings/source/scim/{pm_uuid}/PATCH /propertymappings/source/scim/{pm_uuid}/GET /propertymappings/source/scim/{pm_uuid}/used_by/GET /rbac/permissions/roles/{id}/PUT /rbac/permissions/roles/{id}/DELETE /rbac/permissions/roles/{id}/PATCH /rbac/permissions/roles/{id}/GET /rbac/permissions/users/{id}/PUT /rbac/permissions/users/{id}/DELETE /rbac/permissions/users/{id}/PATCH /rbac/permissions/users/{id}/GET /sources/group_connections/oauth/POST /sources/group_connections/oauth/GET /sources/group_connections/oauth/{id}/PUT /sources/group_connections/oauth/{id}/DELETE /sources/group_connections/oauth/{id}/PATCH /sources/group_connections/oauth/{id}/GET /sources/group_connections/oauth/{id}/used_by/GET /sources/group_connections/plex/POST /sources/group_connections/plex/GET /sources/group_connections/plex/{id}/PUT /sources/group_connections/plex/{id}/DELETE /sources/group_connections/plex/{id}/PATCH /sources/group_connections/plex/{id}/GET /sources/group_connections/plex/{id}/used_by/GET /sources/group_connections/saml/GET /sources/group_connections/saml/{id}/PUT /sources/group_connections/saml/{id}/DELETE /sources/group_connections/saml/{id}/PATCH /sources/group_connections/saml/{id}/GET /sources/group_connections/saml/{id}/used_by/GET /outposts/ldap/{id}/GET /outposts/proxy/{id}/GET /outposts/radius/{id}/GET /propertymappings/ldap/POST /propertymappings/ldap/GET /propertymappings/ldap/{pm_uuid}/PUT /propertymappings/ldap/{pm_uuid}/DELETE /propertymappings/ldap/{pm_uuid}/PATCH /propertymappings/ldap/{pm_uuid}/GET /propertymappings/ldap/{pm_uuid}/used_by/GET /propertymappings/rac/POST /propertymappings/rac/GET /propertymappings/rac/{pm_uuid}/PUT /propertymappings/rac/{pm_uuid}/DELETE /propertymappings/rac/{pm_uuid}/PATCH /propertymappings/rac/{pm_uuid}/GET /propertymappings/rac/{pm_uuid}/used_by/GET /propertymappings/saml/POST /propertymappings/saml/GET /propertymappings/saml/{pm_uuid}/PUT /propertymappings/saml/{pm_uuid}/DELETE /propertymappings/saml/{pm_uuid}/PATCH /propertymappings/saml/{pm_uuid}/GET /propertymappings/saml/{pm_uuid}/used_by/GET /propertymappings/scim/POST /propertymappings/scim/GET /propertymappings/scim/{pm_uuid}/PUT /propertymappings/scim/{pm_uuid}/DELETE /propertymappings/scim/{pm_uuid}/PATCH /propertymappings/scim/{pm_uuid}/GET /propertymappings/scim/{pm_uuid}/used_by/GET /propertymappings/scope/POST /propertymappings/scope/GET /propertymappings/scope/{pm_uuid}/PUT /propertymappings/scope/{pm_uuid}/DELETE /propertymappings/scope/{pm_uuid}/PATCH /propertymappings/scope/{pm_uuid}/GET /propertymappings/scope/{pm_uuid}/used_by/GET /admin/version/Changed response : 200 OK
Changed content type : application/json
New required properties:
outpost_outdatedoutpost_outdated (boolean)
Check if any outpost is outdated/has a version mismatch
GET /authenticators/admin/all/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > Serializer for Duo authenticator devices
New required properties:
createdlast_updatedlast_usedAdded property created (string)
Added property last_updated (string)
Added property last_used (string)
GET /authenticators/all/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > Serializer for Duo authenticator devices
New required properties:
createdlast_updatedlast_usedAdded property created (string)
Added property last_updated (string)
Added property last_used (string)
GET /core/brands/{brand_uuid}/Changed response : 200 OK
application/json
default_application (string)
When set, external users will be redirected to this application after authenticating.
PUT /core/brands/{brand_uuid}/Changed content type : application/json
default_application (string)
When set, external users will be redirected to this application after authenticating.
Changed response : 200 OK
application/json
default_application (string)
When set, external users will be redirected to this application after authenticating.
PATCH /core/brands/{brand_uuid}/Changed content type : application/json
default_application (string)
When set, external users will be redirected to this application after authenticating.
Changed response : 200 OK
application/json
default_application (string)
When set, external users will be redirected to this application after authenticating.
GET /enterprise/license/summary/Changed response : 200 OK
Changed content type : application/json
New required properties:
license_flagsstatusNew optional properties:
has_licenseread_onlyshow_admin_warningshow_user_warningvalidAdded property status (string)
Enum values:
unlicensedvalidexpiredexpiry_soonlimit_exceeded_adminlimit_exceeded_userread_onlyAdded property license_flags (array)
Items (string):
Enum values:
trialnon_productionDeleted property valid (boolean)
Deleted property show_admin_warning (boolean)
Deleted property show_user_warning (boolean)
Deleted property read_only (boolean)
Deleted property has_license (boolean)
GET /policies/event_matcher/{policy_uuid}/Changed response : 200 OK
application/json
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum value:
authentik.policies.geoipChanged 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 values:
authentik_policies_geoip.geoippolicy
authentik_providers_radius.radiusproviderpropertymapping
authentik_sources_ldap.ldapsourcepropertymapping
authentik_sources_oauth.oauthsourcepropertymapping
authentik_sources_oauth.groupoauthsourceconnection
authentik_sources_plex.plexsourcepropertymapping
authentik_sources_plex.userplexsourceconnection
authentik_sources_plex.groupplexsourceconnection
authentik_sources_saml.samlsourcepropertymapping
authentik_sources_saml.groupsamlsourceconnection
authentik_sources_scim.scimsourcepropertymapping
Removed enum values:
authentik_sources_ldap.ldappropertymapping
authentik_sources_plex.plexsourceconnection
PUT /policies/event_matcher/{policy_uuid}/Changed content type : application/json
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum value:
authentik.policies.geoipChanged 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 values:
authentik_policies_geoip.geoippolicy
authentik_providers_radius.radiusproviderpropertymapping
authentik_sources_ldap.ldapsourcepropertymapping
authentik_sources_oauth.oauthsourcepropertymapping
authentik_sources_oauth.groupoauthsourceconnection
authentik_sources_plex.plexsourcepropertymapping
authentik_sources_plex.userplexsourceconnection
authentik_sources_plex.groupplexsourceconnection
authentik_sources_saml.samlsourcepropertymapping
authentik_sources_saml.groupsamlsourceconnection
authentik_sources_scim.scimsourcepropertymapping
Removed enum values:
authentik_sources_ldap.ldappropertymapping
authentik_sources_plex.plexsourceconnection
Changed response : 200 OK
application/json
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum value:
authentik.policies.geoipChanged 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 values:
authentik_policies_geoip.geoippolicy
authentik_providers_radius.radiusproviderpropertymapping
authentik_sources_ldap.ldapsourcepropertymapping
authentik_sources_oauth.oauthsourcepropertymapping
authentik_sources_oauth.groupoauthsourceconnection
authentik_sources_plex.plexsourcepropertymapping
authentik_sources_plex.userplexsourceconnection
authentik_sources_plex.groupplexsourceconnection
authentik_sources_saml.samlsourcepropertymapping
authentik_sources_saml.groupsamlsourceconnection
authentik_sources_scim.scimsourcepropertymapping
Removed enum values:
authentik_sources_ldap.ldappropertymapping
authentik_sources_plex.plexsourceconnection
PATCH /policies/event_matcher/{policy_uuid}/Changed content type : application/json
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum value:
authentik.policies.geoipChanged 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 values:
authentik_policies_geoip.geoippolicy
authentik_providers_radius.radiusproviderpropertymapping
authentik_sources_ldap.ldapsourcepropertymapping
authentik_sources_oauth.oauthsourcepropertymapping
authentik_sources_oauth.groupoauthsourceconnection
authentik_sources_plex.plexsourcepropertymapping
authentik_sources_plex.userplexsourceconnection
authentik_sources_plex.groupplexsourceconnection
authentik_sources_saml.samlsourcepropertymapping
authentik_sources_saml.groupsamlsourceconnection
authentik_sources_scim.scimsourcepropertymapping
Removed enum values:
authentik_sources_ldap.ldappropertymapping
authentik_sources_plex.plexsourceconnection
Changed response : 200 OK
application/json
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum value:
authentik.policies.geoipChanged 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 values:
authentik_policies_geoip.geoippolicy
authentik_providers_radius.radiusproviderpropertymapping
authentik_sources_ldap.ldapsourcepropertymapping
authentik_sources_oauth.oauthsourcepropertymapping
authentik_sources_oauth.groupoauthsourceconnection
authentik_sources_plex.plexsourcepropertymapping
authentik_sources_plex.userplexsourceconnection
authentik_sources_plex.groupplexsourceconnection
authentik_sources_saml.samlsourcepropertymapping
authentik_sources_saml.groupsamlsourceconnection
authentik_sources_scim.scimsourcepropertymapping
Removed enum values:
authentik_sources_ldap.ldappropertymapping
authentik_sources_plex.plexsourceconnection
GET /providers/google_workspace_groups/{id}/Changed response : 200 OK
application/json
Changed property group_obj (object)
Simplified Group Serializer for user's groups
name (string)GET /providers/microsoft_entra_groups/{id}/Changed response : 200 OK
application/json
Changed property group_obj (object)
Simplified Group Serializer for user's groups
name (string)GET /providers/scim_groups/{id}/Changed response : 200 OK
application/json
Changed property group_obj (object)
Simplified Group Serializer for user's groups
name (string)GET /sources/scim_groups/{id}/Changed response : 200 OK
application/json
Changed property group_obj (object)
Simplified Group Serializer for user's groups
name (string)PUT /sources/scim_groups/{id}/Changed response : 200 OK
application/json
Changed property group_obj (object)
Simplified Group Serializer for user's groups
name (string)PATCH /sources/scim_groups/{id}/Changed response : 200 OK
application/json
Changed property group_obj (object)
Simplified Group Serializer for user's groups
name (string)POST /core/brands/Changed content type : application/json
default_application (string)
When set, external users will be redirected to this application after authenticating.
Changed response : 201 Created
application/json
default_application (string)
When set, external users will be redirected to this application after authenticating.
GET /core/brands/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Brand Serializer
default_application (string)
When set, external users will be redirected to this application after authenticating.
GET /core/groups/{group_uuid}/Changed response : 200 OK
application/json
name (string)PUT /core/groups/{group_uuid}/Changed content type : application/json
name (string)Changed response : 200 OK
application/json
name (string)PATCH /core/groups/{group_uuid}/Changed content type : application/json
name (string)Changed response : 200 OK
application/json
name (string)GET /core/tokens/{identifier}/Changed response : 200 OK
application/json
Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)PUT /core/tokens/{identifier}/Changed response : 200 OK
application/json
Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)PATCH /core/tokens/{identifier}/Changed response : 200 OK
application/json
Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)GET /core/users/{id}/Changed response : 200 OK
application/json
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)PUT /core/users/{id}/Changed response : 200 OK
application/json
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)PATCH /core/users/{id}/Changed response : 200 OK
application/json
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)GET /events/rules/{pbm_uuid}/Changed response : 200 OK
application/json
Changed property group_obj (object)
Group Serializer
name (string)PUT /events/rules/{pbm_uuid}/Changed response : 200 OK
application/json
Changed property group_obj (object)
Group Serializer
name (string)PATCH /events/rules/{pbm_uuid}/Changed response : 200 OK
application/json
Changed property group_obj (object)
Group Serializer
name (string)GET /policies/bindings/{policy_binding_uuid}/Changed response : 200 OK
application/json
Changed property group_obj (object)
Group Serializer
name (string)Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)PUT /policies/bindings/{policy_binding_uuid}/Changed response : 200 OK
application/json
Changed property group_obj (object)
Group Serializer
name (string)Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)PATCH /policies/bindings/{policy_binding_uuid}/Changed response : 200 OK
application/json
Changed property group_obj (object)
Group Serializer
name (string)Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)POST /policies/event_matcher/Changed content type : application/json
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum value:
authentik.policies.geoipChanged 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 values:
authentik_policies_geoip.geoippolicy
authentik_providers_radius.radiusproviderpropertymapping
authentik_sources_ldap.ldapsourcepropertymapping
authentik_sources_oauth.oauthsourcepropertymapping
authentik_sources_oauth.groupoauthsourceconnection
authentik_sources_plex.plexsourcepropertymapping
authentik_sources_plex.userplexsourceconnection
authentik_sources_plex.groupplexsourceconnection
authentik_sources_saml.samlsourcepropertymapping
authentik_sources_saml.groupsamlsourceconnection
authentik_sources_scim.scimsourcepropertymapping
Removed enum values:
authentik_sources_ldap.ldappropertymapping
authentik_sources_plex.plexsourceconnection
Changed response : 201 Created
application/json
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum value:
authentik.policies.geoipChanged 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 values:
authentik_policies_geoip.geoippolicy
authentik_providers_radius.radiusproviderpropertymapping
authentik_sources_ldap.ldapsourcepropertymapping
authentik_sources_oauth.oauthsourcepropertymapping
authentik_sources_oauth.groupoauthsourceconnection
authentik_sources_plex.plexsourcepropertymapping
authentik_sources_plex.userplexsourceconnection
authentik_sources_plex.groupplexsourceconnection
authentik_sources_saml.samlsourcepropertymapping
authentik_sources_saml.groupsamlsourceconnection
authentik_sources_scim.scimsourcepropertymapping
Removed enum values:
authentik_sources_ldap.ldappropertymapping
authentik_sources_plex.plexsourceconnection
GET /policies/event_matcher/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Event Matcher Policy Serializer
Changed property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum value:
authentik.policies.geoipChanged 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 values:
authentik_policies_geoip.geoippolicy
authentik_providers_radius.radiusproviderpropertymapping
authentik_sources_ldap.ldapsourcepropertymapping
authentik_sources_oauth.oauthsourcepropertymapping
authentik_sources_oauth.groupoauthsourceconnection
authentik_sources_plex.plexsourcepropertymapping
authentik_sources_plex.userplexsourceconnection
authentik_sources_plex.groupplexsourceconnection
authentik_sources_saml.samlsourcepropertymapping
authentik_sources_saml.groupsamlsourceconnection
authentik_sources_scim.scimsourcepropertymapping
Removed enum values:
authentik_sources_ldap.ldappropertymapping
authentik_sources_plex.plexsourceconnection
GET /propertymappings/all/Added: managed in query
Added: name in query
POST /providers/google_workspace_groups/Changed response : 201 Created
application/json
Changed property group_obj (object)
Simplified Group Serializer for user's groups
name (string)GET /providers/google_workspace_groups/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > GoogleWorkspaceProviderGroup Serializer
Changed property group_obj (object)
Simplified Group Serializer for user's groups
name (string)GET /providers/ldap/{id}/Changed response : 200 OK
application/json
search_group (string)
Users in this group can do search queries. If not set, every user can execute search queries.
PUT /providers/ldap/{id}/Changed content type : application/json
search_group (string)
Users in this group can do search queries. If not set, every user can execute search queries.
Changed response : 200 OK
application/json
search_group (string)
Users in this group can do search queries. If not set, every user can execute search queries.
PATCH /providers/ldap/{id}/Changed content type : application/json
search_group (string)
Users in this group can do search queries. If not set, every user can execute search queries.
Changed response : 200 OK
application/json
search_group (string)
Users in this group can do search queries. If not set, every user can execute search queries.
POST /providers/microsoft_entra_groups/Changed response : 201 Created
application/json
Changed property group_obj (object)
Simplified Group Serializer for user's groups
name (string)GET /providers/microsoft_entra_groups/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > MicrosoftEntraProviderGroup Serializer
Changed property group_obj (object)
Simplified Group Serializer for user's groups
name (string)GET /providers/saml/{id}/Changed response : 200 OK
application/json
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
Added property sign_assertion (boolean)
Added property sign_response (boolean)
PUT /providers/saml/{id}/Changed content type : application/json
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
Added property sign_assertion (boolean)
Added property sign_response (boolean)
Changed response : 200 OK
application/json
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
Added property sign_assertion (boolean)
Added property sign_response (boolean)
PATCH /providers/saml/{id}/Changed content type : application/json
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
Added property sign_assertion (boolean)
Added property sign_response (boolean)
Changed response : 200 OK
application/json
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
Added property sign_assertion (boolean)
Added property sign_response (boolean)
POST /providers/scim_groups/Changed response : 201 Created
application/json
Changed property group_obj (object)
Simplified Group Serializer for user's groups
name (string)GET /providers/scim_groups/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SCIMProviderGroup Serializer
Changed property group_obj (object)
Simplified Group Serializer for user's groups
name (string)POST /rbac/permissions/assigned_by_roles/{uuid}/assign/Changed content type : application/json
Changed property model (string)
Added enum values:
authentik_policies_geoip.geoippolicy
authentik_providers_radius.radiusproviderpropertymapping
authentik_sources_ldap.ldapsourcepropertymapping
authentik_sources_oauth.oauthsourcepropertymapping
authentik_sources_oauth.groupoauthsourceconnection
authentik_sources_plex.plexsourcepropertymapping
authentik_sources_plex.userplexsourceconnection
authentik_sources_plex.groupplexsourceconnection
authentik_sources_saml.samlsourcepropertymapping
authentik_sources_saml.groupsamlsourceconnection
authentik_sources_scim.scimsourcepropertymapping
Removed enum values:
authentik_sources_ldap.ldappropertymapping
authentik_sources_plex.plexsourceconnection
New response : 200 OK Deleted response : 204 No Content
Successfully assigned
PATCH /rbac/permissions/assigned_by_roles/{uuid}/unassign/Changed content type : application/json
Changed property model (string)
Added enum values:
authentik_policies_geoip.geoippolicy
authentik_providers_radius.radiusproviderpropertymapping
authentik_sources_ldap.ldapsourcepropertymapping
authentik_sources_oauth.oauthsourcepropertymapping
authentik_sources_oauth.groupoauthsourceconnection
authentik_sources_plex.plexsourcepropertymapping
authentik_sources_plex.userplexsourceconnection
authentik_sources_plex.groupplexsourceconnection
authentik_sources_saml.samlsourcepropertymapping
authentik_sources_saml.groupsamlsourceconnection
authentik_sources_scim.scimsourcepropertymapping
Removed enum values:
authentik_sources_ldap.ldappropertymapping
authentik_sources_plex.plexsourceconnection
POST /rbac/permissions/assigned_by_users/{id}/assign/Changed content type : application/json
Changed property model (string)
Added enum values:
authentik_policies_geoip.geoippolicy
authentik_providers_radius.radiusproviderpropertymapping
authentik_sources_ldap.ldapsourcepropertymapping
authentik_sources_oauth.oauthsourcepropertymapping
authentik_sources_oauth.groupoauthsourceconnection
authentik_sources_plex.plexsourcepropertymapping
authentik_sources_plex.userplexsourceconnection
authentik_sources_plex.groupplexsourceconnection
authentik_sources_saml.samlsourcepropertymapping
authentik_sources_saml.groupsamlsourceconnection
authentik_sources_scim.scimsourcepropertymapping
Removed enum values:
authentik_sources_ldap.ldappropertymapping
authentik_sources_plex.plexsourceconnection
New response : 200 OK Deleted response : 204 No Content
Successfully assigned
PATCH /rbac/permissions/assigned_by_users/{id}/unassign/Changed content type : application/json
Changed property model (string)
Added enum values:
authentik_policies_geoip.geoippolicy
authentik_providers_radius.radiusproviderpropertymapping
authentik_sources_ldap.ldapsourcepropertymapping
authentik_sources_oauth.oauthsourcepropertymapping
authentik_sources_oauth.groupoauthsourceconnection
authentik_sources_plex.plexsourcepropertymapping
authentik_sources_plex.userplexsourceconnection
authentik_sources_plex.groupplexsourceconnection
authentik_sources_saml.samlsourcepropertymapping
authentik_sources_saml.groupsamlsourceconnection
authentik_sources_scim.scimsourcepropertymapping
Removed enum values:
authentik_sources_ldap.ldappropertymapping
authentik_sources_plex.plexsourceconnection
GET /rbac/permissions/roles/Changed: uuid in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > User permission with additional object-related data
object_pk (string)GET /rbac/permissions/users/Changed: user_id in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > User permission with additional object-related data
object_pk (string)GET /sources/all/{slug}/Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Items (string):
Added property group_property_mappings (array)
GET /sources/ldap/{slug}/Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property property_mappings (array)
Deleted property property_mappings_group (array)
Property mappings used for group creation/updating.
PUT /sources/ldap/{slug}/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property property_mappings (array)
Deleted property property_mappings_group (array)
Property mappings used for group creation/updating.
Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property property_mappings (array)
Deleted property property_mappings_group (array)
Property mappings used for group creation/updating.
PATCH /sources/ldap/{slug}/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property property_mappings (array)
Deleted property property_mappings_group (array)
Property mappings used for group creation/updating.
Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property property_mappings (array)
Deleted property property_mappings_group (array)
Property mappings used for group creation/updating.
GET /sources/oauth/{slug}/Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Enum values:
identifiername_linkname_denyPUT /sources/oauth/{slug}/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
PATCH /sources/oauth/{slug}/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
GET /sources/plex/{slug}/Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
PUT /sources/plex/{slug}/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
PATCH /sources/plex/{slug}/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
GET /sources/saml/{slug}/Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
PUT /sources/saml/{slug}/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
PATCH /sources/saml/{slug}/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
GET /sources/scim/{slug}/Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property user_matching_mode (object)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)PUT /sources/scim/{slug}/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property user_matching_mode (object)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property user_matching_mode (object)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)PATCH /sources/scim/{slug}/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property user_matching_mode (object)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed response : 200 OK
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property user_matching_mode (object)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)POST /sources/scim_groups/Changed response : 201 Created
application/json
Changed property group_obj (object)
Simplified Group Serializer for user's groups
name (string)GET /sources/scim_groups/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SCIMSourceGroup Serializer
Changed property group_obj (object)
Simplified Group Serializer for user's groups
name (string)GET /sources/user_connections/all/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
PUT /sources/user_connections/all/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
PATCH /sources/user_connections/all/{id}/Changed response : 200 OK
application/json
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
GET /sources/user_connections/oauth/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
createdAdded property created (string)
Changed property user (integer)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
PUT /sources/user_connections/oauth/{id}/Changed content type : application/json
New optional properties:
useruser (integer)Changed response : 200 OK
Changed content type : application/json
New required properties:
createdAdded property created (string)
Changed property user (integer)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
PATCH /sources/user_connections/oauth/{id}/Changed content type : application/json
user (integer)Changed response : 200 OK
Changed content type : application/json
New required properties:
createdAdded property created (string)
Changed property user (integer)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
GET /sources/user_connections/plex/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
createdNew optional properties:
plex_tokenAdded property created (string)
Deleted property plex_token (string)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
PUT /sources/user_connections/plex/{id}/Changed content type : application/json
plex_token (string)Changed response : 200 OK
Changed content type : application/json
New required properties:
createdNew optional properties:
plex_tokenAdded property created (string)
Deleted property plex_token (string)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
PATCH /sources/user_connections/plex/{id}/Changed content type : application/json
plex_token (string)Changed response : 200 OK
Changed content type : application/json
New required properties:
createdNew optional properties:
plex_tokenAdded property created (string)
Deleted property plex_token (string)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
GET /sources/user_connections/saml/{id}/Changed response : 200 OK
Changed content type : application/json
New required properties:
createdAdded property created (string)
Changed property user (integer)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
PUT /sources/user_connections/saml/{id}/Changed content type : application/json
New optional properties:
useruser (integer)Changed response : 200 OK
Changed content type : application/json
New required properties:
createdAdded property created (string)
Changed property user (integer)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
PATCH /sources/user_connections/saml/{id}/Changed content type : application/json
user (integer)Changed response : 200 OK
Changed content type : application/json
New required properties:
createdAdded property created (string)
Changed property user (integer)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
GET /core/applications/Added: only_with_launch_url in query
POST /core/groups/Changed content type : application/json
name (string)Changed response : 201 Created
application/json
name (string)GET /core/groups/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Group Serializer
name (string)POST /core/tokens/Changed response : 201 Created
application/json
Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)GET /core/tokens/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Token Serializer
Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)GET /core/user_consent/{id}/Changed response : 200 OK
application/json
Changed property user (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)POST /core/users/Changed response : 201 Created
application/json
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)GET /core/users/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)POST /events/rules/Changed response : 201 Created
application/json
Changed property group_obj (object)
Group Serializer
name (string)GET /events/rules/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > NotificationRule Serializer
Changed property group_obj (object)
Group Serializer
name (string)GET /oauth2/access_tokens/{id}/Changed response : 200 OK
application/json
Changed property user (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)GET /oauth2/authorization_codes/{id}/Changed response : 200 OK
application/json
Changed property user (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)GET /oauth2/refresh_tokens/{id}/Changed response : 200 OK
application/json
Changed property user (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)GET /outposts/ldap/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > LDAPProvider Serializer
search_group (string)
Users in this group can do search queries. If not set, every user can execute search queries.
POST /policies/bindings/Changed response : 201 Created
application/json
Changed property group_obj (object)
Group Serializer
name (string)Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)GET /policies/bindings/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > PolicyBinding Serializer
Changed property group_obj (object)
Group Serializer
name (string)Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)POST /providers/ldap/Changed content type : application/json
search_group (string)
Users in this group can do search queries. If not set, every user can execute search queries.
Changed response : 201 Created
application/json
search_group (string)
Users in this group can do search queries. If not set, every user can execute search queries.
GET /providers/ldap/Deleted: search_group__group_uuid__iexact in query
Deleted: search_group__name__iexact in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > LDAPProvider Serializer
search_group (string)
Users in this group can do search queries. If not set, every user can execute search queries.
POST /providers/saml/Changed content type : application/json
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
Added property sign_assertion (boolean)
Added property sign_response (boolean)
Changed response : 201 Created
application/json
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
Added property sign_assertion (boolean)
Added property sign_response (boolean)
GET /providers/saml/Added: encryption_kp in query
Added: sign_assertion in query
Added: sign_response in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SAMLProvider Serializer
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
Added property sign_assertion (boolean)
Added property sign_response (boolean)
GET /rbac/permissions/assigned_by_roles/Changed: model in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Roles assigned object permission serializer
Changed property permissions (array)
Changed items (object): > Role-bound object level permission
object_pk (string)GET /rbac/permissions/assigned_by_users/Changed: model in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Users assigned object permission serializer
Changed property permissions (array)
Changed items (object): > User-bound object level permission
object_pk (string)GET /sources/all/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
POST /sources/ldap/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property property_mappings (array)
Deleted property property_mappings_group (array)
Property mappings used for group creation/updating.
Changed response : 201 Created
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property property_mappings (array)
Deleted property property_mappings_group (array)
Property mappings used for group creation/updating.
GET /sources/ldap/Added: group_property_mappings in query
Added: user_property_mappings in query
Deleted: property_mappings in query
Deleted: property_mappings_group in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > LDAP Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property property_mappings (array)
Deleted property property_mappings_group (array)
Property mappings used for group creation/updating.
POST /sources/oauth/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Changed response : 201 Created
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
GET /sources/oauth/Added: group_matching_mode in query
How the source determines if an existing group should be used or a new group created.
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > OAuth Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
POST /sources/plex/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Changed response : 201 Created
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
GET /sources/plex/Added: group_matching_mode in query
How the source determines if an existing group should be used or a new group created.
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Plex Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
POST /sources/plex/redeem_token/Changed response : 200 OK
Changed content type : application/json
New optional properties:
typetype (object)POST /sources/saml/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
Changed response : 201 Created
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
GET /sources/saml/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SAMLSource Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Added property group_matching_mode (object)
How the source determines if an existing group should be used or a new group created.
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
POST /sources/scim/Changed content type : application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property user_matching_mode (object)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed response : 201 Created
application/json
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property user_matching_mode (object)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)GET /sources/scim/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SCIMSource Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
Deleted property user_matching_mode (object)
How the source determines if an existing user should be authenticated or a new user enrolled.
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)GET /sources/user_connections/all/Added: source__slug in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > OAuth Source Serializer
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
POST /sources/user_connections/oauth/Changed content type : application/json
New optional properties:
useruser (integer)Changed response : 201 Created
Changed content type : application/json
New required properties:
createdAdded property created (string)
Changed property user (integer)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
GET /sources/user_connections/oauth/Added: user in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > OAuth Source Serializer
New required properties:
createdAdded property created (string)
Changed property user (integer)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
POST /sources/user_connections/plex/Changed content type : application/json
plex_token (string)Changed response : 201 Created
Changed content type : application/json
New required properties:
createdNew optional properties:
plex_tokenAdded property created (string)
Deleted property plex_token (string)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
GET /sources/user_connections/plex/Added: user in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Plex Source connection Serializer
New required properties:
createdNew optional properties:
plex_tokenAdded property created (string)
Deleted property plex_token (string)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
POST /sources/user_connections/saml/Changed content type : application/json
New optional properties:
useruser (integer)Changed response : 201 Created
Changed content type : application/json
New required properties:
createdAdded property created (string)
Changed property user (integer)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
GET /sources/user_connections/saml/Added: user in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SAML Source Serializer
New required properties:
createdAdded property created (string)
Changed property user (integer)
Changed property source (object)
Source Serializer
Added property user_property_mappings (array)
Added property group_property_mappings (array)
GET /stages/identification/{stage_uuid}/Changed response : 200 OK
application/json
password_stage (string)
When set, shows a password field, instead of showing the password field as separate step.
PUT /stages/identification/{stage_uuid}/Changed content type : application/json
password_stage (string)
When set, shows a password field, instead of showing the password field as separate step.
Changed response : 200 OK
application/json
password_stage (string)
When set, shows a password field, instead of showing the password field as separate step.
PATCH /stages/identification/{stage_uuid}/Changed content type : application/json
password_stage (string)
When set, shows a password field, instead of showing the password field as separate step.
Changed response : 200 OK
application/json
password_stage (string)
When set, shows a password field, instead of showing the password field as separate step.
GET /stages/password/{stage_uuid}/Changed response : 200 OK
application/json
allow_show_password (boolean)
When enabled, provides a 'show password' button with the password input field.
PUT /stages/password/{stage_uuid}/Changed content type : application/json
allow_show_password (boolean)
When enabled, provides a 'show password' button with the password input field.
Changed response : 200 OK
application/json
allow_show_password (boolean)
When enabled, provides a 'show password' button with the password input field.
PATCH /stages/password/{stage_uuid}/Changed content type : application/json
allow_show_password (boolean)
When enabled, provides a 'show password' button with the password input field.
Changed response : 200 OK
application/json
allow_show_password (boolean)
When enabled, provides a 'show password' button with the password input field.
PUT /core/transactional/applications/Changed content type : application/json
Changed property provider (object)
Updated authentik_providers_saml.samlprovider provider_model:
Added property encryption_kp (string)
When selected, incoming assertions are encrypted by the IdP using the public key of the encryption keypair. The assertion is decrypted by the SP using the private key.
Added property sign_assertion (boolean)
Added property sign_response (boolean)
Updated authentik_providers_ldap.ldapprovider provider_model:
search_group (string)
Users in this group can do search queries. If not set, every user can execute search queries.
GET /core/user_consent/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserConsent Serializer
Changed property user (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)GET /flows/executor/{flow_slug}/Changed response : 200 OK
Changed content type : application/json
Updated ak-stage-flow-error component:
type (string)Updated ak-stage-authenticator-totp component:
New optional properties:
typetype (object)Updated ak-stage-captcha component:
New optional properties:
typetype (object)Updated ak-source-oauth-apple component:
New optional properties:
typetype (object)Updated ak-stage-user-login component:
New optional properties:
typetype (object)Updated ak-stage-access-denied component:
New optional properties:
typetype (object)Updated ak-source-plex component:
New optional properties:
typetype (object)Updated ak-stage-authenticator-duo component:
New optional properties:
typetype (object)Updated ak-stage-password component:
New optional properties:
typeAdded property allow_show_password (boolean)
Deleted property type (object)
Updated ak-stage-authenticator-static component:
New optional properties:
typetype (object)Updated ak-stage-autosubmit component:
New optional properties:
typetype (object)Updated xak-flow-shell component:
New optional properties:
typetype (object)Updated ak-provider-oauth2-device-code-finish component:
New optional properties:
typetype (object)Updated ak-stage-authenticator-sms component:
New optional properties:
typetype (object)Updated ak-stage-email component:
New optional properties:
typetype (object)Updated ak-stage-authenticator-webauthn component:
New optional properties:
typetype (object)Updated xak-flow-redirect component:
New optional properties:
typetype (object)Updated ak-stage-dummy component:
New optional properties:
typetype (object)Updated ak-stage-authenticator-validate component:
New optional properties:
typetype (object)Updated ak-stage-consent component:
New optional properties:
typetype (object)Updated ak-provider-oauth2-device-code component:
New optional properties:
typetype (object)Updated ak-stage-prompt component:
New optional properties:
typetype (object)Updated ak-stage-identification component:
New optional properties:
typeAdded property allow_show_password (boolean)
Deleted property type (object)
POST /flows/executor/{flow_slug}/Changed response : 200 OK
Changed content type : application/json
Updated ak-stage-flow-error component:
type (string)Updated ak-stage-authenticator-totp component:
New optional properties:
typetype (object)Updated ak-stage-captcha component:
New optional properties:
typetype (object)Updated ak-source-oauth-apple component:
New optional properties:
typetype (object)Updated ak-stage-user-login component:
New optional properties:
typetype (object)Updated ak-stage-access-denied component:
New optional properties:
typetype (object)Updated ak-source-plex component:
New optional properties:
typetype (object)Updated ak-stage-authenticator-duo component:
New optional properties:
typetype (object)Updated ak-stage-password component:
New optional properties:
typeAdded property allow_show_password (boolean)
Deleted property type (object)
Updated ak-stage-authenticator-static component:
New optional properties:
typetype (object)Updated ak-stage-autosubmit component:
New optional properties:
typetype (object)Updated xak-flow-shell component:
New optional properties:
typetype (object)Updated ak-provider-oauth2-device-code-finish component:
New optional properties:
typetype (object)Updated ak-stage-authenticator-sms component:
New optional properties:
typetype (object)Updated ak-stage-email component:
New optional properties:
typetype (object)Updated ak-stage-authenticator-webauthn component:
New optional properties:
typetype (object)Updated xak-flow-redirect component:
New optional properties:
typetype (object)Updated ak-stage-dummy component:
New optional properties:
typetype (object)Updated ak-stage-authenticator-validate component:
New optional properties:
typetype (object)Updated ak-stage-consent component:
New optional properties:
typetype (object)Updated ak-provider-oauth2-device-code component:
New optional properties:
typetype (object)Updated ak-stage-prompt component:
New optional properties:
typetype (object)Updated ak-stage-identification component:
New optional properties:
typeAdded property allow_show_password (boolean)
Deleted property type (object)
GET /oauth2/access_tokens/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Serializer for BaseGrantModel and RefreshToken
Changed property user (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)GET /oauth2/authorization_codes/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Serializer for BaseGrantModel and ExpiringBaseGrant
Changed property user (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)GET /oauth2/refresh_tokens/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Serializer for BaseGrantModel and RefreshToken
Changed property user (object)
User Serializer
Changed property groups_obj (array)
Changed items (object): > Simplified Group Serializer for user's groups
name (string)POST /stages/identification/Changed content type : application/json
password_stage (string)
When set, shows a password field, instead of showing the password field as separate step.
Changed response : 201 Created
application/json
password_stage (string)
When set, shows a password field, instead of showing the password field as separate step.
GET /stages/identification/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > IdentificationStage Serializer
password_stage (string)
When set, shows a password field, instead of showing the password field as separate step.
POST /stages/password/Changed content type : application/json
allow_show_password (boolean)
When enabled, provides a 'show password' button with the password input field.
Changed response : 201 Created
application/json
allow_show_password (boolean)
When enabled, provides a 'show password' button with the password input field.
GET /stages/password/Added: allow_show_password in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > PasswordStage Serializer
allow_show_password (boolean)
When enabled, provides a 'show password' button with the password input field.
POST /stages/prompt/prompts/preview/Changed response : 200 OK
Changed content type : application/json
New optional properties:
typetype (object)