Skip to main content
Pre-Release Documentation
This documentation is for an upcoming version of authentik. It may be incomplete or subject to changes before the final release.

Release 2025.12

info

2025.12 has not been released yet! We're publishing these release notes as a preview of what's to come, and for our awesome beta testers trying out release candidates.

To try out the release candidate, replace your Docker image tag with the latest release candidate number, such as xxxx.x.0-rc1. You can find the latest one in the latest releases on GitHub. If you don't find any, it means we haven't released one yet.

Highlights​

  • Endpoint Devices: Enterprise Endpoint Devices is a new featureset for Windows, macOS, and Linux devices that enables SSH authentication, local device login, sudo authorization and more, all with authentik credentials.
  • CSV Data Exports: Enterprise Now you can export user and event data in CSV format for backup or analysis purposes.
  • RBAC Permissions: Permissions are now granted exclusively via roles, and permission inheritance and basic object permissions have been enhanced.
  • Passkey Autofill (WebAuthn Conditional UI): Passkeys now appear in the browser's autofill dropdown alongside saved passwords, enabling seamless passwordless login when focusing on input fields.

Breaking changes​

RBAC​

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.

Group name uniqueness​

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.

Permission inheritance​

Groups already inherit is_superuser from their ancestor groups. With 2025.12, groups will also inherit all permissions from their ancestor groups.

Group hierarchy​

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).

User permissions​

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.

Storage improvements​

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.

Storage mount changes​

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.

Storage configuration changes​

New storage configuration options are available. See the storage settings reference for details.

New features and improvements​

Endpoint devices​

Endpoint Devices are end-user devices or servers authentication that are registered with authentik. #TODewi

Devices can be integrated by installing the authentik Agent which supports:

Alternatively, Connectors allow authentik to be integrated with third party services like Fleet. This allows for device information to be reported to authentik for Device Compliance purposes.

CSV Data Exports Enterprise​

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.

Passkey Autofill (WebAuthn Conditional UI)​

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.

RBAC Permissions​

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}.

Files​

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.

UI improvements on mobile and tablet devices​

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.

Localization improvements​

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.

Glossary​

We have replaced our too-short Terminology page with a more rich Glossary, with terms that are searchable by tags or first letter.

New integration guides​

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.

Upgrading​

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.

Docker Compose​

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.

Kubernetes​

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

Minor changes/fixes​

  • *: convert slugfields to textfields (#17411)
  • admin/files: add check for /media existence (#18636)
  • admin/files: cache expensive generated URLs (#18784)
  • admin/files: delete applications cache on migration (#18565)
  • api: add decorator to validate serializer in @action endpoints (#17435)
  • api: allow configuring default page_size and max_page_size (#18165)
  • api: fix IPC auth (#18612)
  • api: test action decorator (#18583)
  • blueprints: remove pk from recovery example (#18712)
  • brands: add more matching tests (#16185)
  • brands: sort matched brand by match length (#17920)
  • cmd/server/healthcheck: remove worker HTTP healthcheck (#18090)
  • core, web: unified locales (#18502)
  • core/sessions: remove django groups prefetch (#18704)
  • core: Add example invitation blueprint (#17661)
  • core: add digraph group hierarchy (#17050)
  • core: custom avatar url improvements (#10525)
  • core: deduplicate user attribute constant definitions (#18138)
  • core: improve app launch URL formatting (#18076)
  • core: optimize list applications (#18330)
  • core: propagate ModuleNotFoundError in import_relative (#18683)
  • crypto: only generate managed keypair if non-existent (#18457)
  • crypto: separate permissions for certificate and private keydownload (#18588)
  • crypto: update certificate api and component (#17921)
  • crypto: update certificates on fs event (#18129)
  • endpoints/stage: v2, better error handling, more settings (#18545)
  • endpoints/stage: v2.1, fix asymmetric token exchange and missing form input (#18547)
  • endpoints: AuthN and AuthZ (#18350)
  • endpoints: fix UI bugs, add user binding, etc (#18609)
  • endpoints: fix device access group missing from blueprint (#18703)
  • endpoints: implement endpoint stage (#18468)
  • endpoints: include device ID in agent config (#18414)
  • endpoints: initial data structure + agent (#11499)
  • endpoints: rework perms (#18422)
  • enterprise/endpoints/connectors/agent: fix Apple JWE encryption when FIPS is enabled (#18464)
  • enterprise/providers/scim: fix OAuth (#18358)
  • enterprise/reports: add users and events export (#18088)
  • enterprise/stages/mtls: fix traefik certificate parsing (#18607)
  • enterprise: Apple Platform SSO (#15318)
  • enterprise: add prometheus metrics for license usage and expiry (#17606)
  • enterprise: handle cached naive timezone (#17695)
  • events: fix timezone not set for log events (#18067)
  • files: rework (#17535)
  • flows: keep ?next url when using cancel (#18619)
  • flows: refresh unauthenticated tabs (#18621)
  • flows: remove SESSION_KEY_APPLICATION_PRE (#18388)
  • internal/web/proxy: fix return status code during startup (#17827)
  • internal: Automated internal backport: 1487-invitation-expiry.sec.patch to authentik-2025.10 (#18258)
  • internal: Automated internal backport: 1487-invitation-expiry.sec.patch to authentik-main (#18264)
  • internal: Automated internal backport: 1498-oauth2-cc-user-active.sec.patch to authentik-2025.10 (#18259)
  • internal: Automated internal backport: 1498-oauth2-cc-user-active.sec.patch to authentik-main (#18265)
  • internal: Automated internal backport: 5000-sidebar.sec.patch to authentik-2025.10 (#18260)
  • internal: Automated internal backport: 5000-sidebar.sec.patch to authentik-main (#18266)
  • internal: add default go http server timeouts (#17858)
  • internal: fix go deprecation for +build (#17806)
  • internal: full openssl path (#17856)
  • lib/sync/outgoing: check if there is a provider before creating tasks (#18394)
  • lib/sync/outgoing: store sync settings in database (#17630)
  • lib: add ak_create_jwt_raw (#18676)
  • lib: do not strip and re-add curly braces from raw JSON config (#13769)
  • lifecycle/migrate: remove tenant_files migration (#18729)
  • lifecycle: set search_path in system migrations (#17721)
  • outpost/proxyv2: more tests, fix pg password with spaces, and existing session on restart (#18211)
  • outpost: revert breaking signals change (#17847)
  • outposts: set container healthcheck inline (#18298)
  • outposts: update permissions more eagerly (#17783)
  • packages/django-channels-postgres/layer: fix query when subscribed to multiple channels (#18152)
  • packages/django-channels-postgres: fix notify size check (#18347)
  • packages/django-dramatiq-postgres: broker: ensure locking happens with the same connection (#18095)
  • packages/django-postgres-cache: use upsert instead of select/update in a transaction (#17760)
  • policies: use flow planner directly in PolicyAccessView to directly set flow context (#18372)
  • provider/saml: make signing kp singleton (#17703)
  • providers/oauth2: fix kid always required for federation (#17914)
  • providers/oauth2: move encryption key field (#17722)
  • providers/oauth2: optimize JWKS endpoint queries (#18405)
  • providers/proxy: add gorm logging (#17758)
  • providers/proxy: drop headers with underscores (#17650)
  • providers/proxy: fix missing JWT/claims header (#17759)
  • providers/radius: fix inverted message authenticator validation (#17855)
  • providers/radius: fix panic when no cert is configured (#17762)
  • providers/radius: revert fix inverted message authenticator validation (#17855) (#17915)
  • providers/saml: fix front-end saml binding defaults (#18189)
  • providers/saml: move sp binding location and default value (#17609)
  • providers/scim: allow custom schema data (#18073)
  • providers/scim: cache ServiceProviderConfig (#18047)
  • providers/scim: compare users/groups before sending update request (#18456)
  • providers/scim: fix PATCH for AWS (#18230)
  • root: Add Dockerfile label org.opencontainers.image.source (#17756)
  • root: fix missing authentik_device cookie causing error (#18642)
  • root: skip current tab when refreshing others (#18674)
  • root: use hashes for dockerfile FROM (#17795)
  • sources/ldap: make server info optional (#18648)
  • sources/oauth: Make PKCE verifier 128 characters (#17763)
  • sources/oauth: add WeChat type (#18086)
  • sources/oauth: save returned oauth refresh tokens and add slack provider (#18501)
  • sources/sync: configuration for outgoing sync trigger mode (#17669)
  • sources/telegram: implement connecting existing user to a Telegram account (#18517)
  • stages/captcha: Make stage more managed with provider-specific defaults (#16129)
  • stages/captcha: allow dynamic public/private key (#18346)
  • stages/identification: Add WebAuthn conditional UI (passkey autofill) support (#18377)
  • stages/mtls: always include cert in flow plan (#18657)
  • stages/prompt: fix choices with labels causing error on submit (#18183)
  • stages/prompt: set allow_blank for _read_only fields (#18297)
  • stages/user_write: Fix user attributes are not sanitized under certains conditions (#17890)
  • tasks/schedules: fix rel obj not being associated or updated (#17934)
  • tasks: delay startup signals (#17769)
  • tasks: sanitize log attributes (#17833)
  • tenants: remove extra query for each request (#18705)
  • translate: add cs_CZ (#17632)
  • web/a11y: Isolated Outpost Error Page (#17683)
  • web/a11y: Prefers more field contrast (#17279)
  • web/a11y: Update wizard form labels, placeholders. (#17811)
  • web/a11y: User library -- fix issues surrounding element focus, ARIA labeling. (#17522)
  • web/admin: Add SAML metadata form to wizard (#17690)
  • web/admin: add entitlement search (#18291)
  • web/admin: change s to S in "Stage" (#18632)
  • web/admin: fix brands default switch label (#18518)
  • web/admin: fix event volume chart not updating with query (#18649)
  • web/admin: fix scim provider form (#17831)
  • web/admin: fix scim provider form (cherry-pick #17831 to version-2025.10) (#17834)
  • web/admin: fix typo in PolicyAccessView (#18789)
  • web/admin: fix wording in password stage (#18393)
  • web/admin: fixes capitalization in application wizard title (#17959)
  • web/admin: link to user on invitation list page (#18132)
  • web/admin: link to user on invitation list page (cherry-pick #18132 to version-2025.10) (#18134)
  • web/admin: make empty table message configurable (#18763)
  • web/admin: update stage descriptions (#18118)
  • web/elements: update AppIcon story with files change (#18608)
  • web/flows: improvements for hCaptcha (#16882)
  • web/flows: improvements for hCaptcha (cherry-pick #16882 to version-2025.10) (#18128)
  • web/flows: update default background image (#18540)
  • web/i18n: Clean up locale scripts (#18163)
  • web/i18n: Japanese Locale（日本語ロケール） (#17938)
  • web/i18n: Locale Context Merge Branch (#18426)
  • web/i18n: Locale message fixes (#17913)
  • web/i18n: Remove English Locale (#18164)
  • web/integrations: add information for slo supported integrations (#17836)
  • web/integrations: add slo supported integrations (#17810)
  • web/sfe: downgrade bootstrap that was accidentally upgraded (#18157)
  • web/sfe: downgrade bootstrap that was accidentally upgraded (cherry-pick #18157 to version-2025.10) (#18171)
  • web/sources: Add promoted source (#18334)
  • web: 2025.12 UI tidy (#18650)
  • web: Abstract Wizard Lifecycle (#17658)
  • web: Adjust colors (#18427)
  • web: Codemirror fixes (#18610)
  • web: Consistent Tab Panel URL Parameters (#17804)
  • web: Disable library <datalist> on Firefox. (#18103)
  • web: Fix RAC modal visibility. (#17941)
  • web: Fix application of global styles in style roots. (#17444)
  • web: Fix background refreshing too frequently. (#18764)
  • web: Fix row expansion on modal trigger buttons. (#18412)
  • web: Fix stale table rows (#17940)
  • web: Fix switch labels (#18741)
  • web: Fix tab activation, blank provider URLs (#18031)
  • web: Fix table row click handler. (#17697)
  • web: Hide avatars when set to "none" (#17911)
  • web: Hide device picker when challenges are not present. (#18611)
  • web: Improve user display in modals by falling back to username (#18243)
  • web: Improved Timestamps (#18300)
  • web: Improved table selection behavior (#18622)
  • web: Lit Session Context (#17903)
  • web: Locale selector (#18560)
  • web: Make Spotlight optional. (#17904)
  • web: Make action field search case insensitive in Event Matcher Policy Form (#17680)
  • web: Patternfly 5 Prep: Part 2 (#18085)
  • web: Prettier Config 3.2 (#18305)
  • web: Render Markdown in Blueprints descriptions (#17746)
  • web: Table row refinements (#17659)
  • web: Update Deprecated NPM Packages (#18335)
  • web: re-add en.xlf locale (#18469)
  • web: sync web/package-lock.json (#17611)

API Changes​

authentik (v 2025.12.0-rc1)​

What's New​

GET /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/​

What's Deleted​

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

What's Changed​

GET /admin/settings/​
Return Type:​

Changed response : 200 OK

  • 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_others
      • Added property flows_refresh_others (boolean)
PUT /admin/settings/​
Request:​

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_others
    • Added property flows_refresh_others (boolean)
Return Type:​

Changed response : 200 OK

  • 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_others
      • Added property flows_refresh_others (boolean)
PATCH /admin/settings/​
Request:​

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_others
    • Added property flows_refresh_others (boolean)
Return Type:​

Changed response : 200 OK

  • 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_others
      • Added property flows_refresh_others (boolean)
POST /core/tokens/{#123;identifier}#125;/set_key/​
Request:​

Changed content type : application/json

GET /crypto/certificatekeypairs/{#123;kp_uuid}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • key_type

    New optional properties:

    • private_key_type

    • Added property key_type (object)

      Enum values:

      • rsa
      • ec
      • dsa
      • ed25519
      • ed448

    • Deleted property private_key_type (string)

      Get the private key's type, if set

PUT /crypto/certificatekeypairs/{#123;kp_uuid}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • key_type

    New optional properties:

    • private_key_type

    • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • key_type

    New optional properties:

    • private_key_type

    • Added property key_type (object)

    • Deleted property private_key_type (string)

      Get the private key's type, if set

POST /crypto/certificatekeypairs/generate/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • key_type

    New optional properties:

    • private_key_type

    • Added property key_type (object)

    • Deleted property private_key_type (string)

      Get the private key's type, if set

GET /events/events/actions/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object): > Types of an object that can be created

    • Added property deprecated (boolean)
GET /outposts/service_connections/all/types/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object): > Types of an object that can be created

    • Added property deprecated (boolean)
GET /policies/all/types/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object): > Types of an object that can be created

    • Added property deprecated (boolean)
GET /policies/bindings/{#123;policy_binding_uuid}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property group_obj (object)

      Partial Group Serializer, does not include child relations.

      New optional properties:

      • parent_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

PUT /policies/bindings/{#123;policy_binding_uuid}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property group_obj (object)

      Partial Group Serializer, does not include child relations.

      New optional properties:

      • parent_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

PATCH /policies/bindings/{#123;policy_binding_uuid}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property group_obj (object)

      Partial Group Serializer, does not include child relations.

      New optional properties:

      • parent_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

GET /policies/event_matcher/{#123;policy_uuid}#125;/​
Return Type:​

Changed response : 200 OK

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

    • Changed property app (string)

      Match events created by selected application. When left empty, all applications are matched.

      Added enum values:

      • authentik.endpoints
      • authentik.endpoints.connectors.agent
      • authentik.admin.files
      • authentik.enterprise.endpoints.connectors.agent
      • authentik.enterprise.reports

    • Changed property model (string)

      Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

      Added enum values:

      • authentik_endpoints.deviceuserbinding
      • authentik_endpoints.deviceaccessgroup
      • authentik_endpoints.endpointstage
      • authentik_endpoints_connectors_agent.agentconnector
      • authentik_endpoints_connectors_agent.agentdeviceuserbinding
      • authentik_endpoints_connectors_agent.enrollmenttoken
      • authentik_reports.dataexport
PUT /policies/event_matcher/{#123;policy_uuid}#125;/​
Request:​

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_ready

  • Changed property app (string)

    Match events created by selected application. When left empty, all applications are matched.

    Added enum values:

    • authentik.endpoints
    • authentik.endpoints.connectors.agent
    • authentik.admin.files
    • authentik.enterprise.endpoints.connectors.agent
    • authentik.enterprise.reports

  • Changed property model (string)

    Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

    Added enum values:

    • authentik_endpoints.deviceuserbinding
    • authentik_endpoints.deviceaccessgroup
    • authentik_endpoints.endpointstage
    • authentik_endpoints_connectors_agent.agentconnector
    • authentik_endpoints_connectors_agent.agentdeviceuserbinding
    • authentik_endpoints_connectors_agent.enrollmenttoken
    • authentik_reports.dataexport
Return Type:​

Changed response : 200 OK

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

    • Changed property app (string)

      Match events created by selected application. When left empty, all applications are matched.

      Added enum values:

      • authentik.endpoints
      • authentik.endpoints.connectors.agent
      • authentik.admin.files
      • authentik.enterprise.endpoints.connectors.agent
      • authentik.enterprise.reports

    • Changed property model (string)

      Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

      Added enum values:

      • authentik_endpoints.deviceuserbinding
      • authentik_endpoints.deviceaccessgroup
      • authentik_endpoints.endpointstage
      • authentik_endpoints_connectors_agent.agentconnector
      • authentik_endpoints_connectors_agent.agentdeviceuserbinding
      • authentik_endpoints_connectors_agent.enrollmenttoken
      • authentik_reports.dataexport
PATCH /policies/event_matcher/{#123;policy_uuid}#125;/​
Request:​

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_ready

  • Changed property app (string)

    Match events created by selected application. When left empty, all applications are matched.

    Added enum values:

    • authentik.endpoints
    • authentik.endpoints.connectors.agent
    • authentik.admin.files
    • authentik.enterprise.endpoints.connectors.agent
    • authentik.enterprise.reports

  • Changed property model (string)

    Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

    Added enum values:

    • authentik_endpoints.deviceuserbinding
    • authentik_endpoints.deviceaccessgroup
    • authentik_endpoints.endpointstage
    • authentik_endpoints_connectors_agent.agentconnector
    • authentik_endpoints_connectors_agent.agentdeviceuserbinding
    • authentik_endpoints_connectors_agent.enrollmenttoken
    • authentik_reports.dataexport
Return Type:​

Changed response : 200 OK

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

    • Changed property app (string)

      Match events created by selected application. When left empty, all applications are matched.

      Added enum values:

      • authentik.endpoints
      • authentik.endpoints.connectors.agent
      • authentik.admin.files
      • authentik.enterprise.endpoints.connectors.agent
      • authentik.enterprise.reports

    • Changed property model (string)

      Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

      Added enum values:

      • authentik_endpoints.deviceuserbinding
      • authentik_endpoints.deviceaccessgroup
      • authentik_endpoints.endpointstage
      • authentik_endpoints_connectors_agent.agentconnector
      • authentik_endpoints_connectors_agent.agentdeviceuserbinding
      • authentik_endpoints_connectors_agent.enrollmenttoken
      • authentik_reports.dataexport
GET /propertymappings/all/types/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object): > Types of an object that can be created

    • Added property deprecated (boolean)
GET /providers/all/types/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object): > Types of an object that can be created

    • Added property deprecated (boolean)
GET /providers/google_workspace_groups/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property group_obj (object)

      Partial Group Serializer, does not include child relations.

      New optional properties:

      • parent_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

GET /providers/microsoft_entra_groups/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property group_obj (object)

      Partial Group Serializer, does not include child relations.

      New optional properties:

      • parent_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

POST /providers/saml/import_metadata/​
Return Type:​

New response : 201 Created Deleted response : 204 No Content

Successfully imported provider

GET /providers/scim_groups/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property group_obj (object)

      Partial Group Serializer, does not include child relations.

      New optional properties:

      • parent_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

GET /sources/all/types/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object): > Types of an object that can be created

    • Added property deprecated (boolean)
GET /sources/scim_groups/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property group_obj (object)

      Partial Group Serializer, does not include child relations.

      New optional properties:

      • parent_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

PUT /sources/scim_groups/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property group_obj (object)

      Partial Group Serializer, does not include child relations.

      New optional properties:

      • parent_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

PATCH /sources/scim_groups/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property group_obj (object)

      Partial Group Serializer, does not include child relations.

      New optional properties:

      • parent_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

GET /stages/all/types/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object): > Types of an object that can be created

    • Added property deprecated (boolean)
GET /stages/email/templates/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    Changed items (object): > Types of an object that can be created

    • Added property deprecated (boolean)
GET /authenticators/duo/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /authenticators/email/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /authenticators/endpoint/{#123;uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /authenticators/sms/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /authenticators/static/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /authenticators/totp/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /authenticators/webauthn/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /core/application_entitlements/{#123;pbm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /core/applications/{#123;slug}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • meta_icon_url

    New optional properties:

    • meta_icon

    • Added 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;/​
Request:​

Changed content type : application/json

  • Added property meta_icon (string)

  • Changed property slug (string)

    Internal application name, used in URLs.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • meta_icon_url

    New optional properties:

    • meta_icon

    • Added 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;/​
Request:​

Changed content type : application/json

  • Added property meta_icon (string)

  • Changed property slug (string)

    Internal application name, used in URLs.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • meta_icon_url

    New optional properties:

    • meta_icon

    • Added 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/​
Return Type:​

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_dangling
GET /core/authenticated_sessions/{#123;uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /core/brands/{#123;brand_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /core/brands/current/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property flags (object)

      New required properties:

      • flows_refresh_others
      • Added property flows_refresh_others (boolean)
GET /core/groups/{#123;group_uuid}#125;/​
Parameters:​

Added: include_parents in query

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • children
    • parents_obj

    New optional properties:

    • parent_name

    • Added 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;/​
Request:​

Changed content type : application/json

  • Added property parents (array)

  • Deleted property parent (string)

  • Deleted property children (array)

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • children
    • parents_obj

    New optional properties:

    • parent_name

    • Added 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;/​
Request:​

Changed content type : application/json

  • Added property parents (array)

  • Deleted property parent (string)

  • Deleted property children (array)

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • children
    • parents_obj

    New optional properties:

    • parent_name

    • Added 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/​
Return Type:​

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_dangling
GET /core/tokens/{#123;identifier}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property user_obj (object)

      User Serializer

      New required properties:

      • roles_obj

      • Added 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_name

        • Deleted property parent (string)

        • Deleted property parent_name (string)

PUT /core/tokens/{#123;identifier}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property user_obj (object)

      User Serializer

      New required properties:

      • roles_obj

      • Added 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_name

        • Deleted property parent (string)

        • Deleted property parent_name (string)

PATCH /core/tokens/{#123;identifier}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property user_obj (object)

      User Serializer

      New required properties:

      • roles_obj

      • Added 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_name

        • Deleted property parent (string)

        • Deleted property parent_name (string)

GET /core/tokens/{#123;identifier}#125;/used_by/​
Return Type:​

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_dangling
GET /core/user_consent/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /core/users/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • roles_obj

    • Added 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_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

PUT /core/users/{#123;id}#125;/​
Request:​

Changed content type : application/json

  • Added property roles (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • roles_obj

    • Added 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_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

PATCH /core/users/{#123;id}#125;/​
Request:​

Changed content type : application/json

  • Added property roles (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • roles_obj

    • Added 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_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

GET /core/users/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
POST /crypto/certificatekeypairs/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • key_type

    New optional properties:

    • private_key_type

    • Added property key_type (object)

    • Deleted property private_key_type (string)

      Get the private key's type, if set

GET /crypto/certificatekeypairs/​
Parameters:​

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')

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > CertificateKeyPair Serializer

      New required properties:

      • key_type

      New optional properties:

      • private_key_type

      • Added 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/​
Return Type:​

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_dangling
GET /enterprise/license/{#123;license_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /events/events/{#123;event_uuid}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property action (string)

      Added enum value:

      • export_ready
PUT /events/events/{#123;event_uuid}#125;/​
Request:​

Changed content type : application/json

  • Changed property action (string)

    Added enum value:

    • export_ready
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property action (string)

      Added enum value:

      • export_ready
PATCH /events/events/{#123;event_uuid}#125;/​
Request:​

Changed content type : application/json

  • Changed property action (string)

    Added enum value:

    • export_ready
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property action (string)

      Added enum value:

      • export_ready
GET /events/events/volume/​
Parameters:​

Changed: actions in query

Return Type:​

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_ready
GET /events/notifications/{#123;uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /events/rules/{#123;pbm_uuid}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property destination_group_obj (object)

      Group Serializer

      New required properties:

      • children
      • parents_obj

      New optional properties:

      • parent_name

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property destination_group_obj (object)

      Group Serializer

      New required properties:

      • children
      • parents_obj

      New optional properties:

      • parent_name

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property destination_group_obj (object)

      Group Serializer

      New required properties:

      • children
      • parents_obj

      New optional properties:

      • parent_name

      • Added 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/​
Return Type:​

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_dangling
GET /events/transports/{#123;uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /flows/bindings/{#123;fsb_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /flows/instances/{#123;slug}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • background_url

    New optional properties:

    • background

    • Added 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;/​
Request:​

Changed content type : application/json

  • Added property background (string)

    Background shown during execution

  • Changed property slug (string)

    Visible in the URL.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • background_url

    New optional properties:

    • background

    • Added 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;/​
Request:​

Changed content type : application/json

  • Added property background (string)

    Background shown during execution

  • Changed property slug (string)

    Visible in the URL.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • background_url

    New optional properties:

    • background

    • Added 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/​
Return Type:​

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_dangling
GET /managed/blueprints/{#123;instance_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /oauth2/access_tokens/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /oauth2/authorization_codes/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /oauth2/refresh_tokens/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /outposts/instances/{#123;uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /outposts/service_connections/all/{#123;uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /outposts/service_connections/docker/{#123;uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /outposts/service_connections/kubernetes/{#123;uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /policies/all/{#123;policy_uuid}#125;/used_by/​
Return Type:​

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_dangling
POST /policies/bindings/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property group_obj (object)

      Partial Group Serializer, does not include child relations.

      New optional properties:

      • parent_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

GET /policies/bindings/​
Return Type:​

Changed response : 200 OK

  • Changed content type : 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_name

        • Deleted property parent (string)

        • Deleted property parent_name (string)

GET /policies/bindings/{#123;policy_binding_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /policies/dummy/{#123;policy_uuid}#125;/used_by/​
Return Type:​

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_dangling
POST /policies/event_matcher/​
Request:​

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_ready

  • Changed property app (string)

    Match events created by selected application. When left empty, all applications are matched.

    Added enum values:

    • authentik.endpoints
    • authentik.endpoints.connectors.agent
    • authentik.admin.files
    • authentik.enterprise.endpoints.connectors.agent
    • authentik.enterprise.reports

  • Changed property model (string)

    Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

    Added enum values:

    • authentik_endpoints.deviceuserbinding
    • authentik_endpoints.deviceaccessgroup
    • authentik_endpoints.endpointstage
    • authentik_endpoints_connectors_agent.agentconnector
    • authentik_endpoints_connectors_agent.agentdeviceuserbinding
    • authentik_endpoints_connectors_agent.enrollmenttoken
    • authentik_reports.dataexport
Return Type:​

Changed response : 201 Created

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

    • Changed property app (string)

      Match events created by selected application. When left empty, all applications are matched.

      Added enum values:

      • authentik.endpoints
      • authentik.endpoints.connectors.agent
      • authentik.admin.files
      • authentik.enterprise.endpoints.connectors.agent
      • authentik.enterprise.reports

    • Changed property model (string)

      Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

      Added enum values:

      • authentik_endpoints.deviceuserbinding
      • authentik_endpoints.deviceaccessgroup
      • authentik_endpoints.endpointstage
      • authentik_endpoints_connectors_agent.agentconnector
      • authentik_endpoints_connectors_agent.agentdeviceuserbinding
      • authentik_endpoints_connectors_agent.enrollmenttoken
      • authentik_reports.dataexport
GET /policies/event_matcher/​
Parameters:​

Changed: action in query

Match created events with this action type. When left empty, all action types will be matched.

Return Type:​

Changed response : 200 OK

  • Changed content type : 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_ready

      • Changed property app (string)

        Match events created by selected application. When left empty, all applications are matched.

        Added enum values:

        • authentik.endpoints
        • authentik.endpoints.connectors.agent
        • authentik.admin.files
        • authentik.enterprise.endpoints.connectors.agent
        • authentik.enterprise.reports

      • Changed property model (string)

        Match events created by selected model. When left empty, all models are matched. When an app is selected, all the application's models are matched.

        Added enum values:

        • authentik_endpoints.deviceuserbinding
        • authentik_endpoints.deviceaccessgroup
        • authentik_endpoints.endpointstage
        • authentik_endpoints_connectors_agent.agentconnector
        • authentik_endpoints_connectors_agent.agentdeviceuserbinding
        • authentik_endpoints_connectors_agent.enrollmenttoken
        • authentik_reports.dataexport
GET /policies/event_matcher/{#123;policy_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /policies/expression/{#123;policy_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /policies/geoip/{#123;policy_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /policies/password/{#123;policy_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /policies/password_expiry/{#123;policy_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /policies/reputation/{#123;policy_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /policies/reputation/scores/{#123;reputation_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /policies/unique_password/{#123;policy_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/all/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/notification/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/provider/google_workspace/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/provider/microsoft_entra/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/provider/rac/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/provider/radius/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/provider/saml/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/provider/scim/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/provider/scope/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/source/kerberos/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/source/ldap/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/source/oauth/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/source/plex/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/source/saml/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/source/scim/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /propertymappings/source/telegram/{#123;pm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /providers/all/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /providers/google_workspace/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • 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

PUT /providers/google_workspace/{#123;id}#125;/​
Request:​

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

Return Type:​

Changed response : 200 OK

  • 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

PATCH /providers/google_workspace/{#123;id}#125;/​
Request:​

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

Return Type:​

Changed response : 200 OK

  • 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

GET /providers/google_workspace/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
POST /providers/google_workspace_groups/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property group_obj (object)

      Partial Group Serializer, does not include child relations.

      New optional properties:

      • parent_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

GET /providers/google_workspace_groups/​
Return Type:​

Changed response : 200 OK

  • Changed content type : 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_name

        • Deleted property parent (string)

        • Deleted property parent_name (string)

GET /providers/google_workspace_groups/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /providers/google_workspace_users/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /providers/ldap/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /providers/microsoft_entra/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • 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

PUT /providers/microsoft_entra/{#123;id}#125;/​
Request:​

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

Return Type:​

Changed response : 200 OK

  • 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

PATCH /providers/microsoft_entra/{#123;id}#125;/​
Request:​

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

Return Type:​

Changed response : 200 OK

  • 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

GET /providers/microsoft_entra/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
POST /providers/microsoft_entra_groups/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property group_obj (object)

      Partial Group Serializer, does not include child relations.

      New optional properties:

      • parent_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

GET /providers/microsoft_entra_groups/​
Return Type:​

Changed response : 200 OK

  • Changed content type : 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_name

        • Deleted property parent (string)

        • Deleted property parent_name (string)

GET /providers/microsoft_entra_groups/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /providers/microsoft_entra_users/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /providers/oauth2/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /providers/proxy/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /providers/rac/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /providers/radius/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /providers/saml/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /providers/scim/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • 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

PUT /providers/scim/{#123;id}#125;/​
Request:​

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

Return Type:​

Changed response : 200 OK

  • 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

PATCH /providers/scim/{#123;id}#125;/​
Request:​

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

Return Type:​

Changed response : 200 OK

  • 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

GET /providers/scim/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
POST /providers/scim_groups/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property group_obj (object)

      Partial Group Serializer, does not include child relations.

      New optional properties:

      • parent_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

GET /providers/scim_groups/​
Return Type:​

Changed response : 200 OK

  • Changed content type : 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_name

        • Deleted property parent (string)

        • Deleted property parent_name (string)

GET /providers/scim_groups/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /providers/scim_users/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /providers/ssf/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property token_obj (object)

      Token Serializer

      • Changed property user_obj (object)

        User Serializer

        New required properties:

        • roles_obj

        • Added 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_name

          • Deleted property parent (string)

          • Deleted property parent_name (string)

PUT /providers/ssf/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property token_obj (object)

      Token Serializer

      • Changed property user_obj (object)

        User Serializer

        New required properties:

        • roles_obj

        • Added 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_name

          • Deleted property parent (string)

          • Deleted property parent_name (string)

PATCH /providers/ssf/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property token_obj (object)

      Token Serializer

      • Changed property user_obj (object)

        User Serializer

        New required properties:

        • roles_obj

        • Added 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_name

          • Deleted property parent (string)

          • Deleted property parent_name (string)

GET /providers/ssf/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /rac/connection_tokens/{#123;connection_token_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /rac/endpoints/{#123;pbm_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /rbac/initial_permissions/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New optional properties:

    • mode
    • Deleted property mode (object)
PUT /rbac/initial_permissions/{#123;id}#125;/​
Request:​

Changed content type : application/json

New optional properties:

  • mode
  • Deleted property mode (object)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New optional properties:

    • mode
    • Deleted property mode (object)
PATCH /rbac/initial_permissions/{#123;id}#125;/​
Request:​

Changed content type : application/json

  • Deleted property mode (object)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New optional properties:

    • mode
    • Deleted property mode (object)
GET /rbac/initial_permissions/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /rbac/permissions/assigned_by_roles/​
Parameters:​

Changed: model in query

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Roles assigned object permission serializer

      New required properties:

      • model_permissions
      • object_permissions

      New optional properties:

      • permissions

      • Added 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/​
Request:​

Changed content type : application/json

  • Changed property model (string)

    Added enum values:

    • authentik_endpoints.deviceuserbinding
    • authentik_endpoints.deviceaccessgroup
    • authentik_endpoints.endpointstage
    • authentik_endpoints_connectors_agent.agentconnector
    • authentik_endpoints_connectors_agent.agentdeviceuserbinding
    • authentik_endpoints_connectors_agent.enrollmenttoken
    • authentik_reports.dataexport
PATCH /rbac/permissions/assigned_by_roles/{#123;uuid}#125;/unassign/​
Request:​

Changed content type : application/json

  • Changed property model (string)

    Added enum values:

    • authentik_endpoints.deviceuserbinding
    • authentik_endpoints.deviceaccessgroup
    • authentik_endpoints.endpointstage
    • authentik_endpoints_connectors_agent.agentconnector
    • authentik_endpoints_connectors_agent.agentdeviceuserbinding
    • authentik_endpoints_connectors_agent.enrollmenttoken
    • authentik_reports.dataexport
GET /rbac/permissions/roles/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Role permission with additional object-related data

      • Changed property 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/​
Parameters:​

Added: managed in query

Added: managed__isnull in query

Added: users in query

GET /rbac/roles/{#123;uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /sources/all/{#123;slug}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_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/​
Return Type:​

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_dangling
GET /sources/group_connections/all/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

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_dangling
GET /sources/group_connections/kerberos/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

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_dangling
GET /sources/group_connections/ldap/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

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_dangling
GET /sources/group_connections/oauth/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

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_dangling
GET /sources/group_connections/plex/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

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_dangling
GET /sources/group_connections/saml/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

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_dangling
GET /sources/group_connections/telegram/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

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_dangling
GET /sources/kerberos/{#123;slug}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Added property sync_outgoing_trigger_mode (object)

      When to trigger sync for outgoing providers

      Enum values:

      • none
      • immediate
      • deferred_end

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

PUT /sources/kerberos/{#123;slug}#125;/​
Request:​

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.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_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;/​
Request:​

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.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_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/​
Return Type:​

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_dangling
GET /sources/ldap/{#123;slug}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_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;/​
Request:​

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.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_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;/​
Request:​

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.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_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/​
Return Type:​

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_dangling
GET /sources/oauth/{#123;slug}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

    • Changed property provider_type (string)

      Added enum values:

      • slack
      • wechat
PUT /sources/oauth/{#123;slug}#125;/​
Request:​

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:

    • slack
    • wechat
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

    • Changed property provider_type (string)

      Added enum values:

      • slack
      • wechat
PATCH /sources/oauth/{#123;slug}#125;/​
Request:​

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:

    • slack
    • wechat
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

    • Changed property provider_type (string)

      Added enum values:

      • slack
      • wechat
GET /sources/oauth/{#123;slug}#125;/used_by/​
Return Type:​

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_dangling
GET /sources/plex/{#123;slug}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

PUT /sources/plex/{#123;slug}#125;/​
Request:​

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.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

PATCH /sources/plex/{#123;slug}#125;/​
Request:​

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.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

GET /sources/plex/{#123;slug}#125;/used_by/​
Return Type:​

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_dangling
GET /sources/saml/{#123;slug}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

PUT /sources/saml/{#123;slug}#125;/​
Request:​

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.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

PATCH /sources/saml/{#123;slug}#125;/​
Request:​

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.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

GET /sources/saml/{#123;slug}#125;/used_by/​
Return Type:​

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_dangling
GET /sources/scim/{#123;slug}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : 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_obj

        • Added 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_name

          • Deleted property parent (string)

          • Deleted property parent_name (string)

PUT /sources/scim/{#123;slug}#125;/​
Request:​

Changed content type : application/json

  • Changed property slug (string)

    Internal source name, used in URLs.

Return Type:​

Changed response : 200 OK

  • Changed content type : 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_obj

        • Added 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_name

          • Deleted property parent (string)

          • Deleted property parent_name (string)

PATCH /sources/scim/{#123;slug}#125;/​
Request:​

Changed content type : application/json

  • Changed property slug (string)

    Internal source name, used in URLs.

Return Type:​

Changed response : 200 OK

  • Changed content type : 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_obj

        • Added 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_name

          • Deleted property parent (string)

          • Deleted property parent_name (string)

GET /sources/scim/{#123;slug}#125;/used_by/​
Return Type:​

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_dangling
POST /sources/scim_groups/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property group_obj (object)

      Partial Group Serializer, does not include child relations.

      New optional properties:

      • parent_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

GET /sources/scim_groups/​
Return Type:​

Changed response : 200 OK

  • Changed content type : 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_name

        • Deleted property parent (string)

        • Deleted property parent_name (string)

GET /sources/scim_groups/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /sources/scim_users/{#123;id}#125;/used_by/​
Return Type:​

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_dangling
GET /sources/telegram/{#123;slug}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

PUT /sources/telegram/{#123;slug}#125;/​
Request:​

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.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

PATCH /sources/telegram/{#123;slug}#125;/​
Request:​

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.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

GET /sources/telegram/{#123;slug}#125;/used_by/​
Return Type:​

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_dangling
GET /sources/user_connections/all/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

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_dangling
GET /sources/user_connections/kerberos/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

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_dangling
GET /sources/user_connections/ldap/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

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_dangling
GET /sources/user_connections/oauth/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

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_dangling
GET /sources/user_connections/plex/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

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_dangling
GET /sources/user_connections/saml/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

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_dangling
GET /sources/user_connections/telegram/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

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_dangling
GET /ssf/streams/{#123;uuid}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : 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_obj

          • Added 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_name

            • Deleted property parent (string)

            • Deleted property parent_name (string)

GET /stages/all/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/authenticator/duo/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/authenticator/email/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/authenticator/endpoint_gdtc/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/authenticator/sms/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/authenticator/static/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/authenticator/totp/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/authenticator/validate/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/authenticator/webauthn/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/captcha/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/consent/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/deny/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/dummy/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/email/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/identification/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/invitation/invitations/{#123;invite_uuid}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property name (string)

    • Changed property flow_obj (object)

      Flow Serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Changed property name (string)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property name (string)

    • Changed property flow_obj (object)

      Flow Serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Changed property name (string)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property name (string)

    • Changed property flow_obj (object)

      Flow Serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

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_dangling
GET /stages/invitation/stages/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/mtls/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/password/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/prompt/prompts/{#123;prompt_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/prompt/stages/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/redirect/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/source/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/user_delete/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/user_login/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/user_logout/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
GET /stages/user_write/{#123;stage_uuid}#125;/used_by/​
Return Type:​

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_dangling
POST /core/applications/​
Request:​

Changed content type : application/json

  • Added property meta_icon (string)

  • Changed property slug (string)

    Internal application name, used in URLs.

Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • meta_icon_url

    New optional properties:

    • meta_icon

    • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Application Serializer

      New required properties:

      • meta_icon_url

      New optional properties:

      • meta_icon

      • Added 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/​
Request:​

Changed content type : application/json

  • Added property parents (array)

  • Deleted property parent (string)

  • Deleted property children (array)

Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • children
    • parents_obj

    New optional properties:

    • parent_name

    • Added 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/​
Parameters:​

Added: include_parents in query

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Group Serializer

      New required properties:

      • children
      • parents_obj

      New optional properties:

      • parent_name

      • Added 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/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property user_obj (object)

      User Serializer

      New required properties:

      • roles_obj

      • Added 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_name

        • Deleted property parent (string)

        • Deleted property parent_name (string)

GET /core/tokens/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Token Serializer

      • Changed property user_obj (object)

        User Serializer

        New required properties:

        • roles_obj

        • Added 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_name

          • Deleted property parent (string)

          • Deleted property parent_name (string)

GET /core/user_consent/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property user (object)

      User Serializer

      New required properties:

      • roles_obj

      • Added 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_name

        • Deleted property parent (string)

        • Deleted property parent_name (string)

    • Changed property application (object)

      Application Serializer

      New required properties:

      • meta_icon_url

      New optional properties:

      • meta_icon

      • Added 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/​
Request:​

Changed content type : application/json

  • Added property roles (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • roles_obj

    • Added 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_name

      • Deleted property parent (string)

      • Deleted property parent_name (string)

GET /core/users/​
Parameters:​

Added: include_roles in query

Added: roles_by_name in query

Added: roles_by_pk in query

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > User Serializer

      New required properties:

      • roles_obj

      • Added 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_name

        • Deleted property parent (string)

        • Deleted property parent_name (string)

GET /core/users/me/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property user (object)

      User Serializer for information a user can retrieve about themselves

      New required properties:

      • roles

      • Added property roles (array)

        Items (object):

        • Property name (string)

        • Property pk (string)

POST /events/events/​
Request:​

Changed content type : application/json

  • Changed property action (string)

    Added enum value:

    • export_ready
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property action (string)

      Added enum value:

      • export_ready
GET /events/events/​
Parameters:​

Changed: actions in query

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Event Serializer

      • Changed property action (string)

        Added enum value:

        • export_ready
GET /events/notifications/{#123;uuid}#125;/​
Return Type:​

Changed response : 200 OK

  • 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_ready
PUT /events/notifications/{#123;uuid}#125;/​
Request:​

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_ready
Return Type:​

Changed response : 200 OK

  • 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_ready
PATCH /events/notifications/{#123;uuid}#125;/​
Request:​

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_ready
Return Type:​

Changed response : 200 OK

  • 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_ready
POST /events/rules/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property destination_group_obj (object)

      Group Serializer

      New required properties:

      • children
      • parents_obj

      New optional properties:

      • parent_name

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > NotificationRule Serializer

      • Changed property destination_group_obj (object)

        Group Serializer

        New required properties:

        • children
        • parents_obj

        New optional properties:

        • parent_name

        • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property stage_obj (object)

      Stage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property stage_obj (object)

      Stage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property stage_obj (object)

      Stage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Added property background (string)

    Background shown during execution

  • Changed property slug (string)

    Visible in the URL.

Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • background_url

    New optional properties:

    • background

    • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Flow Serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Request:​

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

Return Type:​

Changed response : 201 Created

  • 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

GET /providers/google_workspace/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > GoogleWorkspaceProvider Serializer

      • Added property 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/​
Request:​

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

Return Type:​

Changed response : 201 Created

  • 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

GET /providers/microsoft_entra/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > MicrosoftEntraProvider Serializer

      • Added property 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/​
Request:​

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

Return Type:​

Changed response : 201 Created

  • 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

GET /providers/scim/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > SCIMProvider Serializer

      • Added property 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/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property token_obj (object)

      Token Serializer

      • Changed property user_obj (object)

        User Serializer

        New required properties:

        • roles_obj

        • Added 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_name

          • Deleted property parent (string)

          • Deleted property parent_name (string)

GET /providers/ssf/​
Return Type:​

Changed response : 200 OK

  • Changed content type : 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_obj

          • Added 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_name

            • Deleted property parent (string)

            • Deleted property parent_name (string)

POST /rbac/initial_permissions/​
Request:​

Changed content type : application/json

New optional properties:

  • mode
  • Deleted property mode (object)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New optional properties:

    • mode
    • Deleted property mode (object)
GET /rbac/initial_permissions/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > InitialPermissions serializer

      New optional properties:

      • mode
      • Deleted property mode (object)
GET /sources/all/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Group Source Connection

      • Changed property source_obj (object)

        Source Serializer

        New required properties:

        • icon_url

        New optional properties:

        • icon

        • 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_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/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Group Source Connection

      • Changed property source_obj (object)

        Source Serializer

        New required properties:

        • icon_url

        New optional properties:

        • icon

        • 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_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/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Group Source Connection

      • Changed property source_obj (object)

        Source Serializer

        New required properties:

        • icon_url

        New optional properties:

        • icon

        • 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_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/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Group Source Connection

      • Changed property source_obj (object)

        Source Serializer

        New required properties:

        • icon_url

        New optional properties:

        • icon

        • 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_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/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Group Source Connection

      • Changed property source_obj (object)

        Source Serializer

        New required properties:

        • icon_url

        New optional properties:

        • icon

        • 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_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/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Group Source Connection

      • Changed property source_obj (object)

        Source Serializer

        New required properties:

        • icon_url

        New optional properties:

        • icon

        • 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_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/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Group Source Connection

      • Changed property source_obj (object)

        Source Serializer

        New required properties:

        • icon_url

        New optional properties:

        • icon

        • 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_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/​
Request:​

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.

Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Kerberos Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Request:​

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.

Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > LDAP Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Request:​

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:

    • slack
    • wechat
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

    • Changed property provider_type (string)

      Added enum values:

      • slack
      • wechat
GET /sources/oauth/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > OAuth Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_url (string)

      • Changed property slug (string)

        Internal source name, used in URLs.

      • Changed property icon (string)

      • Changed property provider_type (string)

        Added enum values:

        • slack
        • wechat
POST /sources/plex/​
Request:​

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.

Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

GET /sources/plex/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Plex Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_url (string)

      • Changed property slug (string)

        Internal source name, used in URLs.

      • Changed property icon (string)

POST /sources/saml/​
Request:​

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.

Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

GET /sources/saml/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > SAMLSource Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_url (string)

      • Changed property slug (string)

        Internal source name, used in URLs.

      • Changed property icon (string)

POST /sources/scim/​
Request:​

Changed content type : application/json

  • Changed property slug (string)

    Internal source name, used in URLs.

Return Type:​

Changed response : 201 Created

  • Changed content type : 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_obj

        • Added 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_name

          • Deleted property parent (string)

          • Deleted property parent_name (string)

GET /sources/scim/​
Return Type:​

Changed response : 200 OK

  • Changed content type : 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_obj

          • Added 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_name

            • Deleted property parent (string)

            • Deleted property parent_name (string)

POST /sources/telegram/​
Request:​

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.

Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • icon_url

    New optional properties:

    • icon

    • 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_url (string)

    • Changed property slug (string)

      Internal source name, used in URLs.

    • Changed property icon (string)

GET /sources/telegram/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_url (string)

      • Changed property slug (string)

        Internal source name, used in URLs.

      • Changed property icon (string)

GET /sources/user_connections/all/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > User source connection

      • Changed property source_obj (object)

        Source Serializer

        New required properties:

        • icon_url

        New optional properties:

        • icon

        • 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_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/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > User source connection

      • Changed property source_obj (object)

        Source Serializer

        New required properties:

        • icon_url

        New optional properties:

        • icon

        • 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_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/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > User source connection

      • Changed property source_obj (object)

        Source Serializer

        New required properties:

        • icon_url

        New optional properties:

        • icon

        • 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_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/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > User source connection

      • Changed property source_obj (object)

        Source Serializer

        New required properties:

        • icon_url

        New optional properties:

        • icon

        • 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_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/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > User source connection

      • Changed property source_obj (object)

        Source Serializer

        New required properties:

        • icon_url

        New optional properties:

        • icon

        • 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_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/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > User source connection

      • Changed property source_obj (object)

        Source Serializer

        New required properties:

        • icon_url

        New optional properties:

        • icon

        • 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_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/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property source_obj (object)

      Source Serializer

      New required properties:

      • icon_url

      New optional properties:

      • icon

      • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > User source connection

      • Changed property source_obj (object)

        Source Serializer

        New required properties:

        • icon_url

        New optional properties:

        • icon

        • 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_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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : 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_obj

            • Added 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_name

              • Deleted property parent (string)

              • Deleted property parent_name (string)

GET /stages/all/{#123;stage_uuid}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Added 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_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

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)

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Added 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_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

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)

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Added 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_url

      New optional properties:

      • background

      • Added 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/​
Request:​

Changed content type : application/json

  • Changed property name (string)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property name (string)

    • Changed property flow_obj (object)

      Flow Serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : 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_url

        New optional properties:

        • background

        • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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;/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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.

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > UserConsent Serializer

      • Changed property user (object)

        User Serializer

        New required properties:

        • roles_obj

        • Added 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_name

          • Deleted property parent (string)

          • Deleted property parent_name (string)

      • Changed property application (object)

        Application Serializer

        New required properties:

        • meta_icon_url

        New optional properties:

        • meta_icon

        • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : 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_ready
POST /flows/bindings/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property stage_obj (object)

      Stage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > FlowStageBinding Serializer

      • Changed property stage_obj (object)

        Stage Serializer

        New required properties:

        • flow_set

        • Changed property flow_set (array)

          Changed items (object): > Stripped down flow serializer

          New required properties:

          • background_url

          New optional properties:

          • background

          • Added 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;/​
Return Type:​

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:

        • stacked
        • content_left
        • content_right
        • sidebar_left
        • sidebar_right

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

      • Added property promoted (boolean)
POST /flows/executor/{#123;flow_slug}#125;/​
Request:​

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_field

  • Added property passkey (object)

  • Changed property uid_field (string)

Return Type:​

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

      • Added property promoted (boolean)
GET /flows/inspector/{#123;flow_slug}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property plans (array)

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

      • Changed property next_planned_stage (object)

        FlowStageBinding Serializer

        • Changed property stage_obj (object)

          Stage Serializer

          New required properties:

          • flow_set
          • Changed property flow_set (array)

      • Changed property current_stage (object)

        FlowStageBinding Serializer

        • Changed property stage_obj (object)

          Stage Serializer

          New required properties:

          • flow_set

          • Changed property flow_set (array)

            Changed items (object): > Stripped down flow serializer

            New required properties:

            • background_url

            New optional properties:

            • background

            • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property user (object)

      User Serializer

      New required properties:

      • roles_obj

      • Added 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_name

        • Deleted property parent (string)

        • Deleted property parent_name (string)

GET /oauth2/authorization_codes/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property user (object)

      User Serializer

      New required properties:

      • roles_obj

      • Added 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_name

        • Deleted property parent (string)

        • Deleted property parent_name (string)

GET /oauth2/refresh_tokens/{#123;id}#125;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property user (object)

      User Serializer

      New required properties:

      • roles_obj

      • Added 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_name

        • Deleted property parent (string)

        • Deleted property parent_name (string)

GET /stages/all/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Stage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > AuthenticatorDuoStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > AuthenticatorEmailStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > AuthenticatorEndpointGDTCStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > AuthenticatorSMSStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > AuthenticatorStaticStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > AuthenticatorTOTPStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > AuthenticatorValidateStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > AuthenticatorWebAuthnStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > CaptchaStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > ConsentStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > DenyStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > DummyStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > EmailStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

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)

Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Added 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_url

      New optional properties:

      • background

      • Added 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/​
Parameters:​

Added: webauthn_stage in query

Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > IdentificationStage Serializer

      New required properties:

      • flow_set

      • Added 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_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > InvitationStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > MutualTLSStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > PasswordStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property prompt_stages_obj (array)

      Changed items (object): > PromptStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property prompt_stages_obj (array)

      Changed items (object): > PromptStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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;/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property prompt_stages_obj (array)

      Changed items (object): > PromptStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > PromptStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > RedirectStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > SourceStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > UserDeleteStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > UserLoginStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > UserLogoutStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

Changed content type : application/json

  • Deleted property flow_set (array)
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    New required properties:

    • flow_set

    • Changed property flow_set (array)

      Changed items (object): > Stripped down flow serializer

      New required properties:

      • background_url

      New optional properties:

      • background

      • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > UserWriteStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Request:​

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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Serializer for BaseGrantModel and RefreshToken

      • Changed property user (object)

        User Serializer

        New required properties:

        • roles_obj

        • Added 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_name

          • Deleted property parent (string)

          • Deleted property parent_name (string)

GET /oauth2/authorization_codes/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Serializer for BaseGrantModel and ExpiringBaseGrant

      • Changed property user (object)

        User Serializer

        New required properties:

        • roles_obj

        • Added 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_name

          • Deleted property parent (string)

          • Deleted property parent_name (string)

GET /oauth2/refresh_tokens/​
Return Type:​

Changed response : 200 OK

  • Changed content type : application/json

    • Changed property results (array)

      Changed items (object): > Serializer for BaseGrantModel and RefreshToken

      • Changed property user (object)

        User Serializer

        New required properties:

        • roles_obj

        • Added 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_name

          • Deleted property parent (string)

          • Deleted property parent_name (string)

POST /stages/prompt/prompts/​
Return Type:​

Changed response : 201 Created

  • Changed content type : application/json

    • Changed property prompt_stages_obj (array)

      Changed items (object): > PromptStage Serializer

      New required properties:

      • flow_set

      • Changed property flow_set (array)

        Changed items (object): > Stripped down flow serializer

        New required properties:

        • background_url

        New optional properties:

        • background

        • Added 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/​
Return Type:​

Changed response : 200 OK

  • Changed content type : 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_set

        • Changed property flow_set (array)

          Changed items (object): > Stripped down flow serializer

          New required properties:

          • background_url

          New optional properties:

          • background

          • Added 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.

Result​

API changes broke backward compatibility