website/docs/releases/2022/v2022.10.md
Support for OAuth2 Device flow
See more in the OAuth2 provider docs here. This flow allows users to authenticate on devices that have limited input possibilities and or no browser access.
Customizable payload for SMS Authenticator stage when using Generic provider.
Revamped SAML Source
The SAML source uses connection objects and the same Flow manager as the OAuth and Plex source. Additionally error-handling has been improved.
This also allows for mapping fields from SAML Source to users.
Twitch OAuth Source has been added
Optimized loading speed of Flows & Stages
This affects listing Flows & Stages in the admin interface, as well as loading prompts within forms. Also the flow planning has been improved to use less queries.
Reduced possibility of redirect loops when using Forward auth
POST /flows/instances/import/GET /sources/user_connections/saml/POST /sources/user_connections/saml/GET /sources/user_connections/saml/{id}/PUT /sources/user_connections/saml/{id}/DELETE /sources/user_connections/saml/{id}/PATCH /sources/user_connections/saml/{id}/GET /sources/user_connections/saml/{id}/used_by/POST /flows/instances/import_flow/GET /core/tenants/{tenant_uuid}/Changed response : 200 OK
application/json
flow_device_code (string)PUT /core/tenants/{tenant_uuid}/Changed content type : application/json
flow_device_code (string)Changed response : 200 OK
application/json
flow_device_code (string)PATCH /core/tenants/{tenant_uuid}/Changed content type : application/json
flow_device_code (string)Changed response : 200 OK
application/json
flow_device_code (string)GET /propertymappings/notification/{pm_uuid}/Changed: pm_uuid in path
A UUID string identifying this Webhook Mapping.
PUT /propertymappings/notification/{pm_uuid}/Changed: pm_uuid in path
A UUID string identifying this Webhook Mapping.
DELETE /propertymappings/notification/{pm_uuid}/Changed: pm_uuid in path
A UUID string identifying this Webhook Mapping.
PATCH /propertymappings/notification/{pm_uuid}/Changed: pm_uuid in path
A UUID string identifying this Webhook Mapping.
GET /admin/metrics/Changed response : 200 OK
Changed content type : application/json
New required properties:
authorizations_per_1hAdded property authorizations_per_1h (array)
Items (object): > Coordinates for diagrams
Property x_cord (integer)
Property y_cord (integer)
POST /core/tenants/Changed content type : application/json
flow_device_code (string)Changed response : 201 Created
application/json
flow_device_code (string)GET /core/tenants/Added: flow_device_code in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Tenant Serializer
flow_device_code (string)GET /core/tenants/current/Changed response : 200 OK
application/json
flow_device_code (string)GET /crypto/certificatekeypairs/Added: include_details in query
GET /propertymappings/notification/{pm_uuid}/used_by/Changed: pm_uuid in path
A UUID string identifying this Webhook Mapping.
GET /root/config/Changed response : 200 OK
application/json
Changed property capabilities (array)
Changed items (string):
Added enum value:
can_debugGET /sources/oauth/{slug}/Changed response : 200 OK
application/json
Changed property provider_type (string)
Added enum value:
twitchPUT /sources/oauth/{slug}/Changed content type : application/json
Changed property provider_type (string)
Added enum value:
twitchChanged response : 200 OK
application/json
Changed property provider_type (string)
Added enum value:
twitchPATCH /sources/oauth/{slug}/Changed content type : application/json
Changed property provider_type (string)
Added enum value:
twitchChanged response : 200 OK
application/json
Changed property provider_type (string)
Added enum value:
twitchGET /flows/bindings/{fsb_uuid}/Changed response : 200 OK
application/json
Changed property stage_obj (object)
Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /flows/bindings/{fsb_uuid}/Changed response : 200 OK
application/json
Changed property stage_obj (object)
Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /flows/bindings/{fsb_uuid}/Changed response : 200 OK
application/json
Changed property stage_obj (object)
Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /sources/oauth/Changed content type : application/json
Changed property provider_type (string)
Added enum value:
twitchChanged response : 201 Created
application/json
Changed property provider_type (string)
Added enum value:
twitchGET /sources/oauth/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > OAuth Source Serializer
Changed property provider_type (string)
Added enum value:
twitchGET /stages/all/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/authenticator/duo/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/authenticator/duo/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/authenticator/duo/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/authenticator/sms/{stage_uuid}/Changed response : 200 OK
application/json
Added property mapping (string)
Optionally modify the payload being sent to custom providers.
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/authenticator/sms/{stage_uuid}/Changed content type : application/json
Added property mapping (string)
Optionally modify the payload being sent to custom providers.
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Added property mapping (string)
Optionally modify the payload being sent to custom providers.
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/authenticator/sms/{stage_uuid}/Changed content type : application/json
Added property mapping (string)
Optionally modify the payload being sent to custom providers.
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Added property mapping (string)
Optionally modify the payload being sent to custom providers.
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/authenticator/static/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/authenticator/static/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/authenticator/static/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/authenticator/totp/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/authenticator/totp/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/authenticator/totp/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/authenticator/validate/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/authenticator/validate/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/authenticator/validate/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/authenticator/webauthn/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/authenticator/webauthn/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/authenticator/webauthn/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/captcha/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/captcha/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/captcha/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/consent/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/consent/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/consent/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/deny/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/deny/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/deny/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/dummy/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/dummy/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/dummy/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/email/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/email/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/email/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/identification/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/identification/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/identification/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/invitation/stages/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/invitation/stages/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/invitation/stages/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/password/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/password/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/password/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/prompt/stages/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/prompt/stages/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/prompt/stages/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/user_delete/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/user_delete/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/user_delete/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/user_login/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/user_login/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/user_login/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/user_logout/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/user_logout/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/user_logout/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/user_write/{stage_uuid}/Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/user_write/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/user_write/{stage_uuid}/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /flows/bindings/Changed response : 201 Created
application/json
Changed property stage_obj (object)
Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /flows/bindings/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > FlowStageBinding Serializer
Changed property stage_obj (object)
Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /flows/executor/{flow_slug}/Changed response : 200 OK
Changed content type : application/json
Deleted 'ak-flow-sources-plex' component Deleted 'ak-flow-sources-oauth-apple' component Added 'ak-provider-oauth2-device-code' component:
Property type (string)
Enum values:
nativeshellredirectProperty flow_info (object)
Contextual flow information for a challenge
Property title (string)
Property background (string)
Property cancel_url (string)
Property layout (string)
Enum values:
stackedcontent_leftcontent_rightsidebar_leftsidebar_rightProperty component (string)
Property response_errors (object)
Added 'ak-source-oauth-apple' component:
Property type (string)
Property flow_info (object)
Contextual flow information for a challenge
Property component (string)
Property response_errors (object)
Property client_id (string)
Property scope (string)
Property redirect_uri (string)
Property state (string)
Added 'ak-source-plex' component:
Property type (string)
Property flow_info (object)
Contextual flow information for a challenge
Property component (string)
Property response_errors (object)
Property client_id (string)
Property slug (string)
Added 'ak-provider-oauth2-device-code-finish' component:
Property type (string)
Property flow_info (object)
Contextual flow information for a challenge
Property component (string)
Property response_errors (object)
Updated ak-stage-identification component:
Changed property sources (array)
Changed items (object): > Serializer for Login buttons of sources
Changed property challenge (object)
Deleted 'ak-flow-sources-plex' component Deleted 'ak-flow-sources-oauth-apple' component Added 'ak-source-oauth-apple' component: Added 'ak-source-plex' component:
POST /flows/executor/{flow_slug}/Changed content type : application/json
Deleted 'ak-flow-sources-plex' component Deleted 'ak-flow-sources-oauth-apple' component Added 'ak-provider-oauth2-device-code' component:
Property component (string)
Property code (integer)
Added 'ak-source-oauth-apple' component:
component (string)Added 'ak-source-plex' component:
component (string)Added 'ak-provider-oauth2-device-code-finish' component:
component (string)Changed response : 200 OK
Changed content type : application/json
Deleted 'ak-flow-sources-plex' component
Deleted 'ak-flow-sources-oauth-apple' component
Added 'ak-provider-oauth2-device-code' component:
Added 'ak-source-oauth-apple' component:
Added 'ak-source-plex' component:
Added 'ak-provider-oauth2-device-code-finish' component:
Updated ak-stage-identification component:
Changed property sources (array)
Changed items (object): > Serializer for Login buttons of sources
Changed property challenge (object)
Deleted 'ak-flow-sources-plex' component Deleted 'ak-flow-sources-oauth-apple' component Added 'ak-source-oauth-apple' component: Added 'ak-source-plex' component:
GET /flows/inspector/{flow_slug}/Changed response : 200 OK
application/json
Changed property plans (array)
Changed items (object): > Serializer for an active FlowPlan
Changed property current_stage (object)
FlowStageBinding Serializer
Changed property stage_obj (object)
Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/all/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/authenticator/duo/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/authenticator/duo/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorDuoStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/authenticator/sms/Changed content type : application/json
Added property mapping (string)
Optionally modify the payload being sent to custom providers.
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Added property mapping (string)
Optionally modify the payload being sent to custom providers.
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/authenticator/sms/Added: mapping in query
Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorSMSStage Serializer
Added property mapping (string)
Optionally modify the payload being sent to custom providers.
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/authenticator/static/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/authenticator/static/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorStaticStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/authenticator/totp/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/authenticator/totp/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorTOTPStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/authenticator/validate/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/authenticator/validate/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticatorValidateStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/authenticator/webauthn/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/authenticator/webauthn/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > AuthenticateWebAuthnStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/captcha/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/captcha/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > CaptchaStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/consent/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/consent/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > ConsentStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/deny/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/deny/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > DenyStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/dummy/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/dummy/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > DummyStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/email/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/email/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > EmailStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/identification/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/identification/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > IdentificationStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/invitation/stages/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/invitation/stages/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > InvitationStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/password/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/password/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > PasswordStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/prompt/prompts/{prompt_uuid}/Changed response : 200 OK
application/json
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PUT /stages/prompt/prompts/{prompt_uuid}/Changed content type : application/json
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
PATCH /stages/prompt/prompts/{prompt_uuid}/Changed content type : application/json
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 200 OK
application/json
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/prompt/stages/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/prompt/stages/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > PromptStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/user_delete/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/user_delete/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserDeleteStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/user_login/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/user_login/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserLoginStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/user_logout/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/user_logout/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserLogoutStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/user_write/Changed content type : application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/user_write/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > UserWriteStage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
POST /stages/prompt/prompts/Changed content type : application/json
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
Changed response : 201 Created
application/json
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
GET /stages/prompt/prompts/Changed response : 200 OK
application/json
Changed property results (array)
Changed items (object): > Prompt Serializer
Changed property promptstage_set (array)
Changed items (object): > Stage Serializer
Changed property flow_set (array)
Changed items (object): > Stripped down flow serializer
New optional properties:
cache_countpoliciesstagesDeleted property stages (array)
Deleted property policies (array)
Deleted property cache_count (integer)
This release does not introduce any new requirements.
Download the docker-compose file for 2022.10 from here. Afterwards, simply run docker-compose up -d.
Update your values to use the new images:
image:
repository: ghcr.io/goauthentik/server
tag: 2022.10.1