website/docs/releases/2025/v2025.12.md
As a first step to overhaul authentik's access control system, much of how groups and roles work internally is altered in this release. We recommend you check any custom code (e.g. expression policies, property mappings) that deals with group/role memberships or access control.
:::warning Make sure your group names are unique before starting the upgrade. :::
From 2024.6, authentik enforced group name uniqueness through the API. However, groups created earlier or groups created by non-API mechanisms (e.g. a sync from a Source) may have left groups with duplicate names in your system. With 2025.12, group name uniqueness will now be enforced on the database-level.
We played with automatically renaming duplicates, but ultimately found it too confusing for admins. Instead, we made the migration fail loudly in case offending groups exist and now require manual renaming.
Groups already inherit is_superuser from their ancestor groups. With 2025.12, groups will also inherit all permissions from their ancestor groups.
Groups can now have multiple parent groups. Specifically, the Group.parent field (which was a ForeignKey) is now migrated to Group.parents (which is a ManyToManyField).
All permissions now must be attached to a role. The direct relationships between the User and Permission models still exist (User.user_permissions and User.userobjectpermission_set), but they are not used and will be removed in a future release.
File storage has been reworked to unify media file configuration (icons, branding options), and allow future uses of file storage including CSV Data Exports.
Files stored by authentik are now served from the /files prefix, and not from /media anymore. Any custom reverse proxy configuration handling those paths will need to be updated.
If local storage is used, authentik now expects a mount at /data for file storage. The existing /media mount must be moved to /data/media.
For Docker Compose users, the migration is as follows:
# Shut down authentik
docker compose down
# Create the new storage folder
mkdir -p ./data
# Move the old media storage to the new location
mv ./media ./data/media
# Download the new Docker Compose with the updated paths and start authentik. See below for details.
New storage configuration options are available. See the storage settings reference for details.
Endpoint Devices are end-user devices or servers that are integrated with authentik.
Devices can be integrated by installing the authentik Agent which supports:
Connectors allow authentik to fetch device information which enables Device Compliance functionality in authentik flows and policies. For example, you can limit authentication to devices running a specific OS or OS version.
Currently, only the authentik Agent connector is supported. Connectors to fetch information from third-party tools like Fleet, Cloudflare WARP, and Microsoft Intune are in development.
authentik now allows you to export user and event data in CSV format for backup or analysis purposes. The exported content matches that returned by the API endpoints for the respective object types. You can access past data exports from System Management > Data Exports, where you can view the query used for each export, search by data type and user, download completed exports, and delete exports you no longer need.
See Data Exports documentation for more details.
WebAuthn Conditional UI allows passkeys to appear directly in the browser's autofill dropdown alongside saved passwords. When a user focuses on a login input field, their registered passkeys are presented as autofill options, enabling a seamless passwordless authentication experience without requiring users to explicitly select a passkey option first.
This feature improves the discoverability of passkeys and reduces friction for users who have registered WebAuthn credentials, making passwordless login as intuitive as traditional password autofill.
See the Passkey Autofill documentation for more details.
authentik's access control is now completely role-based. The 2025.12 release also provides support for multiple parents for a group, inherited permissions from ancestors, allowing one or MORE roles to be assigned to a single group, and enforcement of unique names for groups. Additionally, object permissions are auto-assigned to the object's creator via managed roles, to ensure CRUD rights.
If you currently have user permissions defined, they will be migrated to the role named ak-migrated-role--user-{user_id}.
authentik now provides a centralized file management system for storing and organizing image files used throughout the platform. This includes application icons, source icons, and branding assets such as logos, favicons, and flow background images. Files can be uploaded and managed from Customization > Files in the Admin interface. By default, files are stored on disk, but S3 storage can also be configured.
See Files documentation for more details.
Flows now work better on smaller screens, including fixes for scrollbars on mobile and tablet devices, smarter login card shadows, and better form label alignment. If you use custom styles, you may need to revise them.
A locale selector is now available on the login screen, allowing users to choose their preferred language before authenticating. The selected locale persists for the browser session, and after authentication, user attributes take priority over the session preference if configured. We've also improved locale detection and updated our locale management to make future translations easier.
Sources can now be promoted to display as primary buttons on the login page instead of small icons. This allows administrators to emphasize preferred social login providers (such as Google, GitHub, or Discord) by giving them more visual prominence in the authentication flow, making it easier for users to identify and select their preferred login method.
We have replaced our too-short Terminology page with a more rich Glossary, with terms that are searchable by tags or first letter.
An integration is how authentik connects to third-party applications, directories, and other identity providers. The following integration guides were recently added. A big thanks to the contributors of many of these new guides.
This release does not introduce any new requirements, but be sure to read about any breaking changes. 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/2025.12/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 ^2025.12
ModuleNotFoundError in import_relative (#18683)<datalist> on Firefox. (#18103)logout+jwt token type for oidc logout token. (cherry-pick #19554 to version-2025.12) by @authentik-automation[bot] in https://github.com/goauthentik/authentik/pull/19675challenge nullish types. (cherry-pick #19768 to version-2025.12) by @authentik-automation[bot] in https://github.com/goauthentik/authentik/pull/19777GET /admin/file/POST /admin/file/DELETE /admin/file/GET /admin/file/used_by/POST /core/users/export/GET /endpoints/agents/connectors/POST /endpoints/agents/connectors/GET /endpoints/agents/connectors/{#123;connector_uuid}#125;/PUT /endpoints/agents/connectors/{#123;connector_uuid}#125;/DELETE /endpoints/agents/connectors/{#123;connector_uuid}#125;/PATCH /endpoints/agents/connectors/{#123;connector_uuid}#125;/POST /endpoints/agents/connectors/{#123;connector_uuid}#125;/mdm_config/GET /endpoints/agents/connectors/{#123;connector_uuid}#125;/used_by/GET /endpoints/agents/connectors/agent_config/POST /endpoints/agents/connectors/auth_fed/POST /endpoints/agents/connectors/auth_ia/POST /endpoints/agents/connectors/check_in/POST /endpoints/agents/connectors/enroll/GET /endpoints/agents/enrollment_tokens/POST /endpoints/agents/enrollment_tokens/GET /endpoints/agents/enrollment_tokens/{#123;token_uuid}#125;/PUT /endpoints/agents/enrollment_tokens/{#123;token_uuid}#125;/DELETE /endpoints/agents/enrollment_tokens/{#123;token_uuid}#125;/PATCH /endpoints/agents/enrollment_tokens/{#123;token_uuid}#125;/GET /endpoints/agents/enrollment_tokens/{#123;token_uuid}#125;/used_by/GET /endpoints/agents/enrollment_tokens/{#123;token_uuid}#125;/view_key/POST /endpoints/agents/psso/register/device/POST /endpoints/agents/psso/register/user/GET /endpoints/connectors/GET /endpoints/connectors/{#123;connector_uuid}#125;/DELETE /endpoints/connectors/{#123;connector_uuid}#125;/GET /endpoints/connectors/{#123;connector_uuid}#125;/used_by/GET /endpoints/connectors/types/GET /endpoints/device_access_groups/POST /endpoints/device_access_groups/GET /endpoints/device_access_groups/{#123;pbm_uuid}#125;/PUT /endpoints/device_access_groups/{#123;pbm_uuid}#125;/DELETE /endpoints/device_access_groups/{#123;pbm_uuid}#125;/PATCH /endpoints/device_access_groups/{#123;pbm_uuid}#125;/GET /endpoints/device_access_groups/{#123;pbm_uuid}#125;/used_by/GET /endpoints/device_bindings/POST /endpoints/device_bindings/GET /endpoints/device_bindings/{#123;policy_binding_uuid}#125;/PUT /endpoints/device_bindings/{#123;policy_binding_uuid}#125;/DELETE /endpoints/device_bindings/{#123;policy_binding_uuid}#125;/PATCH /endpoints/device_bindings/{#123;policy_binding_uuid}#125;/GET /endpoints/device_bindings/{#123;policy_binding_uuid}#125;/used_by/GET /endpoints/devices/GET /endpoints/devices/{#123;device_uuid}#125;/PUT /endpoints/devices/{#123;device_uuid}#125;/DELETE /endpoints/devices/{#123;device_uuid}#125;/PATCH /endpoints/devices/{#123;device_uuid}#125;/GET /endpoints/devices/{#123;device_uuid}#125;/used_by/GET /endpoints/devices/summary/POST /events/events/export/POST /rbac/roles/{#123;uuid}#125;/add_user/POST /rbac/roles/{#123;uuid}#125;/remove_user/GET /reports/exports/GET /reports/exports/{#123;id}#125;/DELETE /reports/exports/{#123;id}#125;/POST /sources/telegram/{#123;slug}#125;/connect_user/GET /stages/endpoints/POST /stages/endpoints/GET /stages/endpoints/{#123;stage_uuid}#125;/PUT /stages/endpoints/{#123;stage_uuid}#125;/DELETE /stages/endpoints/{#123;stage_uuid}#125;/PATCH /stages/endpoints/{#123;stage_uuid}#125;/GET /stages/endpoints/{#123;stage_uuid}#125;/used_by/POST /core/applications/{#123;slug}#125;/set_icon/POST /core/applications/{#123;slug}#125;/set_icon_url/POST /flows/instances/{#123;slug}#125;/set_background/POST /flows/instances/{#123;slug}#125;/set_background_url/GET /rbac/permissions/assigned_by_users/POST /rbac/permissions/assigned_by_users/{#123;id}#125;/assign/PATCH /rbac/permissions/assigned_by_users/{#123;id}#125;/unassign/GET /rbac/permissions/roles/{#123;id}#125;/PUT /rbac/permissions/roles/{#123;id}#125;/DELETE /rbac/permissions/roles/{#123;id}#125;/PATCH /rbac/permissions/roles/{#123;id}#125;/GET /rbac/permissions/users/GET /rbac/permissions/users/{#123;id}#125;/PUT /rbac/permissions/users/{#123;id}#125;/DELETE /rbac/permissions/users/{#123;id}#125;/PATCH /rbac/permissions/users/{#123;id}#125;/POST /sources/all/{#123;slug}#125;/set_icon/POST /sources/all/{#123;slug}#125;/set_icon_url/GET /admin/settings/Changed response : 200 OK
application/json
Added property pagination_default_page_size (integer)
Default page size for API responses, if no size was requested.
Added property pagination_max_page_size (integer)
Maximum page size
Changed property flags (object)
New required properties:
flows_refresh_othersflows_refresh_others (boolean)PUT /admin/settings/Changed content type : application/json
Added property pagination_default_page_size (integer)
Default page size for API responses, if no size was requested.
Added property pagination_max_page_size (integer)
Maximum page size
Changed property flags (object)
New required properties:
flows_refresh_othersflows_refresh_others (boolean)Changed response : 200 OK
application/json
Added property pagination_default_page_size (integer)
Default page size for API responses, if no size was requested.
Added property pagination_max_page_size (integer)
Maximum page size
Changed property flags (object)
New required properties:
flows_refresh_othersflows_refresh_others (boolean)PATCH /admin/settings/Changed content type : application/json
Added property pagination_default_page_size (integer)
Default page size for API responses, if no size was requested.
Added property pagination_max_page_size (integer)
Maximum page size
Changed property flags (object)
New required properties:
flows_refresh_othersflows_refresh_others (boolean)Changed response : 200 OK
application/json
Added property pagination_default_page_size (integer)
Default page size for API responses, if no size was requested.
Added property pagination_max_page_size (integer)
Maximum page size
Changed property flags (object)
New required properties:
flows_refresh_othersflows_refresh_others (boolean)POST /core/tokens/{#123;identifier}#125;/set_key/Changed content type : application/json
GET /crypto/certificatekeypairs/{#123;kp_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
key_typeNew optional properties:
private_key_typeAdded property key_type (object)
Enum values:
rsaecdsaed25519ed448Deleted property private_key_type (string)
Get the private key's type, if set
PUT /crypto/certificatekeypairs/{#123;kp_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
key_typeNew optional properties:
private_key_typeAdded property key_type (object)
Deleted property private_key_type (string)
Get the private key's type, if set
PATCH /crypto/certificatekeypairs/{#123;kp_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
key_typeNew optional properties:
private_key_typeAdded property key_type (object)
Deleted property private_key_type (string)
Get the private key's type, if set
POST /crypto/certificatekeypairs/generate/Changed response : 200 OK
Changed content type : application/json
New required properties:
key_typeNew optional properties:
private_key_typeAdded property key_type (object)
Deleted property private_key_type (string)
Get the private key's type, if set
GET /events/events/actions/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > Types of an object that can be created
deprecated (boolean)GET /outposts/service_connections/all/types/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > Types of an object that can be created
deprecated (boolean)GET /policies/all/types/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > Types of an object that can be created
deprecated (boolean)GET /policies/bindings/{#123;policy_binding_uuid}#125;/Changed response : 200 OK
application/json
Changed property group_obj (object)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
PUT /policies/bindings/{#123;policy_binding_uuid}#125;/Changed response : 200 OK
application/json
Changed property group_obj (object)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
PATCH /policies/bindings/{#123;policy_binding_uuid}#125;/Changed response : 200 OK
application/json
Changed property group_obj (object)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /policies/event_matcher/{#123;policy_uuid}#125;/Changed response : 200 OK
application/json
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Added enum value:
export_readyChanged property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.endpointsauthentik.endpoints.connectors.agentauthentik.admin.filesauthentik.enterprise.endpoints.connectors.agentauthentik.enterprise.reportsChanged 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_endpoints.deviceuserbindingauthentik_endpoints.deviceaccessgroupauthentik_endpoints.endpointstageauthentik_endpoints_connectors_agent.agentconnectorauthentik_endpoints_connectors_agent.agentdeviceuserbindingauthentik_endpoints_connectors_agent.enrollmenttokenauthentik_reports.dataexportPUT /policies/event_matcher/{#123;policy_uuid}#125;/Changed content type : application/json
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Added enum value:
export_readyChanged property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.endpointsauthentik.endpoints.connectors.agentauthentik.admin.filesauthentik.enterprise.endpoints.connectors.agentauthentik.enterprise.reportsChanged 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_endpoints.deviceuserbindingauthentik_endpoints.deviceaccessgroupauthentik_endpoints.endpointstageauthentik_endpoints_connectors_agent.agentconnectorauthentik_endpoints_connectors_agent.agentdeviceuserbindingauthentik_endpoints_connectors_agent.enrollmenttokenauthentik_reports.dataexportChanged response : 200 OK
application/json
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Added enum value:
export_readyChanged property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.endpointsauthentik.endpoints.connectors.agentauthentik.admin.filesauthentik.enterprise.endpoints.connectors.agentauthentik.enterprise.reportsChanged 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_endpoints.deviceuserbindingauthentik_endpoints.deviceaccessgroupauthentik_endpoints.endpointstageauthentik_endpoints_connectors_agent.agentconnectorauthentik_endpoints_connectors_agent.agentdeviceuserbindingauthentik_endpoints_connectors_agent.enrollmenttokenauthentik_reports.dataexportPATCH /policies/event_matcher/{#123;policy_uuid}#125;/Changed content type : application/json
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Added enum value:
export_readyChanged property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.endpointsauthentik.endpoints.connectors.agentauthentik.admin.filesauthentik.enterprise.endpoints.connectors.agentauthentik.enterprise.reportsChanged 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_endpoints.deviceuserbindingauthentik_endpoints.deviceaccessgroupauthentik_endpoints.endpointstageauthentik_endpoints_connectors_agent.agentconnectorauthentik_endpoints_connectors_agent.agentdeviceuserbindingauthentik_endpoints_connectors_agent.enrollmenttokenauthentik_reports.dataexportChanged response : 200 OK
application/json
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Added enum value:
export_readyChanged property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.endpointsauthentik.endpoints.connectors.agentauthentik.admin.filesauthentik.enterprise.endpoints.connectors.agentauthentik.enterprise.reportsChanged 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_endpoints.deviceuserbindingauthentik_endpoints.deviceaccessgroupauthentik_endpoints.endpointstageauthentik_endpoints_connectors_agent.agentconnectorauthentik_endpoints_connectors_agent.agentdeviceuserbindingauthentik_endpoints_connectors_agent.enrollmenttokenauthentik_reports.dataexportGET /propertymappings/all/types/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > Types of an object that can be created
deprecated (boolean)GET /providers/all/types/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > Types of an object that can be created
deprecated (boolean)GET /providers/google_workspace_groups/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property group_obj (object)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /providers/microsoft_entra_groups/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property group_obj (object)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
POST /providers/saml/import_metadata/New response : 201 Created Deleted response : 204 No Content
Successfully imported provider
GET /providers/scim_groups/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property group_obj (object)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /sources/all/types/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > Types of an object that can be created
deprecated (boolean)GET /sources/scim_groups/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property group_obj (object)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
PUT /sources/scim_groups/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property group_obj (object)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
PATCH /sources/scim_groups/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property group_obj (object)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /stages/all/types/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > Types of an object that can be created
deprecated (boolean)GET /stages/email/templates/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > Types of an object that can be created
deprecated (boolean)GET /authenticators/duo/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /authenticators/email/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /authenticators/endpoint/{#123;uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /authenticators/sms/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /authenticators/static/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /authenticators/totp/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /authenticators/webauthn/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /core/application_entitlements/{#123;pbm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /core/applications/{#123;slug}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
meta_icon_urlNew optional properties:
meta_iconAdded property meta_icon_url (string)
Get the URL to the App Icon image
Changed property slug (string)
Internal application name, used in URLs.
Changed property meta_icon (string)
PUT /core/applications/{#123;slug}#125;/Changed content type : application/json
Added property meta_icon (string)
Changed property slug (string)
Internal application name, used in URLs.
Changed response : 200 OK
Changed content type : application/json
New required properties:
meta_icon_urlNew optional properties:
meta_iconAdded property meta_icon_url (string)
Get the URL to the App Icon image
Changed property slug (string)
Internal application name, used in URLs.
Changed property meta_icon (string)
PATCH /core/applications/{#123;slug}#125;/Changed content type : application/json
Added property meta_icon (string)
Changed property slug (string)
Internal application name, used in URLs.
Changed response : 200 OK
Changed content type : application/json
New required properties:
meta_icon_urlNew optional properties:
meta_iconAdded property meta_icon_url (string)
Get the URL to the App Icon image
Changed property slug (string)
Internal application name, used in URLs.
Changed property meta_icon (string)
GET /core/applications/{#123;slug}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /core/authenticated_sessions/{#123;uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /core/brands/{#123;brand_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /core/brands/current/Changed response : 200 OK
application/json
Changed property flags (object)
New required properties:
flows_refresh_othersflows_refresh_others (boolean)GET /core/groups/{#123;group_uuid}#125;/Added: include_parents in query
Changed response : 200 OK
Changed content type : application/json
New required properties:
childrenparents_objNew optional properties:
parent_nameAdded property parents (array)
Items (string):
Added property parents_obj (array)
Items (object): > Stripped down group serializer to show relevant children/parents for groups
Property pk (string)
Property name (string)
Property is_superuser (boolean)
Users added to this group will be superusers.
Property attributes (object)
Property group_uuid (string)
Deleted property parent (string)
Deleted property parent_name (string)
Changed property children (array)
Changed property children_obj (array)
Changed items (object): > Stripped down group serializer to show relevant children/parents for groups
PUT /core/groups/{#123;group_uuid}#125;/Changed content type : application/json
Added property parents (array)
Deleted property parent (string)
Deleted property children (array)
Changed response : 200 OK
Changed content type : application/json
New required properties:
childrenparents_objNew optional properties:
parent_nameAdded property parents (array)
Added property parents_obj (array)
Deleted property parent (string)
Deleted property parent_name (string)
Changed property children (array)
Changed property children_obj (array)
Changed items (object): > Stripped down group serializer to show relevant children/parents for groups
PATCH /core/groups/{#123;group_uuid}#125;/Changed content type : application/json
Added property parents (array)
Deleted property parent (string)
Deleted property children (array)
Changed response : 200 OK
Changed content type : application/json
New required properties:
childrenparents_objNew optional properties:
parent_nameAdded property parents (array)
Added property parents_obj (array)
Deleted property parent (string)
Deleted property parent_name (string)
Changed property children (array)
Changed property children_obj (array)
Changed items (object): > Stripped down group serializer to show relevant children/parents for groups
GET /core/groups/{#123;group_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /core/tokens/{#123;identifier}#125;/Changed response : 200 OK
application/json
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Items (object): > Role serializer
Property pk (string)
Property name (string)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
PUT /core/tokens/{#123;identifier}#125;/Changed response : 200 OK
application/json
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
PATCH /core/tokens/{#123;identifier}#125;/Changed response : 200 OK
application/json
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /core/tokens/{#123;identifier}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /core/user_consent/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /core/users/{#123;id}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
PUT /core/users/{#123;id}#125;/Changed content type : application/json
roles (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
PATCH /core/users/{#123;id}#125;/Changed content type : application/json
roles (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /core/users/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingPOST /crypto/certificatekeypairs/Changed response : 201 Created
Changed content type : application/json
New required properties:
key_typeNew optional properties:
private_key_typeAdded property key_type (object)
Deleted property private_key_type (string)
Get the private key's type, if set
GET /crypto/certificatekeypairs/Added: key_type in query
Filter by key algorithm type (RSA, EC, DSA, etc). Can be specified multiple times (e.g. '?key_type=rsa&key_type=ec')
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > CertificateKeyPair Serializer
New required properties:
key_typeNew optional properties:
private_key_typeAdded property key_type (object)
Deleted property private_key_type (string)
Get the private key's type, if set
GET /crypto/certificatekeypairs/{#123;kp_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /enterprise/license/{#123;license_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /events/events/{#123;event_uuid}#125;/Changed response : 200 OK
application/json
Changed property action (string)
Added enum value:
export_readyPUT /events/events/{#123;event_uuid}#125;/Changed content type : application/json
Changed property action (string)
Added enum value:
export_readyChanged response : 200 OK
application/json
Changed property action (string)
Added enum value:
export_readyPATCH /events/events/{#123;event_uuid}#125;/Changed content type : application/json
Changed property action (string)
Added enum value:
export_readyChanged response : 200 OK
application/json
Changed property action (string)
Added enum value:
export_readyGET /events/events/volume/Changed: actions in query
Changed response : 200 OK
Changed content type : application/json
Changed items (object): > Count of events of action created on day
Changed property action (string)
Added enum value:
export_readyGET /events/notifications/{#123;uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /events/rules/{#123;pbm_uuid}#125;/Changed response : 200 OK
application/json
Changed property destination_group_obj (object)
Group Serializer
New required properties:
childrenparents_objNew optional properties:
parent_nameAdded property parents (array)
Added property parents_obj (array)
Deleted property parent (string)
Deleted property parent_name (string)
Changed property children (array)
Changed property children_obj (array)
Changed items (object): > Stripped down group serializer to show relevant children/parents for groups
PUT /events/rules/{#123;pbm_uuid}#125;/Changed response : 200 OK
application/json
Changed property destination_group_obj (object)
Group Serializer
New required properties:
childrenparents_objNew optional properties:
parent_nameAdded property parents (array)
Added property parents_obj (array)
Deleted property parent (string)
Deleted property parent_name (string)
Changed property children (array)
Changed property children_obj (array)
Changed items (object): > Stripped down group serializer to show relevant children/parents for groups
PATCH /events/rules/{#123;pbm_uuid}#125;/Changed response : 200 OK
application/json
Changed property destination_group_obj (object)
Group Serializer
New required properties:
childrenparents_objNew optional properties:
parent_nameAdded property parents (array)
Added property parents_obj (array)
Deleted property parent (string)
Deleted property parent_name (string)
Changed property children (array)
Changed property children_obj (array)
Changed items (object): > Stripped down group serializer to show relevant children/parents for groups
GET /events/rules/{#123;pbm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /events/transports/{#123;uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /flows/bindings/{#123;fsb_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /flows/instances/{#123;slug}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Changed property slug (string)
Visible in the URL.
Changed property background (string)
Background shown during execution
PUT /flows/instances/{#123;slug}#125;/Changed content type : application/json
Added property background (string)
Background shown during execution
Changed property slug (string)
Visible in the URL.
Changed response : 200 OK
Changed content type : application/json
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Changed property slug (string)
Visible in the URL.
Changed property background (string)
Background shown during execution
PATCH /flows/instances/{#123;slug}#125;/Changed content type : application/json
Added property background (string)
Background shown during execution
Changed property slug (string)
Visible in the URL.
Changed response : 200 OK
Changed content type : application/json
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Changed property slug (string)
Visible in the URL.
Changed property background (string)
Background shown during execution
GET /flows/instances/{#123;slug}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /managed/blueprints/{#123;instance_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /oauth2/access_tokens/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /oauth2/authorization_codes/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /oauth2/refresh_tokens/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /outposts/instances/{#123;uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /outposts/service_connections/all/{#123;uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /outposts/service_connections/docker/{#123;uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /outposts/service_connections/kubernetes/{#123;uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /policies/all/{#123;policy_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingPOST /policies/bindings/Changed response : 201 Created
application/json
Changed property group_obj (object)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_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)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /policies/bindings/{#123;policy_binding_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /policies/dummy/{#123;policy_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingPOST /policies/event_matcher/Changed content type : application/json
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Added enum value:
export_readyChanged property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.endpointsauthentik.endpoints.connectors.agentauthentik.admin.filesauthentik.enterprise.endpoints.connectors.agentauthentik.enterprise.reportsChanged 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_endpoints.deviceuserbindingauthentik_endpoints.deviceaccessgroupauthentik_endpoints.endpointstageauthentik_endpoints_connectors_agent.agentconnectorauthentik_endpoints_connectors_agent.agentdeviceuserbindingauthentik_endpoints_connectors_agent.enrollmenttokenauthentik_reports.dataexportChanged response : 201 Created
application/json
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Added enum value:
export_readyChanged property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.endpointsauthentik.endpoints.connectors.agentauthentik.admin.filesauthentik.enterprise.endpoints.connectors.agentauthentik.enterprise.reportsChanged 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_endpoints.deviceuserbindingauthentik_endpoints.deviceaccessgroupauthentik_endpoints.endpointstageauthentik_endpoints_connectors_agent.agentconnectorauthentik_endpoints_connectors_agent.agentdeviceuserbindingauthentik_endpoints_connectors_agent.enrollmenttokenauthentik_reports.dataexportGET /policies/event_matcher/Changed: action in query
Match created events with this action type. When left empty, all action types will be matched.
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Event Matcher Policy Serializer
Changed property action (string)
Match created events with this action type. When left empty, all action types will be matched.
Added enum value:
export_readyChanged property app (string)
Match events created by selected application. When left empty, all applications are matched.
Added enum values:
authentik.endpointsauthentik.endpoints.connectors.agentauthentik.admin.filesauthentik.enterprise.endpoints.connectors.agentauthentik.enterprise.reportsChanged 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_endpoints.deviceuserbindingauthentik_endpoints.deviceaccessgroupauthentik_endpoints.endpointstageauthentik_endpoints_connectors_agent.agentconnectorauthentik_endpoints_connectors_agent.agentdeviceuserbindingauthentik_endpoints_connectors_agent.enrollmenttokenauthentik_reports.dataexportGET /policies/event_matcher/{#123;policy_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /policies/expression/{#123;policy_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /policies/geoip/{#123;policy_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /policies/password/{#123;policy_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /policies/password_expiry/{#123;policy_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /policies/reputation/{#123;policy_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /policies/reputation/scores/{#123;reputation_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /policies/unique_password/{#123;policy_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/all/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/notification/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/provider/google_workspace/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/provider/microsoft_entra/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/provider/rac/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/provider/radius/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/provider/saml/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/provider/scim/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/provider/scope/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/source/kerberos/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/source/ldap/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/source/oauth/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/source/plex/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/source/saml/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/source/scim/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /propertymappings/source/telegram/{#123;pm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /providers/all/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /providers/google_workspace/{#123;id}#125;/Changed response : 200 OK
application/json
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
PUT /providers/google_workspace/{#123;id}#125;/Changed content type : application/json
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
Changed response : 200 OK
application/json
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
PATCH /providers/google_workspace/{#123;id}#125;/Changed content type : application/json
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
Changed response : 200 OK
application/json
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
GET /providers/google_workspace/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingPOST /providers/google_workspace_groups/Changed response : 201 Created
application/json
Changed property group_obj (object)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_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)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /providers/google_workspace_groups/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /providers/google_workspace_users/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /providers/ldap/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /providers/microsoft_entra/{#123;id}#125;/Changed response : 200 OK
application/json
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
PUT /providers/microsoft_entra/{#123;id}#125;/Changed content type : application/json
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
Changed response : 200 OK
application/json
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
PATCH /providers/microsoft_entra/{#123;id}#125;/Changed content type : application/json
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
Changed response : 200 OK
application/json
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
GET /providers/microsoft_entra/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingPOST /providers/microsoft_entra_groups/Changed response : 201 Created
application/json
Changed property group_obj (object)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_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)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /providers/microsoft_entra_groups/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /providers/microsoft_entra_users/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /providers/oauth2/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /providers/proxy/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /providers/rac/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /providers/radius/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /providers/saml/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /providers/scim/{#123;id}#125;/Changed response : 200 OK
application/json
Added property service_provider_config_cache_timeout (string)
Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
PUT /providers/scim/{#123;id}#125;/Changed content type : application/json
Added property service_provider_config_cache_timeout (string)
Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
Changed response : 200 OK
application/json
Added property service_provider_config_cache_timeout (string)
Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
PATCH /providers/scim/{#123;id}#125;/Changed content type : application/json
Added property service_provider_config_cache_timeout (string)
Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
Changed response : 200 OK
application/json
Added property service_provider_config_cache_timeout (string)
Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
GET /providers/scim/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingPOST /providers/scim_groups/Changed response : 201 Created
application/json
Changed property group_obj (object)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_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)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /providers/scim_groups/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /providers/scim_users/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /providers/ssf/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
PUT /providers/ssf/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
PATCH /providers/ssf/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /providers/ssf/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /rac/connection_tokens/{#123;connection_token_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /rac/endpoints/{#123;pbm_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /rbac/initial_permissions/{#123;id}#125;/Changed response : 200 OK
Changed content type : application/json
New optional properties:
modemode (object)PUT /rbac/initial_permissions/{#123;id}#125;/Changed content type : application/json
New optional properties:
modemode (object)Changed response : 200 OK
Changed content type : application/json
New optional properties:
modemode (object)PATCH /rbac/initial_permissions/{#123;id}#125;/Changed content type : application/json
mode (object)Changed response : 200 OK
Changed content type : application/json
New optional properties:
modemode (object)GET /rbac/initial_permissions/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /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
New required properties:
model_permissionsobject_permissionsNew optional properties:
permissionsAdded property object_permissions (array)
Items (object): > Role-bound object level permission
Property id (integer)
Property codename (string)
Property model (string)
Property app_label (string)
Property object_pk (string)
Property name (string)
Added property model_permissions (array)
Items (object): > Role-bound object level permission
Property id (integer)
Property codename (string)
Property model (string)
Property app_label (string)
Property name (string)
Deleted property permissions (array)
POST /rbac/permissions/assigned_by_roles/{#123;uuid}#125;/assign/Changed content type : application/json
Changed property model (string)
Added enum values:
authentik_endpoints.deviceuserbindingauthentik_endpoints.deviceaccessgroupauthentik_endpoints.endpointstageauthentik_endpoints_connectors_agent.agentconnectorauthentik_endpoints_connectors_agent.agentdeviceuserbindingauthentik_endpoints_connectors_agent.enrollmenttokenauthentik_reports.dataexportPATCH /rbac/permissions/assigned_by_roles/{#123;uuid}#125;/unassign/Changed content type : application/json
Changed property model (string)
Added enum values:
authentik_endpoints.deviceuserbindingauthentik_endpoints.deviceaccessgroupauthentik_endpoints.endpointstageauthentik_endpoints_connectors_agent.agentconnectorauthentik_endpoints_connectors_agent.agentdeviceuserbindingauthentik_endpoints_connectors_agent.enrollmenttokenauthentik_reports.dataexportGET /rbac/permissions/roles/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Role permission with additional object-related data
object_description (string)
Get model description from attached model. This operation takes at least one additional query, and the description is only shown if the role has the view_ permission on the object
GET /rbac/roles/Added: managed in query
Added: managed__isnull in query
Added: users in query
GET /rbac/roles/{#123;uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/all/{#123;slug}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/all/{#123;slug}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/group_connections/all/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/group_connections/all/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/group_connections/all/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/group_connections/all/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/group_connections/kerberos/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/group_connections/kerberos/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/group_connections/kerberos/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/group_connections/kerberos/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/group_connections/ldap/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/group_connections/ldap/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/group_connections/ldap/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/group_connections/ldap/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/group_connections/oauth/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/group_connections/oauth/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/group_connections/oauth/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/group_connections/oauth/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/group_connections/plex/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/group_connections/plex/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/group_connections/plex/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/group_connections/plex/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/group_connections/saml/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/group_connections/saml/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/group_connections/saml/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/group_connections/saml/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/group_connections/telegram/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/group_connections/telegram/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/group_connections/telegram/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/group_connections/telegram/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/kerberos/{#123;slug}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Enum values:
noneimmediatedeferred_endChanged property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/kerberos/{#123;slug}#125;/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/kerberos/{#123;slug}#125;/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/kerberos/{#123;slug}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/ldap/{#123;slug}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/ldap/{#123;slug}#125;/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/ldap/{#123;slug}#125;/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/ldap/{#123;slug}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/oauth/{#123;slug}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
Changed property provider_type (string)
Added enum values:
slackwechatPUT /sources/oauth/{#123;slug}#125;/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property provider_type (string)
Added enum values:
slackwechatChanged response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
Changed property provider_type (string)
Added enum values:
slackwechatPATCH /sources/oauth/{#123;slug}#125;/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property provider_type (string)
Added enum values:
slackwechatChanged response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
Changed property provider_type (string)
Added enum values:
slackwechatGET /sources/oauth/{#123;slug}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/plex/{#123;slug}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/plex/{#123;slug}#125;/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/plex/{#123;slug}#125;/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/plex/{#123;slug}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/saml/{#123;slug}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/saml/{#123;slug}#125;/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/saml/{#123;slug}#125;/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/saml/{#123;slug}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/scim/{#123;slug}#125;/Changed response : 200 OK
application/json
Changed property slug (string)
Internal source name, used in URLs.
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
PUT /sources/scim/{#123;slug}#125;/Changed content type : application/json
slug (string)
Internal source name, used in URLs.
Changed response : 200 OK
application/json
Changed property slug (string)
Internal source name, used in URLs.
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
PATCH /sources/scim/{#123;slug}#125;/Changed content type : application/json
slug (string)
Internal source name, used in URLs.
Changed response : 200 OK
application/json
Changed property slug (string)
Internal source name, used in URLs.
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /sources/scim/{#123;slug}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingPOST /sources/scim_groups/Changed response : 201 Created
application/json
Changed property group_obj (object)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_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)
Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /sources/scim_groups/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/scim_users/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/telegram/{#123;slug}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/telegram/{#123;slug}#125;/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/telegram/{#123;slug}#125;/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 200 OK
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/telegram/{#123;slug}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/user_connections/all/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/user_connections/all/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/user_connections/all/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/user_connections/all/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/user_connections/kerberos/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/user_connections/kerberos/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/user_connections/kerberos/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/user_connections/kerberos/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/user_connections/ldap/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/user_connections/ldap/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/user_connections/ldap/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/user_connections/ldap/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/user_connections/oauth/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/user_connections/oauth/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/user_connections/oauth/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/user_connections/oauth/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/user_connections/plex/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/user_connections/plex/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/user_connections/plex/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/user_connections/plex/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/user_connections/saml/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/user_connections/saml/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/user_connections/saml/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/user_connections/saml/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /sources/user_connections/telegram/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PUT /sources/user_connections/telegram/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
PATCH /sources/user_connections/telegram/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/user_connections/telegram/{#123;id}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /ssf/streams/{#123;uuid}#125;/Changed response : 200 OK
application/json
Changed property provider_obj (object)
SSFProvider Serializer
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /stages/all/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/authenticator/duo/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/authenticator/email/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/authenticator/endpoint_gdtc/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/authenticator/sms/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/authenticator/static/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/authenticator/totp/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/authenticator/validate/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/authenticator/webauthn/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/captcha/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/consent/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/deny/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/dummy/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/email/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/identification/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/invitation/invitations/{#123;invite_uuid}#125;/Changed response : 200 OK
application/json
Changed property name (string)
Changed property flow_obj (object)
Flow Serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Changed property slug (string)
Visible in the URL.
Changed property background (string)
Background shown during execution
PUT /stages/invitation/invitations/{#123;invite_uuid}#125;/Changed content type : application/json
name (string)Changed response : 200 OK
application/json
Changed property name (string)
Changed property flow_obj (object)
Flow Serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Changed property slug (string)
Visible in the URL.
Changed property background (string)
Background shown during execution
PATCH /stages/invitation/invitations/{#123;invite_uuid}#125;/Changed content type : application/json
name (string)Changed response : 200 OK
application/json
Changed property name (string)
Changed property flow_obj (object)
Flow Serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Changed property slug (string)
Visible in the URL.
Changed property background (string)
Background shown during execution
GET /stages/invitation/invitations/{#123;invite_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/invitation/stages/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/mtls/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/password/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/prompt/prompts/{#123;prompt_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/prompt/stages/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/redirect/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/source/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/user_delete/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/user_login/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/user_logout/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingGET /stages/user_write/{#123;stage_uuid}#125;/used_by/Changed response : 200 OK
Changed content type : application/json
Changed items (object): > A list of all objects referencing the queried object
Changed property action (string)
Added enum value:
left_danglingPOST /core/applications/Changed content type : application/json
Added property meta_icon (string)
Changed property slug (string)
Internal application name, used in URLs.
Changed response : 201 Created
Changed content type : application/json
New required properties:
meta_icon_urlNew optional properties:
meta_iconAdded property meta_icon_url (string)
Get the URL to the App Icon image
Changed property slug (string)
Internal application name, used in URLs.
Changed property meta_icon (string)
GET /core/applications/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Application Serializer
New required properties:
meta_icon_urlNew optional properties:
meta_iconAdded property meta_icon_url (string)
Get the URL to the App Icon image
Changed property slug (string)
Internal application name, used in URLs.
Changed property meta_icon (string)
POST /core/groups/Changed content type : application/json
Added property parents (array)
Deleted property parent (string)
Deleted property children (array)
Changed response : 201 Created
Changed content type : application/json
New required properties:
childrenparents_objNew optional properties:
parent_nameAdded property parents (array)
Added property parents_obj (array)
Deleted property parent (string)
Deleted property parent_name (string)
Changed property children (array)
Changed property children_obj (array)
Changed items (object): > Stripped down group serializer to show relevant children/parents for groups
GET /core/groups/Added: include_parents in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Group Serializer
New required properties:
childrenparents_objNew optional properties:
parent_nameAdded property parents (array)
Added property parents_obj (array)
Deleted property parent (string)
Deleted property parent_name (string)
Changed property children (array)
Changed property children_obj (array)
Changed items (object): > Stripped down group serializer to show relevant children/parents for groups
POST /core/tokens/Changed response : 201 Created
application/json
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_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
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /core/user_consent/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property user (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
Changed property application (object)
Application Serializer
New required properties:
meta_icon_urlNew optional properties:
meta_iconAdded property meta_icon_url (string)
Get the URL to the App Icon image
Changed property slug (string)
Internal application name, used in URLs.
Changed property meta_icon (string)
POST /core/users/Changed content type : application/json
roles (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /core/users/Added: include_roles in query
Added: roles_by_name in query
Added: roles_by_pk in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /core/users/me/Changed response : 200 OK
application/json
Changed property user (object)
User Serializer for information a user can retrieve about themselves
New required properties:
rolesAdded property roles (array)
Items (object):
Property name (string)
Property pk (string)
POST /events/events/Changed content type : application/json
Changed property action (string)
Added enum value:
export_readyChanged response : 201 Created
application/json
Changed property action (string)
Added enum value:
export_readyGET /events/events/Changed: actions in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Event Serializer
Changed property action (string)
Added enum value:
export_readyGET /events/notifications/{#123;uuid}#125;/Changed response : 200 OK
application/json
Added property hyperlink (string)
Added property hyperlink_label (string)
Changed property event (object)
Event Serializer
Changed property action (string)
Added enum value:
export_readyPUT /events/notifications/{#123;uuid}#125;/Changed content type : application/json
Added property hyperlink (string)
Added property hyperlink_label (string)
Changed property event (object)
Event Serializer
Changed property action (string)
Added enum value:
export_readyChanged response : 200 OK
application/json
Added property hyperlink (string)
Added property hyperlink_label (string)
Changed property event (object)
Event Serializer
Changed property action (string)
Added enum value:
export_readyPATCH /events/notifications/{#123;uuid}#125;/Changed content type : application/json
Added property hyperlink (string)
Added property hyperlink_label (string)
Changed property event (object)
Event Serializer
Changed property action (string)
Added enum value:
export_readyChanged response : 200 OK
application/json
Added property hyperlink (string)
Added property hyperlink_label (string)
Changed property event (object)
Event Serializer
Changed property action (string)
Added enum value:
export_readyPOST /events/rules/Changed response : 201 Created
application/json
Changed property destination_group_obj (object)
Group Serializer
New required properties:
childrenparents_objNew optional properties:
parent_nameAdded property parents (array)
Added property parents_obj (array)
Deleted property parent (string)
Deleted property parent_name (string)
Changed property children (array)
Changed property children_obj (array)
Changed items (object): > Stripped down group serializer to show relevant children/parents for groups
GET /events/rules/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > NotificationRule Serializer
Changed property destination_group_obj (object)
Group Serializer
New required properties:
childrenparents_objNew optional properties:
parent_nameAdded property parents (array)
Added property parents_obj (array)
Deleted property parent (string)
Deleted property parent_name (string)
Changed property children (array)
Changed property children_obj (array)
Changed items (object): > Stripped down group serializer to show relevant children/parents for groups
GET /flows/bindings/{#123;fsb_uuid}#125;/Changed response : 200 OK
application/json
Changed property stage_obj (object)
Stage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /flows/bindings/{#123;fsb_uuid}#125;/Changed response : 200 OK
application/json
Changed property stage_obj (object)
Stage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /flows/bindings/{#123;fsb_uuid}#125;/Changed response : 200 OK
application/json
Changed property stage_obj (object)
Stage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /flows/instances/Changed content type : application/json
Added property background (string)
Background shown during execution
Changed property slug (string)
Visible in the URL.
Changed response : 201 Created
Changed content type : application/json
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Changed property slug (string)
Visible in the URL.
Changed property background (string)
Background shown during execution
GET /flows/instances/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Flow Serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Changed property slug (string)
Visible in the URL.
Changed property background (string)
Background shown during execution
POST /providers/google_workspace/Changed content type : application/json
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
Changed response : 201 Created
application/json
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
GET /providers/google_workspace/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > GoogleWorkspaceProvider Serializer
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
POST /providers/microsoft_entra/Changed content type : application/json
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
Changed response : 201 Created
application/json
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
GET /providers/microsoft_entra/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > MicrosoftEntraProvider Serializer
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
POST /providers/scim/Changed content type : application/json
Added property service_provider_config_cache_timeout (string)
Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
Changed response : 201 Created
application/json
Added property service_provider_config_cache_timeout (string)
Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
GET /providers/scim/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SCIMProvider Serializer
Added property service_provider_config_cache_timeout (string)
Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
POST /providers/ssf/Changed response : 201 Created
application/json
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /providers/ssf/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SSFProvider Serializer
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
POST /rbac/initial_permissions/Changed content type : application/json
New optional properties:
modemode (object)Changed response : 201 Created
Changed content type : application/json
New optional properties:
modemode (object)GET /rbac/initial_permissions/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > InitialPermissions serializer
New optional properties:
modemode (object)GET /sources/all/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/group_connections/all/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Group Source Connection
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/group_connections/kerberos/Changed response : 201 Created
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/group_connections/kerberos/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Group Source Connection
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/group_connections/ldap/Changed response : 201 Created
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/group_connections/ldap/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Group Source Connection
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/group_connections/oauth/Changed response : 201 Created
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/group_connections/oauth/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Group Source Connection
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/group_connections/plex/Changed response : 201 Created
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/group_connections/plex/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Group Source Connection
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/group_connections/saml/Changed response : 201 Created
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/group_connections/saml/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Group Source Connection
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/group_connections/telegram/Changed response : 201 Created
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/group_connections/telegram/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Group Source Connection
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/kerberos/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 201 Created
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/kerberos/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Kerberos Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/ldap/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 201 Created
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/ldap/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > LDAP Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Added property sync_outgoing_trigger_mode (object)
When to trigger sync for outgoing providers
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/oauth/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property provider_type (string)
Added enum values:
slackwechatChanged response : 201 Created
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
Changed property provider_type (string)
Added enum values:
slackwechatGET /sources/oauth/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > OAuth Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
Changed property provider_type (string)
Added enum values:
slackwechatPOST /sources/plex/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 201 Created
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/plex/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Plex Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/saml/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 201 Created
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/saml/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SAMLSource Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/scim/Changed content type : application/json
slug (string)
Internal source name, used in URLs.
Changed response : 201 Created
application/json
Changed property slug (string)
Internal source name, used in URLs.
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /sources/scim/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SCIMSource Serializer
Changed property slug (string)
Internal source name, used in URLs.
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
POST /sources/telegram/Changed content type : application/json
Added property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed response : 201 Created
Changed content type : application/json
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/telegram/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/user_connections/all/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > User source connection
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/user_connections/kerberos/Changed response : 201 Created
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/user_connections/kerberos/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > User source connection
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/user_connections/ldap/Changed response : 201 Created
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/user_connections/ldap/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > User source connection
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/user_connections/oauth/Changed response : 201 Created
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/user_connections/oauth/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > User source connection
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/user_connections/plex/Changed response : 201 Created
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/user_connections/plex/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > User source connection
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/user_connections/saml/Changed response : 201 Created
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/user_connections/saml/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > User source connection
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
POST /sources/user_connections/telegram/Changed response : 201 Created
application/json
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /sources/user_connections/telegram/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > User source connection
Changed property source_obj (object)
Source Serializer
New required properties:
icon_urlNew optional properties:
iconAdded property promoted (boolean)
When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.
Added property icon_url (string)
Get the URL to the source icon
Changed property slug (string)
Internal source name, used in URLs.
Changed property icon (string)
GET /ssf/streams/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SSFStream Serializer
Changed property provider_obj (object)
SSFProvider Serializer
Changed property token_obj (object)
Token Serializer
Changed property user_obj (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /stages/all/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/duo/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/authenticator/duo/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/authenticator/duo/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/email/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/authenticator/email/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/authenticator/email/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/endpoint_gdtc/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/authenticator/endpoint_gdtc/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/authenticator/endpoint_gdtc/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/sms/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/authenticator/sms/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/authenticator/sms/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/static/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/authenticator/static/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/authenticator/static/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/totp/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/authenticator/totp/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/authenticator/totp/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/validate/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/authenticator/validate/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/authenticator/validate/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/webauthn/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/authenticator/webauthn/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/authenticator/webauthn/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/captcha/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/captcha/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/captcha/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/consent/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/consent/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/consent/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/deny/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/deny/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/deny/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/dummy/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/dummy/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/dummy/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/email/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/email/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/email/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/identification/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setAdded property webauthn_stage (string)
When set, and conditional WebAuthn is available, allow the user to use their passkey as a first factor.
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/identification/{#123;stage_uuid}#125;/Changed content type : application/json
Added property webauthn_stage (string)
When set, and conditional WebAuthn is available, allow the user to use their passkey as a first factor.
Deleted property flow_set (array)
Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setAdded property webauthn_stage (string)
When set, and conditional WebAuthn is available, allow the user to use their passkey as a first factor.
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/identification/{#123;stage_uuid}#125;/Changed content type : application/json
Added property webauthn_stage (string)
When set, and conditional WebAuthn is available, allow the user to use their passkey as a first factor.
Deleted property flow_set (array)
Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setAdded property webauthn_stage (string)
When set, and conditional WebAuthn is available, allow the user to use their passkey as a first factor.
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/invitation/invitations/Changed content type : application/json
name (string)Changed response : 201 Created
application/json
Changed property name (string)
Changed property flow_obj (object)
Flow Serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Changed property slug (string)
Visible in the URL.
Changed property background (string)
Background shown during execution
GET /stages/invitation/invitations/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Invitation Serializer
Changed property name (string)
Changed property flow_obj (object)
Flow Serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Changed property slug (string)
Visible in the URL.
Changed property background (string)
Background shown during execution
GET /stages/invitation/stages/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/invitation/stages/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/invitation/stages/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/mtls/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/mtls/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/mtls/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/password/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/password/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/password/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/prompt/stages/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/prompt/stages/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/prompt/stages/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/redirect/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/redirect/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/redirect/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/source/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/source/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/source/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/user_delete/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/user_delete/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/user_delete/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/user_login/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/user_login/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/user_login/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/user_logout/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/user_logout/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/user_logout/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/user_write/{#123;stage_uuid}#125;/Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/user_write/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/user_write/{#123;stage_uuid}#125;/Changed content type : application/json
flow_set (array)Changed response : 200 OK
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
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
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
Changed property application (object)
Application Serializer
New required properties:
meta_icon_urlNew optional properties:
meta_iconAdded property meta_icon_url (string)
Get the URL to the App Icon image
Changed property slug (string)
Internal application name, used in URLs.
Changed property meta_icon (string)
GET /events/notifications/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Notification Serializer
Added property hyperlink (string)
Added property hyperlink_label (string)
Changed property event (object)
Event Serializer
Changed property action (string)
Added enum value:
export_readyPOST /flows/bindings/Changed response : 201 Created
application/json
Changed property stage_obj (object)
Stage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /flows/bindings/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > FlowStageBinding Serializer
Changed property stage_obj (object)
Stage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /flows/executor/{#123;flow_slug}#125;/Changed response : 200 OK
Changed content type : application/json
Added 'ak-stage-endpoint-agent' component:
Property flow_info (object)
Contextual flow information for a challenge
Property title (string)
Property background (string)
Property cancel_url (string)
Property layout (string)
Enum values:
stackedcontent_leftcontent_rightsidebar_leftsidebar_rightProperty component (string)
Property response_errors (object)
Property challenge (string)
Property challenge_idle_timeout (integer)
Updated ak-stage-identification component:
Added property passkey_challenge (object)
Changed property sources (array)
Changed items (object): > Serializer for Login buttons of sources
promoted (boolean)POST /flows/executor/{#123;flow_slug}#125;/Changed content type : application/json
Added 'ak-stage-endpoint-agent' component:
Property component (string)
Property response (string)
Updated ak-stage-identification component:
New optional properties:
uid_fieldAdded property passkey (object)
Changed property uid_field (string)
Changed response : 200 OK
Changed content type : application/json
Added 'ak-stage-endpoint-agent' component:
Updated ak-stage-identification component:
Added property passkey_challenge (object)
Changed property sources (array)
Changed items (object): > Serializer for Login buttons of sources
promoted (boolean)GET /flows/inspector/{#123;flow_slug}#125;/Changed response : 200 OK
application/json
Changed property plans (array)
Changed items (object): > Serializer for an active FlowPlan
Changed property next_planned_stage (object)
FlowStageBinding Serializer
Changed property stage_obj (object)
Stage Serializer
New required properties:
flow_setflow_set (array)Changed property current_stage (object)
FlowStageBinding Serializer
Changed property stage_obj (object)
Stage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /oauth2/access_tokens/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property user (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /oauth2/authorization_codes/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property user (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /oauth2/refresh_tokens/{#123;id}#125;/Changed response : 200 OK
application/json
Changed property user (object)
User Serializer
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
GET /stages/all/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Stage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/authenticator/duo/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/duo/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorDuoStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/authenticator/email/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/email/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorEmailStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/authenticator/endpoint_gdtc/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/endpoint_gdtc/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorEndpointGDTCStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/authenticator/sms/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/sms/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorSMSStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/authenticator/static/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/static/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorStaticStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/authenticator/totp/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/totp/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorTOTPStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/authenticator/validate/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/validate/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorValidateStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/authenticator/webauthn/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/authenticator/webauthn/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorWebAuthnStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/captcha/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/captcha/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > CaptchaStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/consent/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/consent/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > ConsentStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/deny/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/deny/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > DenyStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/dummy/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/dummy/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > DummyStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/email/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/email/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > EmailStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/identification/Changed content type : application/json
Added property webauthn_stage (string)
When set, and conditional WebAuthn is available, allow the user to use their passkey as a first factor.
Deleted property flow_set (array)
Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setAdded property webauthn_stage (string)
When set, and conditional WebAuthn is available, allow the user to use their passkey as a first factor.
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/identification/Added: webauthn_stage in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > IdentificationStage Serializer
New required properties:
flow_setAdded property webauthn_stage (string)
When set, and conditional WebAuthn is available, allow the user to use their passkey as a first factor.
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/invitation/stages/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/invitation/stages/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > InvitationStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/mtls/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/mtls/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > MutualTLSStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/password/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/password/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > PasswordStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/prompt/prompts/{#123;prompt_uuid}#125;/Changed response : 200 OK
application/json
Changed property prompt_stages_obj (array)
Changed items (object): > PromptStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /stages/prompt/prompts/{#123;prompt_uuid}#125;/Changed response : 200 OK
application/json
Changed property prompt_stages_obj (array)
Changed items (object): > PromptStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PATCH /stages/prompt/prompts/{#123;prompt_uuid}#125;/Changed response : 200 OK
application/json
Changed property prompt_stages_obj (array)
Changed items (object): > PromptStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/prompt/stages/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/prompt/stages/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > PromptStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/redirect/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/redirect/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > RedirectStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/source/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/source/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > SourceStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/user_delete/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/user_delete/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserDeleteStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/user_login/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/user_login/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserLoginStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/user_logout/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/user_logout/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserLogoutStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
POST /stages/user_write/Changed content type : application/json
flow_set (array)Changed response : 201 Created
Changed content type : application/json
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/user_write/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserWriteStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
PUT /core/transactional/applications/Changed content type : application/json
Changed property app (object)
Application Serializer
Added property meta_icon (string)
Changed property slug (string)
Internal application name, used in URLs.
Changed property provider (object)
Updated authentik_providers_microsoft_entra.microsoftentraprovider provider_model:
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
Updated authentik_providers_google_workspace.googleworkspaceprovider provider_model:
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
Updated authentik_providers_scim.scimprovider provider_model:
Added property service_provider_config_cache_timeout (string)
Cache duration for ServiceProviderConfig responses. Set minutes=0 to disable.
Added property sync_page_size (integer)
Controls the number of objects synced in a single task
Added property sync_page_timeout (string)
Timeout for synchronization of a single page
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
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_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
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_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
New required properties:
roles_objAdded property roles (array)
Added property roles_obj (array)
Changed property groups_obj (array)
Changed items (object): > Partial Group Serializer, does not include child relations.
New optional properties:
parent_nameDeleted property parent (string)
Deleted property parent_name (string)
POST /stages/prompt/prompts/Changed response : 201 Created
application/json
Changed property prompt_stages_obj (array)
Changed items (object): > PromptStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
GET /stages/prompt/prompts/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Prompt Serializer
Changed property prompt_stages_obj (array)
Changed items (object): > PromptStage Serializer
New required properties:
flow_setChanged property flow_set (array)
Changed items (object): > Stripped down flow serializer
New required properties:
background_urlNew optional properties:
backgroundAdded property background_url (string)
Get the URL to the background image
Deleted property background (string)
Get the URL to the background image. If the name is /static or starts with http it is returned as-is
Changed property slug (string)
Visible in the URL.
API changes broke backward compatibility