openapi: 3.2.0 info: title: authentik Authenticators API version: 2026.11.0-rc1 description: Making authentication simple. contact: email: hello@goauthentik.io license: name: MIT url: https://github.com/goauthentik/authentik/blob/main/LICENSE x-source-url: https://api.goauthentik.io/schema.yml x-last-validated: '2026-09-04' servers: - url: /api/v3 tags: - name: authenticators paths: /authenticators/admin/all/: get: operationId: authenticators_admin_all_list description: Get all devices for current user parameters: - in: query name: user schema: type: integer tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Device' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/admin/duo/: get: operationId: authenticators_admin_duo_list description: Viewset for Duo authenticator devices (for admins) parameters: - $ref: '#/components/parameters/QueryName' - $ref: '#/components/parameters/QueryPaginationOrdering' - $ref: '#/components/parameters/QueryPaginationPage' - $ref: '#/components/parameters/QueryPaginationPageSize' - $ref: '#/components/parameters/QuerySearch' tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDuoDeviceList' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/admin/email/: get: operationId: authenticators_admin_email_list description: Viewset for email authenticator devices (for admins) parameters: - $ref: '#/components/parameters/QueryName' - $ref: '#/components/parameters/QueryPaginationOrdering' - $ref: '#/components/parameters/QueryPaginationPage' - $ref: '#/components/parameters/QueryPaginationPageSize' - $ref: '#/components/parameters/QuerySearch' tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedEmailDeviceList' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' post: operationId: authenticators_admin_email_create description: Viewset for email authenticator devices (for admins) tags: - authenticators requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailDeviceRequest' required: true security: - authentik: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/EmailDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/admin/email/{id}/: get: operationId: authenticators_admin_email_retrieve description: Viewset for email authenticator devices (for admins) parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Email Device. required: true tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmailDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' put: operationId: authenticators_admin_email_update description: Viewset for email authenticator devices (for admins) parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Email Device. required: true tags: - authenticators requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailDeviceRequest' required: true security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmailDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' patch: operationId: authenticators_admin_email_partial_update description: Viewset for email authenticator devices (for admins) parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Email Device. required: true tags: - authenticators requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedEmailDeviceRequest' security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmailDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' delete: operationId: authenticators_admin_email_destroy description: Viewset for email authenticator devices (for admins) parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Email Device. required: true tags: - authenticators security: - authentik: [] responses: '204': description: No response body '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/admin/endpoint/: get: operationId: authenticators_admin_endpoint_list description: Viewset for Endpoint authenticator devices (for admins) parameters: - $ref: '#/components/parameters/QueryName' - $ref: '#/components/parameters/QueryPaginationOrdering' - $ref: '#/components/parameters/QueryPaginationPage' - $ref: '#/components/parameters/QueryPaginationPageSize' - $ref: '#/components/parameters/QuerySearch' tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGoogleEndpointDeviceList' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' post: operationId: authenticators_admin_endpoint_create description: Viewset for Endpoint authenticator devices (for admins) tags: - authenticators requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleEndpointDeviceRequest' required: true security: - authentik: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/GoogleEndpointDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/admin/endpoint/{uuid}/: get: operationId: authenticators_admin_endpoint_retrieve description: Viewset for Endpoint authenticator devices (for admins) parameters: - in: path name: uuid schema: type: string format: uuid description: A UUID string identifying this Endpoint Device. required: true tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GoogleEndpointDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' put: operationId: authenticators_admin_endpoint_update description: Viewset for Endpoint authenticator devices (for admins) parameters: - in: path name: uuid schema: type: string format: uuid description: A UUID string identifying this Endpoint Device. required: true tags: - authenticators requestBody: content: application/json: schema: $ref: '#/components/schemas/GoogleEndpointDeviceRequest' required: true security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GoogleEndpointDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' patch: operationId: authenticators_admin_endpoint_partial_update description: Viewset for Endpoint authenticator devices (for admins) parameters: - in: path name: uuid schema: type: string format: uuid description: A UUID string identifying this Endpoint Device. required: true tags: - authenticators requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedGoogleEndpointDeviceRequest' security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GoogleEndpointDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' delete: operationId: authenticators_admin_endpoint_destroy description: Viewset for Endpoint authenticator devices (for admins) parameters: - in: path name: uuid schema: type: string format: uuid description: A UUID string identifying this Endpoint Device. required: true tags: - authenticators security: - authentik: [] responses: '204': description: No response body '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/admin/sms/: get: operationId: authenticators_admin_sms_list description: Viewset for sms authenticator devices (for admins) parameters: - $ref: '#/components/parameters/QueryName' - $ref: '#/components/parameters/QueryPaginationOrdering' - $ref: '#/components/parameters/QueryPaginationPage' - $ref: '#/components/parameters/QueryPaginationPageSize' - $ref: '#/components/parameters/QuerySearch' tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSMSDeviceList' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' post: operationId: authenticators_admin_sms_create description: Viewset for sms authenticator devices (for admins) tags: - authenticators requestBody: content: application/json: schema: $ref: '#/components/schemas/SMSDeviceRequest' required: true security: - authentik: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/SMSDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' put: operationId: authenticators_admin_sms_update 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 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' patch: operationId: authenticators_admin_sms_partial_update 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 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' delete: operationId: authenticators_admin_sms_destroy 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: '204': description: No response body '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/admin/static/: get: operationId: authenticators_admin_static_list description: Viewset for static authenticator devices (for admins) parameters: - $ref: '#/components/parameters/QueryName' - $ref: '#/components/parameters/QueryPaginationOrdering' - $ref: '#/components/parameters/QueryPaginationPage' - $ref: '#/components/parameters/QueryPaginationPageSize' - $ref: '#/components/parameters/QuerySearch' tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedStaticDeviceList' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' post: operationId: authenticators_admin_static_create description: Viewset for static authenticator devices (for admins) tags: - authenticators requestBody: content: application/json: schema: $ref: '#/components/schemas/StaticDeviceRequest' required: true security: - authentik: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/StaticDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' put: operationId: authenticators_admin_static_update 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 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' patch: operationId: authenticators_admin_static_partial_update 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 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' delete: operationId: authenticators_admin_static_destroy 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: '204': description: No response body '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/admin/totp/: get: operationId: authenticators_admin_totp_list description: Viewset for totp authenticator devices (for admins) parameters: - $ref: '#/components/parameters/QueryName' - $ref: '#/components/parameters/QueryPaginationOrdering' - $ref: '#/components/parameters/QueryPaginationPage' - $ref: '#/components/parameters/QueryPaginationPageSize' - $ref: '#/components/parameters/QuerySearch' tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTOTPDeviceList' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' post: operationId: authenticators_admin_totp_create description: Viewset for totp authenticator devices (for admins) tags: - authenticators requestBody: content: application/json: schema: $ref: '#/components/schemas/TOTPDeviceRequest' required: true security: - authentik: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/TOTPDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' put: operationId: authenticators_admin_totp_update 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 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' patch: operationId: authenticators_admin_totp_partial_update 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 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' delete: operationId: authenticators_admin_totp_destroy 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: '204': description: No response body '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/admin/webauthn/: get: operationId: authenticators_admin_webauthn_list description: Viewset for WebAuthn authenticator devices (for admins) parameters: - $ref: '#/components/parameters/QueryName' - $ref: '#/components/parameters/QueryPaginationOrdering' - $ref: '#/components/parameters/QueryPaginationPage' - $ref: '#/components/parameters/QueryPaginationPageSize' - $ref: '#/components/parameters/QuerySearch' tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedWebAuthnDeviceList' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' post: operationId: authenticators_admin_webauthn_create description: Viewset for WebAuthn authenticator devices (for admins) tags: - authenticators requestBody: content: application/json: schema: $ref: '#/components/schemas/WebAuthnDeviceRequest' required: true security: - authentik: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/WebAuthnDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' put: operationId: authenticators_admin_webauthn_update 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 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' patch: operationId: authenticators_admin_webauthn_partial_update 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 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' delete: operationId: authenticators_admin_webauthn_destroy 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: '204': description: No response body '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/duo/: get: operationId: authenticators_duo_list description: Viewset for Duo authenticator devices parameters: - $ref: '#/components/parameters/QueryName' - $ref: '#/components/parameters/QueryPaginationOrdering' - $ref: '#/components/parameters/QueryPaginationPage' - $ref: '#/components/parameters/QueryPaginationPageSize' - $ref: '#/components/parameters/QuerySearch' tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDuoDeviceList' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/email/: get: operationId: authenticators_email_list description: Viewset for email authenticator devices parameters: - $ref: '#/components/parameters/QueryName' - $ref: '#/components/parameters/QueryPaginationOrdering' - $ref: '#/components/parameters/QueryPaginationPage' - $ref: '#/components/parameters/QueryPaginationPageSize' - $ref: '#/components/parameters/QuerySearch' tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedEmailDeviceList' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/email/{id}/: get: operationId: authenticators_email_retrieve description: Viewset for email authenticator devices parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Email Device. required: true tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmailDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' put: operationId: authenticators_email_update description: Viewset for email authenticator devices parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Email Device. required: true tags: - authenticators requestBody: content: application/json: schema: $ref: '#/components/schemas/EmailDeviceRequest' required: true security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmailDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' patch: operationId: authenticators_email_partial_update description: Viewset for email authenticator devices parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Email Device. required: true tags: - authenticators requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedEmailDeviceRequest' security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmailDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' delete: operationId: authenticators_email_destroy description: Viewset for email authenticator devices parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Email Device. required: true tags: - authenticators security: - authentik: [] responses: '204': description: No response body '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/email/{id}/used_by/: get: operationId: authenticators_email_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 Email Device. required: true tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/UsedBy' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/endpoint/: get: operationId: authenticators_endpoint_list description: Viewset for Endpoint authenticator devices parameters: - $ref: '#/components/parameters/QueryName' - $ref: '#/components/parameters/QueryPaginationOrdering' - $ref: '#/components/parameters/QueryPaginationPage' - $ref: '#/components/parameters/QueryPaginationPageSize' - $ref: '#/components/parameters/QuerySearch' tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedGoogleEndpointDeviceList' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/endpoint/{uuid}/: get: operationId: authenticators_endpoint_retrieve description: Viewset for Endpoint authenticator devices parameters: - in: path name: uuid schema: type: string format: uuid description: A UUID string identifying this Endpoint Device. required: true tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/GoogleEndpointDevice' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/endpoint/{uuid}/used_by/: get: operationId: authenticators_endpoint_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 Endpoint Device. required: true tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/UsedBy' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/sms/: get: operationId: authenticators_sms_list description: Viewset for sms authenticator devices parameters: - $ref: '#/components/parameters/QueryName' - $ref: '#/components/parameters/QueryPaginationOrdering' - $ref: '#/components/parameters/QueryPaginationPage' - $ref: '#/components/parameters/QueryPaginationPageSize' - $ref: '#/components/parameters/QuerySearch' tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedSMSDeviceList' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/static/: get: operationId: authenticators_static_list description: Viewset for static authenticator devices parameters: - $ref: '#/components/parameters/QueryName' - $ref: '#/components/parameters/QueryPaginationOrdering' - $ref: '#/components/parameters/QueryPaginationPage' - $ref: '#/components/parameters/QueryPaginationPageSize' - $ref: '#/components/parameters/QuerySearch' tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedStaticDeviceList' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/totp/: get: operationId: authenticators_totp_list description: Viewset for totp authenticator devices parameters: - $ref: '#/components/parameters/QueryName' - $ref: '#/components/parameters/QueryPaginationOrdering' - $ref: '#/components/parameters/QueryPaginationPage' - $ref: '#/components/parameters/QueryPaginationPageSize' - $ref: '#/components/parameters/QuerySearch' tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTOTPDeviceList' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /authenticators/webauthn/: get: operationId: authenticators_webauthn_list description: Viewset for WebAuthn authenticator devices parameters: - $ref: '#/components/parameters/QueryName' - $ref: '#/components/parameters/QueryPaginationOrdering' - $ref: '#/components/parameters/QueryPaginationPage' - $ref: '#/components/parameters/QueryPaginationPageSize' - $ref: '#/components/parameters/QuerySearch' tags: - authenticators security: - authentik: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedWebAuthnDeviceList' description: '' '400': $ref: '#/components/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' 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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' /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/responses/ValidationErrorResponse' '403': $ref: '#/components/responses/GenericErrorResponse' components: schemas: PaginatedDuoDeviceList: type: object properties: pagination: $ref: '#/components/schemas/Pagination' results: type: array items: $ref: '#/components/schemas/DuoDevice' autocomplete: $ref: '#/components/schemas/Autocomplete' required: - autocomplete - pagination - results PatchedEmailDeviceRequest: type: object description: Serializer for email authenticator devices properties: name: type: string minLength: 1 description: The human-readable name of this device. maxLength: 64 PaginatedStaticDeviceList: type: object properties: pagination: $ref: '#/components/schemas/Pagination' results: type: array items: $ref: '#/components/schemas/StaticDevice' autocomplete: $ref: '#/components/schemas/Autocomplete' required: - autocomplete - pagination - results WebAuthnDeviceType: type: object description: WebAuthnDeviceType Serializer properties: aaguid: type: string format: uuid description: type: string required: - aaguid - description GoogleEndpointDevice: type: object description: Serializer for Endpoint authenticator devices properties: pk: type: string format: uuid title: Uuid name: type: string description: The human-readable name of this device. maxLength: 64 required: - name PatchedWebAuthnDeviceRequest: type: object description: Serializer for WebAuthn authenticator devices properties: name: type: string minLength: 1 maxLength: 200 PaginatedGoogleEndpointDeviceList: type: object properties: pagination: $ref: '#/components/schemas/Pagination' results: type: array items: $ref: '#/components/schemas/GoogleEndpointDevice' autocomplete: $ref: '#/components/schemas/Autocomplete' required: - autocomplete - pagination - results PaginatedTOTPDeviceList: type: object properties: pagination: $ref: '#/components/schemas/Pagination' results: type: array items: $ref: '#/components/schemas/TOTPDevice' autocomplete: $ref: '#/components/schemas/Autocomplete' required: - autocomplete - pagination - results EmailDeviceRequest: type: object description: Serializer for email authenticator devices properties: name: type: string minLength: 1 description: The human-readable name of this device. maxLength: 64 required: - name GoogleEndpointDeviceRequest: type: object description: Serializer for Endpoint authenticator devices properties: pk: type: string format: uuid title: Uuid name: type: string minLength: 1 description: The human-readable name of this device. maxLength: 64 required: - name PaginatedSMSDeviceList: type: object properties: pagination: $ref: '#/components/schemas/Pagination' results: type: array items: $ref: '#/components/schemas/SMSDevice' autocomplete: $ref: '#/components/schemas/Autocomplete' required: - autocomplete - pagination - results Pagination: type: object properties: next: type: number previous: type: number count: type: number current: type: number total_pages: type: number start_index: type: number end_index: type: number required: - count - current - end_index - next - previous - start_index - total_pages PatchedStaticDeviceRequest: type: object description: Serializer for static authenticator devices properties: name: type: string minLength: 1 description: The human-readable name of this device. maxLength: 64 TOTPDevice: type: object description: Serializer for totp authenticator devices properties: name: type: string description: The human-readable name of this device. maxLength: 64 pk: type: integer readOnly: true title: ID user: allOf: - $ref: '#/components/schemas/PartialUser' readOnly: true required: - name - pk - user ValidationError: type: object description: Validation Error properties: non_field_errors: type: array items: type: string code: type: string additionalProperties: {} WebAuthnDevice: type: object description: Serializer for WebAuthn authenticator devices properties: pk: type: integer readOnly: true title: ID name: type: string maxLength: 200 created_on: type: string format: date-time readOnly: true device_type: allOf: - $ref: '#/components/schemas/WebAuthnDeviceType' readOnly: true aaguid: type: string readOnly: true user: allOf: - $ref: '#/components/schemas/PartialUser' readOnly: true required: - aaguid - created_on - device_type - name - pk - user StaticDevice: type: object description: Serializer for static authenticator devices properties: name: type: string description: The human-readable name of this device. maxLength: 64 token_set: type: array items: $ref: '#/components/schemas/StaticDeviceToken' readOnly: true pk: type: integer readOnly: true title: ID user: allOf: - $ref: '#/components/schemas/PartialUser' readOnly: true required: - name - pk - token_set - user UsedByActionEnum: enum: - cascade - cascade_many - set_null - set_default - left_dangling type: string PaginatedWebAuthnDeviceList: type: object properties: pagination: $ref: '#/components/schemas/Pagination' results: type: array items: $ref: '#/components/schemas/WebAuthnDevice' autocomplete: $ref: '#/components/schemas/Autocomplete' required: - autocomplete - pagination - results WebAuthnDeviceRequest: type: object description: Serializer for WebAuthn authenticator devices properties: name: type: string minLength: 1 maxLength: 200 required: - name Autocomplete: type: object additionalProperties: {} StaticDeviceToken: type: object description: Serializer for static device's tokens properties: token: type: string maxLength: 100 required: - token StaticDeviceRequest: type: object description: Serializer for static authenticator devices properties: name: type: string minLength: 1 description: The human-readable name of this device. maxLength: 64 required: - name PatchedGoogleEndpointDeviceRequest: type: object description: Serializer for Endpoint authenticator devices properties: pk: type: string format: uuid title: Uuid name: type: string minLength: 1 description: The human-readable name of this device. maxLength: 64 PatchedSMSDeviceRequest: type: object description: Serializer for sms authenticator devices properties: name: type: string minLength: 1 description: The human-readable name of this device. maxLength: 64 SMSDeviceRequest: type: object description: Serializer for sms authenticator devices properties: name: type: string minLength: 1 description: The human-readable name of this device. maxLength: 64 required: - name PaginatedEmailDeviceList: type: object properties: pagination: $ref: '#/components/schemas/Pagination' results: type: array items: $ref: '#/components/schemas/EmailDevice' autocomplete: $ref: '#/components/schemas/Autocomplete' required: - autocomplete - pagination - results DuoDevice: type: object description: Serializer for Duo authenticator devices properties: pk: type: integer readOnly: true title: ID name: type: string description: The human-readable name of this device. maxLength: 64 user: allOf: - $ref: '#/components/schemas/PartialUser' readOnly: true required: - name - pk - user PatchedTOTPDeviceRequest: type: object description: Serializer for totp authenticator devices properties: name: type: string minLength: 1 description: The human-readable name of this device. maxLength: 64 PartialUser: type: object description: Partial User Serializer, does not include child relations. properties: pk: type: integer readOnly: true title: ID username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 name: type: string description: User's display name. is_active: type: boolean title: Active description: Designates whether this user should be treated as active. Unselect this instead of deleting accounts. last_login: type: - string - 'null' format: date-time email: type: string format: email title: Email address maxLength: 254 attributes: type: object additionalProperties: {} uid: type: string readOnly: true required: - name - pk - uid - username EmailDevice: type: object description: Serializer for email authenticator devices properties: name: type: string description: The human-readable name of this device. maxLength: 64 pk: type: integer readOnly: true title: ID email: type: string format: email readOnly: true user: allOf: - $ref: '#/components/schemas/PartialUser' readOnly: true required: - email - name - pk - user PatchedDuoDeviceRequest: type: object description: Serializer for Duo authenticator devices properties: name: type: string minLength: 1 description: The human-readable name of this device. maxLength: 64 DuoDeviceRequest: type: object description: Serializer for Duo authenticator devices properties: name: type: string minLength: 1 description: The human-readable name of this device. maxLength: 64 required: - name Device: type: object description: Serializer for authenticator devices properties: verbose_name: type: string description: Return object's verbose_name readOnly: true verbose_name_plural: type: string description: Return object's plural verbose_name readOnly: true meta_model_name: type: string description: Return internal model name readOnly: true pk: type: string name: type: string type: type: string description: Get type of device readOnly: true confirmed: type: boolean created: type: string format: date-time readOnly: true last_updated: type: string format: date-time readOnly: true last_used: type: - string - 'null' format: date-time readOnly: true extra_description: type: - string - 'null' description: Get extra description readOnly: true external_id: type: - string - 'null' description: Get external Device ID readOnly: true required: - confirmed - created - external_id - extra_description - last_updated - last_used - meta_model_name - name - pk - type - verbose_name - verbose_name_plural TOTPDeviceRequest: type: object description: Serializer for totp authenticator devices properties: name: type: string minLength: 1 description: The human-readable name of this device. maxLength: 64 required: - name UsedBy: type: object description: A list of all objects referencing the queried object properties: app: type: string model_name: type: string pk: type: string name: type: string action: $ref: '#/components/schemas/UsedByActionEnum' required: - action - app - model_name - name - pk GenericError: type: object description: Generic API Error properties: detail: type: string code: type: string required: - detail SMSDevice: type: object description: Serializer for sms authenticator devices properties: name: type: string description: The human-readable name of this device. maxLength: 64 pk: type: integer readOnly: true title: ID phone_number: type: string readOnly: true user: allOf: - $ref: '#/components/schemas/PartialUser' readOnly: true required: - name - phone_number - pk - user parameters: QueryPaginationOrdering: in: query name: ordering schema: type: string description: Which field to use when ordering the results. QuerySearch: in: query name: search schema: type: string description: A search term. QueryPaginationPage: in: query name: page schema: type: integer description: A page number within the paginated result set. QueryPaginationPageSize: in: query name: page_size schema: type: integer description: Number of results to return per page. QueryName: in: query name: name schema: type: string responses: GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/GenericError' description: '' ValidationErrorResponse: content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: '' securitySchemes: authentik: type: http scheme: bearer authentik_device_auth: type: http scheme: bearer+agent authentik_device_enroll: type: http scheme: bearer authentik_device_federation: type: http scheme: bearer