31785 lines
844 KiB
YAML
31785 lines
844 KiB
YAML
openapi: 3.0.3
|
|
info:
|
|
title: authentik
|
|
version: 2022.6.2
|
|
description: Making authentication simple.
|
|
contact:
|
|
email: hello@goauthentik.io
|
|
license:
|
|
name: GNU GPLv3
|
|
url: https://github.com/goauthentik/authentik/blob/main/LICENSE
|
|
paths:
|
|
/admin/apps/:
|
|
get:
|
|
operationId: admin_apps_list
|
|
description: List current messages and pass into Serializer
|
|
tags:
|
|
- admin
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/App'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/admin/metrics/:
|
|
get:
|
|
operationId: admin_metrics_retrieve
|
|
description: Login Metrics per 1h
|
|
tags:
|
|
- admin
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/LoginMetrics'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/admin/system/:
|
|
get:
|
|
operationId: admin_system_retrieve
|
|
description: Get system information.
|
|
tags:
|
|
- admin
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/System'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/admin/system_tasks/:
|
|
get:
|
|
operationId: admin_system_tasks_list
|
|
description: List system tasks
|
|
tags:
|
|
- admin
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Task'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/admin/system_tasks/{id}/:
|
|
get:
|
|
operationId: admin_system_tasks_retrieve
|
|
description: Get a single system task
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
tags:
|
|
- admin
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Task'
|
|
description: ''
|
|
'404':
|
|
description: Task not found
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/admin/system_tasks/{id}/retry/:
|
|
post:
|
|
operationId: admin_system_tasks_retry_create
|
|
description: Retry task
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
tags:
|
|
- admin
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: Task retried successfully
|
|
'404':
|
|
description: Task not found
|
|
'500':
|
|
description: Failed to retry task
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/admin/version/:
|
|
get:
|
|
operationId: admin_version_retrieve
|
|
description: Get running and latest version.
|
|
tags:
|
|
- admin
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Version'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/admin/workers/:
|
|
get:
|
|
operationId: admin_workers_retrieve
|
|
description: Get currently connected worker count.
|
|
tags:
|
|
- admin
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Workers'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/admin/duo/:
|
|
get:
|
|
operationId: authenticators_admin_duo_list
|
|
description: Viewset for Duo authenticator devices (for admins)
|
|
parameters:
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedDuoDeviceList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
post:
|
|
operationId: authenticators_admin_duo_create
|
|
description: Viewset for Duo authenticator devices (for admins)
|
|
tags:
|
|
- authenticators
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DuoDeviceRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DuoDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/admin/duo/{id}/:
|
|
get:
|
|
operationId: authenticators_admin_duo_retrieve
|
|
description: Viewset for Duo authenticator devices (for admins)
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this Duo Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DuoDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: authenticators_admin_duo_update
|
|
description: Viewset for Duo authenticator devices (for admins)
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this Duo Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DuoDeviceRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DuoDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: authenticators_admin_duo_partial_update
|
|
description: Viewset for Duo authenticator devices (for admins)
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this Duo Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedDuoDeviceRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DuoDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: authenticators_admin_duo_destroy
|
|
description: Viewset for Duo authenticator devices (for admins)
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this Duo Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/admin/sms/:
|
|
get:
|
|
operationId: authenticators_admin_sms_list
|
|
description: Viewset for sms authenticator devices (for admins)
|
|
parameters:
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedSMSDeviceList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/admin/sms/{id}/:
|
|
get:
|
|
operationId: authenticators_admin_sms_retrieve
|
|
description: Viewset for sms authenticator devices (for admins)
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this SMS Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SMSDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/admin/static/:
|
|
get:
|
|
operationId: authenticators_admin_static_list
|
|
description: Viewset for static authenticator devices (for admins)
|
|
parameters:
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedStaticDeviceList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/admin/static/{id}/:
|
|
get:
|
|
operationId: authenticators_admin_static_retrieve
|
|
description: Viewset for static authenticator devices (for admins)
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this static device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/StaticDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/admin/totp/:
|
|
get:
|
|
operationId: authenticators_admin_totp_list
|
|
description: Viewset for totp authenticator devices (for admins)
|
|
parameters:
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedTOTPDeviceList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/admin/totp/{id}/:
|
|
get:
|
|
operationId: authenticators_admin_totp_retrieve
|
|
description: Viewset for totp authenticator devices (for admins)
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this TOTP device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TOTPDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/admin/webauthn/:
|
|
get:
|
|
operationId: authenticators_admin_webauthn_list
|
|
description: Viewset for WebAuthn authenticator devices (for admins)
|
|
parameters:
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedWebAuthnDeviceList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/admin/webauthn/{id}/:
|
|
get:
|
|
operationId: authenticators_admin_webauthn_retrieve
|
|
description: Viewset for WebAuthn authenticator devices (for admins)
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this WebAuthn Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WebAuthnDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/all/:
|
|
get:
|
|
operationId: authenticators_all_list
|
|
description: Get all devices for current user
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Device'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/duo/:
|
|
get:
|
|
operationId: authenticators_duo_list
|
|
description: Viewset for Duo authenticator devices
|
|
parameters:
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedDuoDeviceList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/duo/{id}/:
|
|
get:
|
|
operationId: authenticators_duo_retrieve
|
|
description: Viewset for Duo authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this Duo Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DuoDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: authenticators_duo_update
|
|
description: Viewset for Duo authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this Duo Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DuoDeviceRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DuoDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: authenticators_duo_partial_update
|
|
description: Viewset for Duo authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this Duo Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedDuoDeviceRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DuoDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: authenticators_duo_destroy
|
|
description: Viewset for Duo authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this Duo Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/duo/{id}/used_by/:
|
|
get:
|
|
operationId: authenticators_duo_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this Duo Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/sms/:
|
|
get:
|
|
operationId: authenticators_sms_list
|
|
description: Viewset for sms authenticator devices
|
|
parameters:
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedSMSDeviceList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/sms/{id}/:
|
|
get:
|
|
operationId: authenticators_sms_retrieve
|
|
description: Viewset for sms authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this SMS Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SMSDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: authenticators_sms_update
|
|
description: Viewset for sms authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this SMS Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SMSDeviceRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SMSDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: authenticators_sms_partial_update
|
|
description: Viewset for sms authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this SMS Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedSMSDeviceRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SMSDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: authenticators_sms_destroy
|
|
description: Viewset for sms authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this SMS Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/sms/{id}/used_by/:
|
|
get:
|
|
operationId: authenticators_sms_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this SMS Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/static/:
|
|
get:
|
|
operationId: authenticators_static_list
|
|
description: Viewset for static authenticator devices
|
|
parameters:
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedStaticDeviceList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/static/{id}/:
|
|
get:
|
|
operationId: authenticators_static_retrieve
|
|
description: Viewset for static authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this static device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/StaticDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: authenticators_static_update
|
|
description: Viewset for static authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this static device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/StaticDeviceRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/StaticDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: authenticators_static_partial_update
|
|
description: Viewset for static authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this static device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedStaticDeviceRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/StaticDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: authenticators_static_destroy
|
|
description: Viewset for static authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this static device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/static/{id}/used_by/:
|
|
get:
|
|
operationId: authenticators_static_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this static device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/totp/:
|
|
get:
|
|
operationId: authenticators_totp_list
|
|
description: Viewset for totp authenticator devices
|
|
parameters:
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedTOTPDeviceList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/totp/{id}/:
|
|
get:
|
|
operationId: authenticators_totp_retrieve
|
|
description: Viewset for totp authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this TOTP device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TOTPDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: authenticators_totp_update
|
|
description: Viewset for totp authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this TOTP device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TOTPDeviceRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TOTPDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: authenticators_totp_partial_update
|
|
description: Viewset for totp authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this TOTP device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedTOTPDeviceRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TOTPDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: authenticators_totp_destroy
|
|
description: Viewset for totp authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this TOTP device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/totp/{id}/used_by/:
|
|
get:
|
|
operationId: authenticators_totp_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this TOTP device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/webauthn/:
|
|
get:
|
|
operationId: authenticators_webauthn_list
|
|
description: Viewset for WebAuthn authenticator devices
|
|
parameters:
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedWebAuthnDeviceList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/webauthn/{id}/:
|
|
get:
|
|
operationId: authenticators_webauthn_retrieve
|
|
description: Viewset for WebAuthn authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this WebAuthn Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WebAuthnDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: authenticators_webauthn_update
|
|
description: Viewset for WebAuthn authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this WebAuthn Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WebAuthnDeviceRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WebAuthnDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: authenticators_webauthn_partial_update
|
|
description: Viewset for WebAuthn authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this WebAuthn Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedWebAuthnDeviceRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WebAuthnDevice'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: authenticators_webauthn_destroy
|
|
description: Viewset for WebAuthn authenticator devices
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this WebAuthn Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/authenticators/webauthn/{id}/used_by/:
|
|
get:
|
|
operationId: authenticators_webauthn_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this WebAuthn Device.
|
|
required: true
|
|
tags:
|
|
- authenticators
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/applications/:
|
|
get:
|
|
operationId: core_applications_list
|
|
description: Custom list method that checks Policy based access instead of guardian
|
|
parameters:
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: superuser_full_list
|
|
schema:
|
|
type: boolean
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedApplicationList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
post:
|
|
operationId: core_applications_create
|
|
description: Application Viewset
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ApplicationRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Application'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/applications/{slug}/:
|
|
get:
|
|
operationId: core_applications_retrieve
|
|
description: Application Viewset
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Internal application name, used in URLs.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Application'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: core_applications_update
|
|
description: Application Viewset
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Internal application name, used in URLs.
|
|
required: true
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ApplicationRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Application'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: core_applications_partial_update
|
|
description: Application Viewset
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Internal application name, used in URLs.
|
|
required: true
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedApplicationRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Application'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: core_applications_destroy
|
|
description: Application Viewset
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Internal application name, used in URLs.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/applications/{slug}/check_access/:
|
|
get:
|
|
operationId: core_applications_check_access_retrieve
|
|
description: Check access to a single application by slug
|
|
parameters:
|
|
- in: query
|
|
name: for_user
|
|
schema:
|
|
type: integer
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Internal application name, used in URLs.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PolicyTestResult'
|
|
description: ''
|
|
'404':
|
|
description: for_user user not found
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/applications/{slug}/metrics/:
|
|
get:
|
|
operationId: core_applications_metrics_list
|
|
description: Metrics for application logins
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Internal application name, used in URLs.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Coordinate'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/applications/{slug}/set_icon/:
|
|
post:
|
|
operationId: core_applications_set_icon_create
|
|
description: Set application icon
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Internal application name, used in URLs.
|
|
required: true
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/FileUploadRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
description: Success
|
|
'400':
|
|
description: Bad request
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/applications/{slug}/set_icon_url/:
|
|
post:
|
|
operationId: core_applications_set_icon_url_create
|
|
description: Set application icon (as URL)
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Internal application name, used in URLs.
|
|
required: true
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FilePathRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
description: Success
|
|
'400':
|
|
description: Bad request
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/applications/{slug}/used_by/:
|
|
get:
|
|
operationId: core_applications_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Internal application name, used in URLs.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/authenticated_sessions/:
|
|
get:
|
|
operationId: core_authenticated_sessions_list
|
|
description: AuthenticatedSession Viewset
|
|
parameters:
|
|
- in: query
|
|
name: last_ip
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: last_user_agent
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: user__username
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedAuthenticatedSessionList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/authenticated_sessions/{uuid}/:
|
|
get:
|
|
operationId: core_authenticated_sessions_retrieve
|
|
description: AuthenticatedSession Viewset
|
|
parameters:
|
|
- in: path
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Authenticated Session.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/AuthenticatedSession'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: core_authenticated_sessions_destroy
|
|
description: AuthenticatedSession Viewset
|
|
parameters:
|
|
- in: path
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Authenticated Session.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/authenticated_sessions/{uuid}/used_by/:
|
|
get:
|
|
operationId: core_authenticated_sessions_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Authenticated Session.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/groups/:
|
|
get:
|
|
operationId: core_groups_list
|
|
description: Group Viewset
|
|
parameters:
|
|
- in: query
|
|
name: attributes
|
|
schema:
|
|
type: string
|
|
description: Attributes
|
|
- in: query
|
|
name: is_superuser
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: members_by_pk
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: integer
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: members_by_username
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
|
|
only.
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedGroupList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
post:
|
|
operationId: core_groups_create
|
|
description: Group Viewset
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GroupRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/groups/{group_uuid}/:
|
|
get:
|
|
operationId: core_groups_retrieve
|
|
description: Group Viewset
|
|
parameters:
|
|
- in: path
|
|
name: group_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this group.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: core_groups_update
|
|
description: Group Viewset
|
|
parameters:
|
|
- in: path
|
|
name: group_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this group.
|
|
required: true
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/GroupRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: core_groups_partial_update
|
|
description: Group Viewset
|
|
parameters:
|
|
- in: path
|
|
name: group_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this group.
|
|
required: true
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedGroupRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Group'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: core_groups_destroy
|
|
description: Group Viewset
|
|
parameters:
|
|
- in: path
|
|
name: group_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this group.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/groups/{group_uuid}/used_by/:
|
|
get:
|
|
operationId: core_groups_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: group_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this group.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/tenants/:
|
|
get:
|
|
operationId: core_tenants_list
|
|
description: Tenant Viewset
|
|
parameters:
|
|
- in: query
|
|
name: branding_favicon
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: branding_logo
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: branding_title
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: default
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: domain
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: event_retention
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: flow_authentication
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: flow_invalidation
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: flow_recovery
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: flow_unenrollment
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: flow_user_settings
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: tenant_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: web_certificate
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedTenantList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
post:
|
|
operationId: core_tenants_create
|
|
description: Tenant Viewset
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TenantRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Tenant'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/tenants/{tenant_uuid}/:
|
|
get:
|
|
operationId: core_tenants_retrieve
|
|
description: Tenant Viewset
|
|
parameters:
|
|
- in: path
|
|
name: tenant_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Tenant.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Tenant'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: core_tenants_update
|
|
description: Tenant Viewset
|
|
parameters:
|
|
- in: path
|
|
name: tenant_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Tenant.
|
|
required: true
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TenantRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Tenant'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: core_tenants_partial_update
|
|
description: Tenant Viewset
|
|
parameters:
|
|
- in: path
|
|
name: tenant_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Tenant.
|
|
required: true
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedTenantRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Tenant'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: core_tenants_destroy
|
|
description: Tenant Viewset
|
|
parameters:
|
|
- in: path
|
|
name: tenant_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Tenant.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/tenants/{tenant_uuid}/used_by/:
|
|
get:
|
|
operationId: core_tenants_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: tenant_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Tenant.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/tenants/current/:
|
|
get:
|
|
operationId: core_tenants_current_retrieve
|
|
description: Get current tenant
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
- {}
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CurrentTenant'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/tokens/:
|
|
get:
|
|
operationId: core_tokens_list
|
|
description: Token Viewset
|
|
parameters:
|
|
- in: query
|
|
name: description
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: expires
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: expiring
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: identifier
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: intent
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- api
|
|
- app_password
|
|
- recovery
|
|
- verification
|
|
- in: query
|
|
name: managed
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: user__username
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedTokenList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
post:
|
|
operationId: core_tokens_create
|
|
description: Token Viewset
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TokenRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/tokens/{identifier}/:
|
|
get:
|
|
operationId: core_tokens_retrieve
|
|
description: Token Viewset
|
|
parameters:
|
|
- in: path
|
|
name: identifier
|
|
schema:
|
|
type: string
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: core_tokens_update
|
|
description: Token Viewset
|
|
parameters:
|
|
- in: path
|
|
name: identifier
|
|
schema:
|
|
type: string
|
|
required: true
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TokenRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: core_tokens_partial_update
|
|
description: Token Viewset
|
|
parameters:
|
|
- in: path
|
|
name: identifier
|
|
schema:
|
|
type: string
|
|
required: true
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedTokenRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Token'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: core_tokens_destroy
|
|
description: Token Viewset
|
|
parameters:
|
|
- in: path
|
|
name: identifier
|
|
schema:
|
|
type: string
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/tokens/{identifier}/set_key/:
|
|
post:
|
|
operationId: core_tokens_set_key_create
|
|
description: Return token key and log access
|
|
parameters:
|
|
- in: path
|
|
name: identifier
|
|
schema:
|
|
type: string
|
|
required: true
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TokenSetKeyRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: Successfully changed key
|
|
'400':
|
|
description: Missing key
|
|
'404':
|
|
description: Token not found or expired
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/tokens/{identifier}/used_by/:
|
|
get:
|
|
operationId: core_tokens_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: identifier
|
|
schema:
|
|
type: string
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/tokens/{identifier}/view_key/:
|
|
get:
|
|
operationId: core_tokens_view_key_retrieve
|
|
description: Return token key and log access
|
|
parameters:
|
|
- in: path
|
|
name: identifier
|
|
schema:
|
|
type: string
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/TokenView'
|
|
description: ''
|
|
'404':
|
|
description: Token not found or expired
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/user_consent/:
|
|
get:
|
|
operationId: core_user_consent_list
|
|
description: UserConsent Viewset
|
|
parameters:
|
|
- in: query
|
|
name: application
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: user
|
|
schema:
|
|
type: integer
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedUserConsentList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/user_consent/{id}/:
|
|
get:
|
|
operationId: core_user_consent_retrieve
|
|
description: UserConsent Viewset
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this User Consent.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UserConsent'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: core_user_consent_destroy
|
|
description: UserConsent Viewset
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this User Consent.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/user_consent/{id}/used_by/:
|
|
get:
|
|
operationId: core_user_consent_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this User Consent.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/users/:
|
|
get:
|
|
operationId: core_users_list
|
|
description: User Viewset
|
|
parameters:
|
|
- in: query
|
|
name: attributes
|
|
schema:
|
|
type: string
|
|
description: Attributes
|
|
- in: query
|
|
name: email
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: groups_by_name
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: groups_by_pk
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: is_active
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: is_superuser
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: path
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: path_startswith
|
|
schema:
|
|
type: string
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: username
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedUserList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
post:
|
|
operationId: core_users_create
|
|
description: User Viewset
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UserRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/User'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/users/{id}/:
|
|
get:
|
|
operationId: core_users_retrieve
|
|
description: User Viewset
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this User.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/User'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: core_users_update
|
|
description: User Viewset
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this User.
|
|
required: true
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UserRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/User'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: core_users_partial_update
|
|
description: User Viewset
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this User.
|
|
required: true
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedUserRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/User'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: core_users_destroy
|
|
description: User Viewset
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this User.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/users/{id}/metrics/:
|
|
get:
|
|
operationId: core_users_metrics_retrieve
|
|
description: User metrics per 1h
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this User.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UserMetrics'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/users/{id}/recovery/:
|
|
get:
|
|
operationId: core_users_recovery_retrieve
|
|
description: Create a temporary link that a user can use to recover their accounts
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this User.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Link'
|
|
description: ''
|
|
'404':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Link'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/users/{id}/recovery_email/:
|
|
get:
|
|
operationId: core_users_recovery_email_retrieve
|
|
description: Create a temporary link that a user can use to recover their accounts
|
|
parameters:
|
|
- in: query
|
|
name: email_stage
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this User.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: Successfully sent recover email
|
|
'404':
|
|
description: Bad request
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/users/{id}/set_password/:
|
|
post:
|
|
operationId: core_users_set_password_create
|
|
description: Set password for user
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this User.
|
|
required: true
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UserPasswordSetRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: Successfully changed password
|
|
'400':
|
|
description: Bad request
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/users/{id}/used_by/:
|
|
get:
|
|
operationId: core_users_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: integer
|
|
description: A unique integer value identifying this User.
|
|
required: true
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/users/me/:
|
|
get:
|
|
operationId: core_users_me_retrieve
|
|
description: Get information about current user
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SessionUser'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/users/paths/:
|
|
get:
|
|
operationId: core_users_paths_retrieve
|
|
description: Get all user paths
|
|
parameters:
|
|
- in: query
|
|
name: search
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- core
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UserPath'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/core/users/service_account/:
|
|
post:
|
|
operationId: core_users_service_account_create
|
|
description: Create a new user account that is marked as a service account
|
|
tags:
|
|
- core
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UserServiceAccountRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UserServiceAccountResponse'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/crypto/certificatekeypairs/:
|
|
get:
|
|
operationId: crypto_certificatekeypairs_list
|
|
description: CertificateKeyPair Viewset
|
|
parameters:
|
|
- in: query
|
|
name: has_key
|
|
schema:
|
|
type: boolean
|
|
description: Only return certificate-key pairs with keys
|
|
- in: query
|
|
name: managed
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- crypto
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedCertificateKeyPairList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
post:
|
|
operationId: crypto_certificatekeypairs_create
|
|
description: CertificateKeyPair Viewset
|
|
tags:
|
|
- crypto
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CertificateKeyPairRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CertificateKeyPair'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/crypto/certificatekeypairs/{kp_uuid}/:
|
|
get:
|
|
operationId: crypto_certificatekeypairs_retrieve
|
|
description: CertificateKeyPair Viewset
|
|
parameters:
|
|
- in: path
|
|
name: kp_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Certificate-Key Pair.
|
|
required: true
|
|
tags:
|
|
- crypto
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CertificateKeyPair'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: crypto_certificatekeypairs_update
|
|
description: CertificateKeyPair Viewset
|
|
parameters:
|
|
- in: path
|
|
name: kp_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Certificate-Key Pair.
|
|
required: true
|
|
tags:
|
|
- crypto
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CertificateKeyPairRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CertificateKeyPair'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: crypto_certificatekeypairs_partial_update
|
|
description: CertificateKeyPair Viewset
|
|
parameters:
|
|
- in: path
|
|
name: kp_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Certificate-Key Pair.
|
|
required: true
|
|
tags:
|
|
- crypto
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedCertificateKeyPairRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CertificateKeyPair'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: crypto_certificatekeypairs_destroy
|
|
description: CertificateKeyPair Viewset
|
|
parameters:
|
|
- in: path
|
|
name: kp_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Certificate-Key Pair.
|
|
required: true
|
|
tags:
|
|
- crypto
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/crypto/certificatekeypairs/{kp_uuid}/used_by/:
|
|
get:
|
|
operationId: crypto_certificatekeypairs_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: kp_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Certificate-Key Pair.
|
|
required: true
|
|
tags:
|
|
- crypto
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/crypto/certificatekeypairs/{kp_uuid}/view_certificate/:
|
|
get:
|
|
operationId: crypto_certificatekeypairs_view_certificate_retrieve
|
|
description: Return certificate-key pairs certificate and log access
|
|
parameters:
|
|
- in: query
|
|
name: download
|
|
schema:
|
|
type: boolean
|
|
- in: path
|
|
name: kp_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Certificate-Key Pair.
|
|
required: true
|
|
tags:
|
|
- crypto
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CertificateData'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/crypto/certificatekeypairs/{kp_uuid}/view_private_key/:
|
|
get:
|
|
operationId: crypto_certificatekeypairs_view_private_key_retrieve
|
|
description: Return certificate-key pairs private key and log access
|
|
parameters:
|
|
- in: query
|
|
name: download
|
|
schema:
|
|
type: boolean
|
|
- in: path
|
|
name: kp_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Certificate-Key Pair.
|
|
required: true
|
|
tags:
|
|
- crypto
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CertificateData'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/crypto/certificatekeypairs/generate/:
|
|
post:
|
|
operationId: crypto_certificatekeypairs_generate_create
|
|
description: Generate a new, self-signed certificate-key pair
|
|
tags:
|
|
- crypto
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CertificateGenerationRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CertificateKeyPair'
|
|
description: ''
|
|
'400':
|
|
description: Bad request
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/events/:
|
|
get:
|
|
operationId: events_events_list
|
|
description: Event Read-Only Viewset
|
|
parameters:
|
|
- in: query
|
|
name: action
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: client_ip
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: context_authorized_app
|
|
schema:
|
|
type: string
|
|
description: Context Authorized application
|
|
- in: query
|
|
name: context_model_app
|
|
schema:
|
|
type: string
|
|
description: Context Model App
|
|
- in: query
|
|
name: context_model_name
|
|
schema:
|
|
type: string
|
|
description: Context Model Name
|
|
- in: query
|
|
name: context_model_pk
|
|
schema:
|
|
type: string
|
|
description: Context Model Primary Key
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: tenant_name
|
|
schema:
|
|
type: string
|
|
description: Tenant name
|
|
- in: query
|
|
name: username
|
|
schema:
|
|
type: string
|
|
description: Username
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedEventList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
post:
|
|
operationId: events_events_create
|
|
description: Event Read-Only Viewset
|
|
tags:
|
|
- events
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/EventRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Event'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/events/{event_uuid}/:
|
|
get:
|
|
operationId: events_events_retrieve
|
|
description: Event Read-Only Viewset
|
|
parameters:
|
|
- in: path
|
|
name: event_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Event.
|
|
required: true
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Event'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: events_events_update
|
|
description: Event Read-Only Viewset
|
|
parameters:
|
|
- in: path
|
|
name: event_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Event.
|
|
required: true
|
|
tags:
|
|
- events
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/EventRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Event'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: events_events_partial_update
|
|
description: Event Read-Only Viewset
|
|
parameters:
|
|
- in: path
|
|
name: event_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Event.
|
|
required: true
|
|
tags:
|
|
- events
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedEventRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Event'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: events_events_destroy
|
|
description: Event Read-Only Viewset
|
|
parameters:
|
|
- in: path
|
|
name: event_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Event.
|
|
required: true
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/events/actions/:
|
|
get:
|
|
operationId: events_events_actions_list
|
|
description: Get all actions
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/TypeCreate'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/events/per_month/:
|
|
get:
|
|
operationId: events_events_per_month_list
|
|
description: Get the count of events per month
|
|
parameters:
|
|
- in: query
|
|
name: action
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: query
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/Coordinate'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/events/top_per_user/:
|
|
get:
|
|
operationId: events_events_top_per_user_list
|
|
description: Get the top_n events grouped by user count
|
|
parameters:
|
|
- in: query
|
|
name: action
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: top_n
|
|
schema:
|
|
type: integer
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/EventTopPerUser'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/notifications/:
|
|
get:
|
|
operationId: events_notifications_list
|
|
description: Notification Viewset
|
|
parameters:
|
|
- in: query
|
|
name: body
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: created
|
|
schema:
|
|
type: string
|
|
format: date-time
|
|
- in: query
|
|
name: event
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: seen
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: severity
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- alert
|
|
- notice
|
|
- warning
|
|
- in: query
|
|
name: user
|
|
schema:
|
|
type: integer
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedNotificationList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/notifications/{uuid}/:
|
|
get:
|
|
operationId: events_notifications_retrieve
|
|
description: Notification Viewset
|
|
parameters:
|
|
- in: path
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification.
|
|
required: true
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Notification'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: events_notifications_update
|
|
description: Notification Viewset
|
|
parameters:
|
|
- in: path
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification.
|
|
required: true
|
|
tags:
|
|
- events
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Notification'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: events_notifications_partial_update
|
|
description: Notification Viewset
|
|
parameters:
|
|
- in: path
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification.
|
|
required: true
|
|
tags:
|
|
- events
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedNotificationRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Notification'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: events_notifications_destroy
|
|
description: Notification Viewset
|
|
parameters:
|
|
- in: path
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification.
|
|
required: true
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/notifications/{uuid}/used_by/:
|
|
get:
|
|
operationId: events_notifications_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification.
|
|
required: true
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/notifications/mark_all_seen/:
|
|
post:
|
|
operationId: events_notifications_mark_all_seen_create
|
|
description: Mark all the user's notifications as seen
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: Marked tasks as read successfully.
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/rules/:
|
|
get:
|
|
operationId: events_rules_list
|
|
description: NotificationRule Viewset
|
|
parameters:
|
|
- in: query
|
|
name: group__name
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: severity
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- alert
|
|
- notice
|
|
- warning
|
|
description: Controls which severity level the created notifications will
|
|
have.
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedNotificationRuleList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
post:
|
|
operationId: events_rules_create
|
|
description: NotificationRule Viewset
|
|
tags:
|
|
- events
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationRuleRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationRule'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/rules/{pbm_uuid}/:
|
|
get:
|
|
operationId: events_rules_retrieve
|
|
description: NotificationRule Viewset
|
|
parameters:
|
|
- in: path
|
|
name: pbm_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification Rule.
|
|
required: true
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationRule'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: events_rules_update
|
|
description: NotificationRule Viewset
|
|
parameters:
|
|
- in: path
|
|
name: pbm_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification Rule.
|
|
required: true
|
|
tags:
|
|
- events
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationRuleRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationRule'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: events_rules_partial_update
|
|
description: NotificationRule Viewset
|
|
parameters:
|
|
- in: path
|
|
name: pbm_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification Rule.
|
|
required: true
|
|
tags:
|
|
- events
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedNotificationRuleRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationRule'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: events_rules_destroy
|
|
description: NotificationRule Viewset
|
|
parameters:
|
|
- in: path
|
|
name: pbm_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification Rule.
|
|
required: true
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/rules/{pbm_uuid}/used_by/:
|
|
get:
|
|
operationId: events_rules_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: pbm_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification Rule.
|
|
required: true
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/transports/:
|
|
get:
|
|
operationId: events_transports_list
|
|
description: NotificationTransport Viewset
|
|
parameters:
|
|
- in: query
|
|
name: mode
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- email
|
|
- local
|
|
- webhook
|
|
- webhook_slack
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: send_once
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: webhook_url
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedNotificationTransportList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
post:
|
|
operationId: events_transports_create
|
|
description: NotificationTransport Viewset
|
|
tags:
|
|
- events
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationTransportRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationTransport'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/transports/{uuid}/:
|
|
get:
|
|
operationId: events_transports_retrieve
|
|
description: NotificationTransport Viewset
|
|
parameters:
|
|
- in: path
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification Transport.
|
|
required: true
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationTransport'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: events_transports_update
|
|
description: NotificationTransport Viewset
|
|
parameters:
|
|
- in: path
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification Transport.
|
|
required: true
|
|
tags:
|
|
- events
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationTransportRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationTransport'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: events_transports_partial_update
|
|
description: NotificationTransport Viewset
|
|
parameters:
|
|
- in: path
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification Transport.
|
|
required: true
|
|
tags:
|
|
- events
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedNotificationTransportRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationTransport'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: events_transports_destroy
|
|
description: NotificationTransport Viewset
|
|
parameters:
|
|
- in: path
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification Transport.
|
|
required: true
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/transports/{uuid}/test/:
|
|
post:
|
|
operationId: events_transports_test_create
|
|
description: |-
|
|
Send example notification using selected transport. Requires
|
|
Modify permissions.
|
|
parameters:
|
|
- in: path
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification Transport.
|
|
required: true
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NotificationTransportTest'
|
|
description: ''
|
|
'500':
|
|
description: Failed to test transport
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/events/transports/{uuid}/used_by/:
|
|
get:
|
|
operationId: events_transports_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Notification Transport.
|
|
required: true
|
|
tags:
|
|
- events
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/flows/bindings/:
|
|
get:
|
|
operationId: flows_bindings_list
|
|
description: FlowStageBinding Viewset
|
|
parameters:
|
|
- in: query
|
|
name: evaluate_on_plan
|
|
schema:
|
|
type: boolean
|
|
- in: query
|
|
name: fsb_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: invalid_response_action
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- restart
|
|
- restart_with_context
|
|
- retry
|
|
description: Configure how the flow executor should handle an invalid response
|
|
to a challenge. RETRY returns the error message and a similar challenge
|
|
to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT
|
|
restarts the flow while keeping the current context.
|
|
- in: query
|
|
name: order
|
|
schema:
|
|
type: integer
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- in: query
|
|
name: pbm_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: policies
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uuid
|
|
explode: true
|
|
style: form
|
|
- in: query
|
|
name: policy_engine_mode
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- all
|
|
- any
|
|
- in: query
|
|
name: re_evaluate_policies
|
|
schema:
|
|
type: boolean
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: stage
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: target
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
tags:
|
|
- flows
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedFlowStageBindingList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
post:
|
|
operationId: flows_bindings_create
|
|
description: FlowStageBinding Viewset
|
|
tags:
|
|
- flows
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FlowStageBindingRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FlowStageBinding'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/flows/bindings/{fsb_uuid}/:
|
|
get:
|
|
operationId: flows_bindings_retrieve
|
|
description: FlowStageBinding Viewset
|
|
parameters:
|
|
- in: path
|
|
name: fsb_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Flow Stage Binding.
|
|
required: true
|
|
tags:
|
|
- flows
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FlowStageBinding'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: flows_bindings_update
|
|
description: FlowStageBinding Viewset
|
|
parameters:
|
|
- in: path
|
|
name: fsb_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Flow Stage Binding.
|
|
required: true
|
|
tags:
|
|
- flows
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FlowStageBindingRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FlowStageBinding'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: flows_bindings_partial_update
|
|
description: FlowStageBinding Viewset
|
|
parameters:
|
|
- in: path
|
|
name: fsb_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Flow Stage Binding.
|
|
required: true
|
|
tags:
|
|
- flows
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedFlowStageBindingRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FlowStageBinding'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: flows_bindings_destroy
|
|
description: FlowStageBinding Viewset
|
|
parameters:
|
|
- in: path
|
|
name: fsb_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Flow Stage Binding.
|
|
required: true
|
|
tags:
|
|
- flows
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/flows/bindings/{fsb_uuid}/used_by/:
|
|
get:
|
|
operationId: flows_bindings_used_by_list
|
|
description: Get a list of all objects that use this object
|
|
parameters:
|
|
- in: path
|
|
name: fsb_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
description: A UUID string identifying this Flow Stage Binding.
|
|
required: true
|
|
tags:
|
|
- flows
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/UsedBy'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/flows/executor/{flow_slug}/:
|
|
get:
|
|
operationId: flows_executor_get
|
|
description: Get the next pending challenge from the currently active flow.
|
|
parameters:
|
|
- in: path
|
|
name: flow_slug
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- in: query
|
|
name: query
|
|
schema:
|
|
type: string
|
|
description: Querystring as received
|
|
required: true
|
|
tags:
|
|
- flows
|
|
security:
|
|
- authentik: []
|
|
- {}
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ChallengeTypes'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
post:
|
|
operationId: flows_executor_solve
|
|
description: Solve the previously retrieved challenge and advanced to the next
|
|
stage.
|
|
parameters:
|
|
- in: path
|
|
name: flow_slug
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- in: query
|
|
name: query
|
|
schema:
|
|
type: string
|
|
description: Querystring as received
|
|
required: true
|
|
tags:
|
|
- flows
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FlowChallengeResponseRequest'
|
|
security:
|
|
- authentik: []
|
|
- {}
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ChallengeTypes'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/flows/inspector/{flow_slug}/:
|
|
get:
|
|
operationId: flows_inspector_get
|
|
description: Get current flow state and record it
|
|
parameters:
|
|
- in: path
|
|
name: flow_slug
|
|
schema:
|
|
type: string
|
|
required: true
|
|
tags:
|
|
- flows
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FlowInspection'
|
|
description: ''
|
|
'400':
|
|
description: No flow plan in session.
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/flows/instances/:
|
|
get:
|
|
operationId: flows_instances_list
|
|
description: Flow Viewset
|
|
parameters:
|
|
- in: query
|
|
name: designation
|
|
schema:
|
|
type: string
|
|
enum:
|
|
- authentication
|
|
- authorization
|
|
- enrollment
|
|
- invalidation
|
|
- recovery
|
|
- stage_configuration
|
|
- unenrollment
|
|
description: Decides what this Flow is used for. For example, the Authentication
|
|
flow is redirect to when an un-authenticated user visits authentik.
|
|
- in: query
|
|
name: flow_uuid
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
- in: query
|
|
name: name
|
|
schema:
|
|
type: string
|
|
- name: ordering
|
|
required: false
|
|
in: query
|
|
description: Which field to use when ordering the results.
|
|
schema:
|
|
type: string
|
|
- name: page
|
|
required: false
|
|
in: query
|
|
description: A page number within the paginated result set.
|
|
schema:
|
|
type: integer
|
|
- name: page_size
|
|
required: false
|
|
in: query
|
|
description: Number of results to return per page.
|
|
schema:
|
|
type: integer
|
|
- name: search
|
|
required: false
|
|
in: query
|
|
description: A search term.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
tags:
|
|
- flows
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PaginatedFlowList'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
post:
|
|
operationId: flows_instances_create
|
|
description: Flow Viewset
|
|
tags:
|
|
- flows
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FlowRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'201':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Flow'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/flows/instances/{slug}/:
|
|
get:
|
|
operationId: flows_instances_retrieve
|
|
description: Flow Viewset
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Visible in the URL.
|
|
required: true
|
|
tags:
|
|
- flows
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Flow'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
put:
|
|
operationId: flows_instances_update
|
|
description: Flow Viewset
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Visible in the URL.
|
|
required: true
|
|
tags:
|
|
- flows
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FlowRequest'
|
|
required: true
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Flow'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
patch:
|
|
operationId: flows_instances_partial_update
|
|
description: Flow Viewset
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Visible in the URL.
|
|
required: true
|
|
tags:
|
|
- flows
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PatchedFlowRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Flow'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
delete:
|
|
operationId: flows_instances_destroy
|
|
description: Flow Viewset
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Visible in the URL.
|
|
required: true
|
|
tags:
|
|
- flows
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'204':
|
|
description: No response body
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/flows/instances/{slug}/diagram/:
|
|
get:
|
|
operationId: flows_instances_diagram_retrieve
|
|
description: Return diagram for flow with slug `slug`, in the format used by
|
|
flowchart.js
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Visible in the URL.
|
|
required: true
|
|
tags:
|
|
- flows
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FlowDiagram'
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/flows/instances/{slug}/execute/:
|
|
get:
|
|
operationId: flows_instances_execute_retrieve
|
|
description: Execute flow for current user
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Visible in the URL.
|
|
required: true
|
|
tags:
|
|
- flows
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Link'
|
|
description: ''
|
|
'400':
|
|
description: Flow not applicable
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/flows/instances/{slug}/export/:
|
|
get:
|
|
operationId: flows_instances_export_retrieve
|
|
description: Export flow to .akflow file
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Visible in the URL.
|
|
required: true
|
|
tags:
|
|
- flows
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: string
|
|
format: binary
|
|
description: ''
|
|
'400':
|
|
$ref: '#/components/schemas/ValidationError'
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/flows/instances/{slug}/set_background/:
|
|
post:
|
|
operationId: flows_instances_set_background_create
|
|
description: Set Flow background
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Visible in the URL.
|
|
required: true
|
|
tags:
|
|
- flows
|
|
requestBody:
|
|
content:
|
|
multipart/form-data:
|
|
schema:
|
|
$ref: '#/components/schemas/FileUploadRequest'
|
|
security:
|
|
- authentik: []
|
|
responses:
|
|
'200':
|
|
description: Success
|
|
'400':
|
|
description: Bad request
|
|
'403':
|
|
$ref: '#/components/schemas/GenericError'
|
|
/flows/instances/{slug}/set_background_url/:
|
|
post:
|
|
operationId: flows_instances_set_background_url_create
|
|
description: Set Flow background (as URL)
|
|
parameters:
|
|
- in: path
|
|
name: slug
|
|
schema:
|
|
type: string
|
|
description: Visible in the URL.
|
|
required: true
|
|
tags:
|
|
- flows
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|