AuthenticatorsApi.md

\AuthenticatorsApi

All URIs are relative to http://localhost/api/v3

Method	HTTP request	Description
authenticators_admin_all_list	GET /authenticators/admin/all/
authenticators_admin_duo_create	POST /authenticators/admin/duo/
authenticators_admin_duo_destroy	DELETE /authenticators/admin/duo/{id}/
authenticators_admin_duo_list	GET /authenticators/admin/duo/
authenticators_admin_duo_partial_update	PATCH /authenticators/admin/duo/{id}/
authenticators_admin_duo_retrieve	GET /authenticators/admin/duo/{id}/
authenticators_admin_duo_update	PUT /authenticators/admin/duo/{id}/
authenticators_admin_endpoint_create	POST /authenticators/admin/endpoint/
authenticators_admin_endpoint_destroy	DELETE /authenticators/admin/endpoint/{uuid}/
authenticators_admin_endpoint_list	GET /authenticators/admin/endpoint/
authenticators_admin_endpoint_partial_update	PATCH /authenticators/admin/endpoint/{uuid}/
authenticators_admin_endpoint_retrieve	GET /authenticators/admin/endpoint/{uuid}/
authenticators_admin_endpoint_update	PUT /authenticators/admin/endpoint/{uuid}/
authenticators_admin_sms_create	POST /authenticators/admin/sms/
authenticators_admin_sms_destroy	DELETE /authenticators/admin/sms/{id}/
authenticators_admin_sms_list	GET /authenticators/admin/sms/
authenticators_admin_sms_partial_update	PATCH /authenticators/admin/sms/{id}/
authenticators_admin_sms_retrieve	GET /authenticators/admin/sms/{id}/
authenticators_admin_sms_update	PUT /authenticators/admin/sms/{id}/
authenticators_admin_static_create	POST /authenticators/admin/static/
authenticators_admin_static_destroy	DELETE /authenticators/admin/static/{id}/
authenticators_admin_static_list	GET /authenticators/admin/static/
authenticators_admin_static_partial_update	PATCH /authenticators/admin/static/{id}/
authenticators_admin_static_retrieve	GET /authenticators/admin/static/{id}/
authenticators_admin_static_update	PUT /authenticators/admin/static/{id}/
authenticators_admin_totp_create	POST /authenticators/admin/totp/
authenticators_admin_totp_destroy	DELETE /authenticators/admin/totp/{id}/
authenticators_admin_totp_list	GET /authenticators/admin/totp/
authenticators_admin_totp_partial_update	PATCH /authenticators/admin/totp/{id}/
authenticators_admin_totp_retrieve	GET /authenticators/admin/totp/{id}/
authenticators_admin_totp_update	PUT /authenticators/admin/totp/{id}/
authenticators_admin_webauthn_create	POST /authenticators/admin/webauthn/
authenticators_admin_webauthn_destroy	DELETE /authenticators/admin/webauthn/{id}/
authenticators_admin_webauthn_list	GET /authenticators/admin/webauthn/
authenticators_admin_webauthn_partial_update	PATCH /authenticators/admin/webauthn/{id}/
authenticators_admin_webauthn_retrieve	GET /authenticators/admin/webauthn/{id}/
authenticators_admin_webauthn_update	PUT /authenticators/admin/webauthn/{id}/
authenticators_all_list	GET /authenticators/all/
authenticators_duo_destroy	DELETE /authenticators/duo/{id}/
authenticators_duo_list	GET /authenticators/duo/
authenticators_duo_partial_update	PATCH /authenticators/duo/{id}/
authenticators_duo_retrieve	GET /authenticators/duo/{id}/
authenticators_duo_update	PUT /authenticators/duo/{id}/
authenticators_duo_used_by_list	GET /authenticators/duo/{id}/used_by/
authenticators_endpoint_list	GET /authenticators/endpoint/
authenticators_endpoint_retrieve	GET /authenticators/endpoint/{uuid}/
authenticators_endpoint_used_by_list	GET /authenticators/endpoint/{uuid}/used_by/
authenticators_sms_destroy	DELETE /authenticators/sms/{id}/
authenticators_sms_list	GET /authenticators/sms/
authenticators_sms_partial_update	PATCH /authenticators/sms/{id}/
authenticators_sms_retrieve	GET /authenticators/sms/{id}/
authenticators_sms_update	PUT /authenticators/sms/{id}/
authenticators_sms_used_by_list	GET /authenticators/sms/{id}/used_by/
authenticators_static_destroy	DELETE /authenticators/static/{id}/
authenticators_static_list	GET /authenticators/static/
authenticators_static_partial_update	PATCH /authenticators/static/{id}/
authenticators_static_retrieve	GET /authenticators/static/{id}/
authenticators_static_update	PUT /authenticators/static/{id}/
authenticators_static_used_by_list	GET /authenticators/static/{id}/used_by/
authenticators_totp_destroy	DELETE /authenticators/totp/{id}/
authenticators_totp_list	GET /authenticators/totp/
authenticators_totp_partial_update	PATCH /authenticators/totp/{id}/
authenticators_totp_retrieve	GET /authenticators/totp/{id}/
authenticators_totp_update	PUT /authenticators/totp/{id}/
authenticators_totp_used_by_list	GET /authenticators/totp/{id}/used_by/
authenticators_webauthn_destroy	DELETE /authenticators/webauthn/{id}/
authenticators_webauthn_list	GET /authenticators/webauthn/
authenticators_webauthn_partial_update	PATCH /authenticators/webauthn/{id}/
authenticators_webauthn_retrieve	GET /authenticators/webauthn/{id}/
authenticators_webauthn_update	PUT /authenticators/webauthn/{id}/
authenticators_webauthn_used_by_list	GET /authenticators/webauthn/{id}/used_by/

authenticators_admin_all_list

Vecmodels::Device authenticators_admin_all_list(user)

Get all devices for current user

Parameters

Name	Type	Description	Required	Notes
user	Option<i32>

Return type

Vecmodels::Device

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_duo_create

models::DuoDevice authenticators_admin_duo_create(duo_device_request)

Viewset for Duo authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
duo_device_request	DuoDeviceRequest		[required]

Return type

models::DuoDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_duo_destroy

authenticators_admin_duo_destroy(id)

Viewset for Duo authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Duo Device.	[required]

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_duo_list

models::PaginatedDuoDeviceList authenticators_admin_duo_list(name, ordering, page, page_size, search)

Viewset for Duo authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
name	Option<String>
ordering	Option<String>	Which field to use when ordering the results.
page	Option<i32>	A page number within the paginated result set.
page_size	Option<i32>	Number of results to return per page.
search	Option<String>	A search term.

Return type

models::PaginatedDuoDeviceList

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_duo_partial_update

models::DuoDevice authenticators_admin_duo_partial_update(id, patched_duo_device_request)

Viewset for Duo authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Duo Device.	[required]
patched_duo_device_request	Option<PatchedDuoDeviceRequest>

Return type

models::DuoDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_duo_retrieve

models::DuoDevice authenticators_admin_duo_retrieve(id)

Viewset for Duo authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Duo Device.	[required]

Return type

models::DuoDevice

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_duo_update

models::DuoDevice authenticators_admin_duo_update(id, duo_device_request)

Viewset for Duo authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Duo Device.	[required]
duo_device_request	DuoDeviceRequest		[required]

Return type

models::DuoDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_endpoint_create

models::EndpointDevice authenticators_admin_endpoint_create(endpoint_device_request)

Viewset for Endpoint authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
endpoint_device_request	EndpointDeviceRequest		[required]

Return type

models::EndpointDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_endpoint_destroy

authenticators_admin_endpoint_destroy(uuid)

Viewset for Endpoint authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
uuid	uuid::Uuid	A UUID string identifying this Endpoint Device.	[required]

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_endpoint_list

models::PaginatedEndpointDeviceList authenticators_admin_endpoint_list(name, ordering, page, page_size, search)

Viewset for Endpoint authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
name	Option<String>
ordering	Option<String>	Which field to use when ordering the results.
page	Option<i32>	A page number within the paginated result set.
page_size	Option<i32>	Number of results to return per page.
search	Option<String>	A search term.

Return type

models::PaginatedEndpointDeviceList

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_endpoint_partial_update

models::EndpointDevice authenticators_admin_endpoint_partial_update(uuid, patched_endpoint_device_request)

Viewset for Endpoint authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
uuid	uuid::Uuid	A UUID string identifying this Endpoint Device.	[required]
patched_endpoint_device_request	Option<PatchedEndpointDeviceRequest>

Return type

models::EndpointDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_endpoint_retrieve

models::EndpointDevice authenticators_admin_endpoint_retrieve(uuid)

Viewset for Endpoint authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
uuid	uuid::Uuid	A UUID string identifying this Endpoint Device.	[required]

Return type

models::EndpointDevice

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_endpoint_update

models::EndpointDevice authenticators_admin_endpoint_update(uuid, endpoint_device_request)

Viewset for Endpoint authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
uuid	uuid::Uuid	A UUID string identifying this Endpoint Device.	[required]
endpoint_device_request	EndpointDeviceRequest		[required]

Return type

models::EndpointDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_sms_create

models::SmsDevice authenticators_admin_sms_create(sms_device_request)

Viewset for sms authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
sms_device_request	SmsDeviceRequest		[required]

Return type

models::SmsDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_sms_destroy

authenticators_admin_sms_destroy(id)

Viewset for sms authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this SMS Device.	[required]

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_sms_list

models::PaginatedSmsDeviceList authenticators_admin_sms_list(name, ordering, page, page_size, search)

Viewset for sms authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
name	Option<String>
ordering	Option<String>	Which field to use when ordering the results.
page	Option<i32>	A page number within the paginated result set.
page_size	Option<i32>	Number of results to return per page.
search	Option<String>	A search term.

Return type

models::PaginatedSmsDeviceList

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_sms_partial_update

models::SmsDevice authenticators_admin_sms_partial_update(id, patched_sms_device_request)

Viewset for sms authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this SMS Device.	[required]
patched_sms_device_request	Option<PatchedSmsDeviceRequest>

Return type

models::SmsDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_sms_retrieve

models::SmsDevice authenticators_admin_sms_retrieve(id)

Viewset for sms authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this SMS Device.	[required]

Return type

models::SmsDevice

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_sms_update

models::SmsDevice authenticators_admin_sms_update(id, sms_device_request)

Viewset for sms authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this SMS Device.	[required]
sms_device_request	SmsDeviceRequest		[required]

Return type

models::SmsDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_static_create

models::StaticDevice authenticators_admin_static_create(static_device_request)

Viewset for static authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
static_device_request	StaticDeviceRequest		[required]

Return type

models::StaticDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_static_destroy

authenticators_admin_static_destroy(id)

Viewset for static authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Static Device.	[required]

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_static_list

models::PaginatedStaticDeviceList authenticators_admin_static_list(name, ordering, page, page_size, search)

Viewset for static authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
name	Option<String>
ordering	Option<String>	Which field to use when ordering the results.
page	Option<i32>	A page number within the paginated result set.
page_size	Option<i32>	Number of results to return per page.
search	Option<String>	A search term.

Return type

models::PaginatedStaticDeviceList

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_static_partial_update

models::StaticDevice authenticators_admin_static_partial_update(id, patched_static_device_request)

Viewset for static authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Static Device.	[required]
patched_static_device_request	Option<PatchedStaticDeviceRequest>

Return type

models::StaticDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_static_retrieve

models::StaticDevice authenticators_admin_static_retrieve(id)

Viewset for static authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Static Device.	[required]

Return type

models::StaticDevice

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_static_update

models::StaticDevice authenticators_admin_static_update(id, static_device_request)

Viewset for static authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Static Device.	[required]
static_device_request	StaticDeviceRequest		[required]

Return type

models::StaticDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_totp_create

models::TotpDevice authenticators_admin_totp_create(totp_device_request)

Viewset for totp authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
totp_device_request	TotpDeviceRequest		[required]

Return type

models::TotpDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_totp_destroy

authenticators_admin_totp_destroy(id)

Viewset for totp authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this TOTP Device.	[required]

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_totp_list

models::PaginatedTotpDeviceList authenticators_admin_totp_list(name, ordering, page, page_size, search)

Viewset for totp authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
name	Option<String>
ordering	Option<String>	Which field to use when ordering the results.
page	Option<i32>	A page number within the paginated result set.
page_size	Option<i32>	Number of results to return per page.
search	Option<String>	A search term.

Return type

models::PaginatedTotpDeviceList

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_totp_partial_update

models::TotpDevice authenticators_admin_totp_partial_update(id, patched_totp_device_request)

Viewset for totp authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this TOTP Device.	[required]
patched_totp_device_request	Option<PatchedTotpDeviceRequest>

Return type

models::TotpDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_totp_retrieve

models::TotpDevice authenticators_admin_totp_retrieve(id)

Viewset for totp authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this TOTP Device.	[required]

Return type

models::TotpDevice

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_totp_update

models::TotpDevice authenticators_admin_totp_update(id, totp_device_request)

Viewset for totp authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this TOTP Device.	[required]
totp_device_request	TotpDeviceRequest		[required]

Return type

models::TotpDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_webauthn_create

models::WebAuthnDevice authenticators_admin_webauthn_create(web_authn_device_request)

Viewset for WebAuthn authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
web_authn_device_request	WebAuthnDeviceRequest		[required]

Return type

models::WebAuthnDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_webauthn_destroy

authenticators_admin_webauthn_destroy(id)

Viewset for WebAuthn authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this WebAuthn Device.	[required]

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_webauthn_list

models::PaginatedWebAuthnDeviceList authenticators_admin_webauthn_list(name, ordering, page, page_size, search)

Viewset for WebAuthn authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
name	Option<String>
ordering	Option<String>	Which field to use when ordering the results.
page	Option<i32>	A page number within the paginated result set.
page_size	Option<i32>	Number of results to return per page.
search	Option<String>	A search term.

Return type

models::PaginatedWebAuthnDeviceList

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_webauthn_partial_update

models::WebAuthnDevice authenticators_admin_webauthn_partial_update(id, patched_web_authn_device_request)

Viewset for WebAuthn authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this WebAuthn Device.	[required]
patched_web_authn_device_request	Option<PatchedWebAuthnDeviceRequest>

Return type

models::WebAuthnDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_webauthn_retrieve

models::WebAuthnDevice authenticators_admin_webauthn_retrieve(id)

Viewset for WebAuthn authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this WebAuthn Device.	[required]

Return type

models::WebAuthnDevice

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_admin_webauthn_update

models::WebAuthnDevice authenticators_admin_webauthn_update(id, web_authn_device_request)

Viewset for WebAuthn authenticator devices (for admins)

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this WebAuthn Device.	[required]
web_authn_device_request	WebAuthnDeviceRequest		[required]

Return type

models::WebAuthnDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_all_list

Vecmodels::Device authenticators_all_list()

Get all devices for current user

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::Device

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_duo_destroy

authenticators_duo_destroy(id)

Viewset for Duo authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Duo Device.	[required]

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_duo_list

models::PaginatedDuoDeviceList authenticators_duo_list(name, ordering, page, page_size, search)

Viewset for Duo authenticator devices

Parameters

Name	Type	Description	Required	Notes
name	Option<String>
ordering	Option<String>	Which field to use when ordering the results.
page	Option<i32>	A page number within the paginated result set.
page_size	Option<i32>	Number of results to return per page.
search	Option<String>	A search term.

Return type

models::PaginatedDuoDeviceList

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_duo_partial_update

models::DuoDevice authenticators_duo_partial_update(id, patched_duo_device_request)

Viewset for Duo authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Duo Device.	[required]
patched_duo_device_request	Option<PatchedDuoDeviceRequest>

Return type

models::DuoDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_duo_retrieve

models::DuoDevice authenticators_duo_retrieve(id)

Viewset for Duo authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Duo Device.	[required]

Return type

models::DuoDevice

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_duo_update

models::DuoDevice authenticators_duo_update(id, duo_device_request)

Viewset for Duo authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Duo Device.	[required]
duo_device_request	DuoDeviceRequest		[required]

Return type

models::DuoDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_duo_used_by_list

Vecmodels::UsedBy authenticators_duo_used_by_list(id)

Get a list of all objects that use this object

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Duo Device.	[required]

Return type

Vecmodels::UsedBy

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_endpoint_list

models::PaginatedEndpointDeviceList authenticators_endpoint_list(name, ordering, page, page_size, search)

Viewset for Endpoint authenticator devices

Parameters

Name	Type	Description	Required	Notes
name	Option<String>
ordering	Option<String>	Which field to use when ordering the results.
page	Option<i32>	A page number within the paginated result set.
page_size	Option<i32>	Number of results to return per page.
search	Option<String>	A search term.

Return type

models::PaginatedEndpointDeviceList

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_endpoint_retrieve

models::EndpointDevice authenticators_endpoint_retrieve(uuid)

Viewset for Endpoint authenticator devices

Parameters

Name	Type	Description	Required	Notes
uuid	uuid::Uuid	A UUID string identifying this Endpoint Device.	[required]

Return type

models::EndpointDevice

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_endpoint_used_by_list

Vecmodels::UsedBy authenticators_endpoint_used_by_list(uuid)

Get a list of all objects that use this object

Parameters

Name	Type	Description	Required	Notes
uuid	uuid::Uuid	A UUID string identifying this Endpoint Device.	[required]

Return type

Vecmodels::UsedBy

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_sms_destroy

authenticators_sms_destroy(id)

Viewset for sms authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this SMS Device.	[required]

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_sms_list

models::PaginatedSmsDeviceList authenticators_sms_list(name, ordering, page, page_size, search)

Viewset for sms authenticator devices

Parameters

Name	Type	Description	Required	Notes
name	Option<String>
ordering	Option<String>	Which field to use when ordering the results.
page	Option<i32>	A page number within the paginated result set.
page_size	Option<i32>	Number of results to return per page.
search	Option<String>	A search term.

Return type

models::PaginatedSmsDeviceList

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_sms_partial_update

models::SmsDevice authenticators_sms_partial_update(id, patched_sms_device_request)

Viewset for sms authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this SMS Device.	[required]
patched_sms_device_request	Option<PatchedSmsDeviceRequest>

Return type

models::SmsDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_sms_retrieve

models::SmsDevice authenticators_sms_retrieve(id)

Viewset for sms authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this SMS Device.	[required]

Return type

models::SmsDevice

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_sms_update

models::SmsDevice authenticators_sms_update(id, sms_device_request)

Viewset for sms authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this SMS Device.	[required]
sms_device_request	SmsDeviceRequest		[required]

Return type

models::SmsDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_sms_used_by_list

Vecmodels::UsedBy authenticators_sms_used_by_list(id)

Get a list of all objects that use this object

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this SMS Device.	[required]

Return type

Vecmodels::UsedBy

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_static_destroy

authenticators_static_destroy(id)

Viewset for static authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Static Device.	[required]

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_static_list

models::PaginatedStaticDeviceList authenticators_static_list(name, ordering, page, page_size, search)

Viewset for static authenticator devices

Parameters

Name	Type	Description	Required	Notes
name	Option<String>
ordering	Option<String>	Which field to use when ordering the results.
page	Option<i32>	A page number within the paginated result set.
page_size	Option<i32>	Number of results to return per page.
search	Option<String>	A search term.

Return type

models::PaginatedStaticDeviceList

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_static_partial_update

models::StaticDevice authenticators_static_partial_update(id, patched_static_device_request)

Viewset for static authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Static Device.	[required]
patched_static_device_request	Option<PatchedStaticDeviceRequest>

Return type

models::StaticDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_static_retrieve

models::StaticDevice authenticators_static_retrieve(id)

Viewset for static authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Static Device.	[required]

Return type

models::StaticDevice

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_static_update

models::StaticDevice authenticators_static_update(id, static_device_request)

Viewset for static authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Static Device.	[required]
static_device_request	StaticDeviceRequest		[required]

Return type

models::StaticDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_static_used_by_list

Vecmodels::UsedBy authenticators_static_used_by_list(id)

Get a list of all objects that use this object

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this Static Device.	[required]

Return type

Vecmodels::UsedBy

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_totp_destroy

authenticators_totp_destroy(id)

Viewset for totp authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this TOTP Device.	[required]

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_totp_list

models::PaginatedTotpDeviceList authenticators_totp_list(name, ordering, page, page_size, search)

Viewset for totp authenticator devices

Parameters

Name	Type	Description	Required	Notes
name	Option<String>
ordering	Option<String>	Which field to use when ordering the results.
page	Option<i32>	A page number within the paginated result set.
page_size	Option<i32>	Number of results to return per page.
search	Option<String>	A search term.

Return type

models::PaginatedTotpDeviceList

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_totp_partial_update

models::TotpDevice authenticators_totp_partial_update(id, patched_totp_device_request)

Viewset for totp authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this TOTP Device.	[required]
patched_totp_device_request	Option<PatchedTotpDeviceRequest>

Return type

models::TotpDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_totp_retrieve

models::TotpDevice authenticators_totp_retrieve(id)

Viewset for totp authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this TOTP Device.	[required]

Return type

models::TotpDevice

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_totp_update

models::TotpDevice authenticators_totp_update(id, totp_device_request)

Viewset for totp authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this TOTP Device.	[required]
totp_device_request	TotpDeviceRequest		[required]

Return type

models::TotpDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_totp_used_by_list

Vecmodels::UsedBy authenticators_totp_used_by_list(id)

Get a list of all objects that use this object

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this TOTP Device.	[required]

Return type

Vecmodels::UsedBy

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_webauthn_destroy

authenticators_webauthn_destroy(id)

Viewset for WebAuthn authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this WebAuthn Device.	[required]

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_webauthn_list

models::PaginatedWebAuthnDeviceList authenticators_webauthn_list(name, ordering, page, page_size, search)

Viewset for WebAuthn authenticator devices

Parameters

Name	Type	Description	Required	Notes
name	Option<String>
ordering	Option<String>	Which field to use when ordering the results.
page	Option<i32>	A page number within the paginated result set.
page_size	Option<i32>	Number of results to return per page.
search	Option<String>	A search term.

Return type

models::PaginatedWebAuthnDeviceList

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_webauthn_partial_update

models::WebAuthnDevice authenticators_webauthn_partial_update(id, patched_web_authn_device_request)

Viewset for WebAuthn authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this WebAuthn Device.	[required]
patched_web_authn_device_request	Option<PatchedWebAuthnDeviceRequest>

Return type

models::WebAuthnDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_webauthn_retrieve

models::WebAuthnDevice authenticators_webauthn_retrieve(id)

Viewset for WebAuthn authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this WebAuthn Device.	[required]

Return type

models::WebAuthnDevice

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_webauthn_update

models::WebAuthnDevice authenticators_webauthn_update(id, web_authn_device_request)

Viewset for WebAuthn authenticator devices

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this WebAuthn Device.	[required]
web_authn_device_request	WebAuthnDeviceRequest		[required]

Return type

models::WebAuthnDevice

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

authenticators_webauthn_used_by_list

Vecmodels::UsedBy authenticators_webauthn_used_by_list(id)

Get a list of all objects that use this object

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this WebAuthn Device.	[required]

Return type

Vecmodels::UsedBy

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]