CoreApi.md

\CoreApi

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

Method	HTTP request	Description
core_application_entitlements_create	POST /core/application_entitlements/
core_application_entitlements_destroy	DELETE /core/application_entitlements/{pbm_uuid}/
core_application_entitlements_list	GET /core/application_entitlements/
core_application_entitlements_partial_update	PATCH /core/application_entitlements/{pbm_uuid}/
core_application_entitlements_retrieve	GET /core/application_entitlements/{pbm_uuid}/
core_application_entitlements_update	PUT /core/application_entitlements/{pbm_uuid}/
core_application_entitlements_used_by_list	GET /core/application_entitlements/{pbm_uuid}/used_by/
core_applications_check_access_retrieve	GET /core/applications/{slug}/check_access/
core_applications_create	POST /core/applications/
core_applications_destroy	DELETE /core/applications/{slug}/
core_applications_list	GET /core/applications/
core_applications_metrics_list	GET /core/applications/{slug}/metrics/
core_applications_partial_update	PATCH /core/applications/{slug}/
core_applications_retrieve	GET /core/applications/{slug}/
core_applications_set_icon_create	POST /core/applications/{slug}/set_icon/
core_applications_set_icon_url_create	POST /core/applications/{slug}/set_icon_url/
core_applications_update	PUT /core/applications/{slug}/
core_applications_used_by_list	GET /core/applications/{slug}/used_by/
core_authenticated_sessions_destroy	DELETE /core/authenticated_sessions/{uuid}/
core_authenticated_sessions_list	GET /core/authenticated_sessions/
core_authenticated_sessions_retrieve	GET /core/authenticated_sessions/{uuid}/
core_authenticated_sessions_used_by_list	GET /core/authenticated_sessions/{uuid}/used_by/
core_brands_create	POST /core/brands/
core_brands_current_retrieve	GET /core/brands/current/
core_brands_destroy	DELETE /core/brands/{brand_uuid}/
core_brands_list	GET /core/brands/
core_brands_partial_update	PATCH /core/brands/{brand_uuid}/
core_brands_retrieve	GET /core/brands/{brand_uuid}/
core_brands_update	PUT /core/brands/{brand_uuid}/
core_brands_used_by_list	GET /core/brands/{brand_uuid}/used_by/
core_groups_add_user_create	POST /core/groups/{group_uuid}/add_user/
core_groups_create	POST /core/groups/
core_groups_destroy	DELETE /core/groups/{group_uuid}/
core_groups_list	GET /core/groups/
core_groups_partial_update	PATCH /core/groups/{group_uuid}/
core_groups_remove_user_create	POST /core/groups/{group_uuid}/remove_user/
core_groups_retrieve	GET /core/groups/{group_uuid}/
core_groups_update	PUT /core/groups/{group_uuid}/
core_groups_used_by_list	GET /core/groups/{group_uuid}/used_by/
core_tokens_create	POST /core/tokens/
core_tokens_destroy	DELETE /core/tokens/{identifier}/
core_tokens_list	GET /core/tokens/
core_tokens_partial_update	PATCH /core/tokens/{identifier}/
core_tokens_retrieve	GET /core/tokens/{identifier}/
core_tokens_set_key_create	POST /core/tokens/{identifier}/set_key/
core_tokens_update	PUT /core/tokens/{identifier}/
core_tokens_used_by_list	GET /core/tokens/{identifier}/used_by/
core_tokens_view_key_retrieve	GET /core/tokens/{identifier}/view_key/
core_transactional_applications_update	PUT /core/transactional/applications/
core_user_consent_destroy	DELETE /core/user_consent/{id}/
core_user_consent_list	GET /core/user_consent/
core_user_consent_retrieve	GET /core/user_consent/{id}/
core_user_consent_used_by_list	GET /core/user_consent/{id}/used_by/
core_users_create	POST /core/users/
core_users_destroy	DELETE /core/users/{id}/
core_users_impersonate_create	POST /core/users/{id}/impersonate/
core_users_impersonate_end_retrieve	GET /core/users/impersonate_end/
core_users_list	GET /core/users/
core_users_me_retrieve	GET /core/users/me/
core_users_metrics_retrieve	GET /core/users/{id}/metrics/
core_users_partial_update	PATCH /core/users/{id}/
core_users_paths_retrieve	GET /core/users/paths/
core_users_recovery_create	POST /core/users/{id}/recovery/
core_users_recovery_email_create	POST /core/users/{id}/recovery_email/
core_users_retrieve	GET /core/users/{id}/
core_users_service_account_create	POST /core/users/service_account/
core_users_set_password_create	POST /core/users/{id}/set_password/
core_users_update	PUT /core/users/{id}/
core_users_used_by_list	GET /core/users/{id}/used_by/

core_application_entitlements_create

models::ApplicationEntitlement core_application_entitlements_create(application_entitlement_request)

ApplicationEntitlement Viewset

Parameters

Name	Type	Description	Required	Notes
application_entitlement_request	ApplicationEntitlementRequest		[required]

Return type

models::ApplicationEntitlement

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]

core_application_entitlements_destroy

core_application_entitlements_destroy(pbm_uuid)

ApplicationEntitlement Viewset

Parameters

Name	Type	Description	Required	Notes
pbm_uuid	uuid::Uuid	A UUID string identifying this Application Entitlement.	[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]

core_application_entitlements_list

models::PaginatedApplicationEntitlementList core_application_entitlements_list(app, name, ordering, page, page_size, pbm_uuid, search)

ApplicationEntitlement Viewset

Parameters

Name	Type	Description	Required	Notes
app	Option<uuid::Uuid>
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.
pbm_uuid	Option<uuid::Uuid>
search	Option<String>	A search term.

Return type

models::PaginatedApplicationEntitlementList

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]

core_application_entitlements_partial_update

models::ApplicationEntitlement core_application_entitlements_partial_update(pbm_uuid, patched_application_entitlement_request)

ApplicationEntitlement Viewset

Parameters

Name	Type	Description	Required	Notes
pbm_uuid	uuid::Uuid	A UUID string identifying this Application Entitlement.	[required]
patched_application_entitlement_request	Option<PatchedApplicationEntitlementRequest>

Return type

models::ApplicationEntitlement

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]

core_application_entitlements_retrieve

models::ApplicationEntitlement core_application_entitlements_retrieve(pbm_uuid)

ApplicationEntitlement Viewset

Parameters

Name	Type	Description	Required	Notes
pbm_uuid	uuid::Uuid	A UUID string identifying this Application Entitlement.	[required]

Return type

models::ApplicationEntitlement

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]

core_application_entitlements_update

models::ApplicationEntitlement core_application_entitlements_update(pbm_uuid, application_entitlement_request)

ApplicationEntitlement Viewset

Parameters

Name	Type	Description	Required	Notes
pbm_uuid	uuid::Uuid	A UUID string identifying this Application Entitlement.	[required]
application_entitlement_request	ApplicationEntitlementRequest		[required]

Return type

models::ApplicationEntitlement

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]

core_application_entitlements_used_by_list

Vecmodels::UsedBy core_application_entitlements_used_by_list(pbm_uuid)

Get a list of all objects that use this object

Parameters

Name	Type	Description	Required	Notes
pbm_uuid	uuid::Uuid	A UUID string identifying this Application Entitlement.	[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]

core_applications_check_access_retrieve

models::PolicyTestResult core_applications_check_access_retrieve(slug, for_user)

Check access to a single application by slug

Parameters

Name	Type	Description	Required	Notes
slug	String		[required]
for_user	Option<i32>

Return type

models::PolicyTestResult

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]

core_applications_create

models::Application core_applications_create(application_request)

Application Viewset

Parameters

Name	Type	Description	Required	Notes
application_request	ApplicationRequest		[required]

Return type

models::Application

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]

core_applications_destroy

core_applications_destroy(slug)

Application Viewset

Parameters

Name	Type	Description	Required	Notes
slug	String		[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]

core_applications_list

models::PaginatedApplicationList core_applications_list(for_user, group, meta_description, meta_launch_url, meta_publisher, name, only_with_launch_url, ordering, page, page_size, search, slug, superuser_full_list)

Custom list method that checks Policy based access instead of guardian

Parameters

Name	Type	Description	Required	Notes
for_user	Option<i32>
group	Option<String>
meta_description	Option<String>
meta_launch_url	Option<String>
meta_publisher	Option<String>
name	Option<String>
only_with_launch_url	Option<bool>
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.
slug	Option<String>
superuser_full_list	Option<bool>

Return type

models::PaginatedApplicationList

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]

core_applications_metrics_list

Vecmodels::Coordinate core_applications_metrics_list(slug)

Metrics for application logins

Parameters

Name	Type	Description	Required	Notes
slug	String		[required]

Return type

Vecmodels::Coordinate

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]

core_applications_partial_update

models::Application core_applications_partial_update(slug, patched_application_request)

Application Viewset

Parameters

Name	Type	Description	Required	Notes
slug	String		[required]
patched_application_request	Option<PatchedApplicationRequest>

Return type

models::Application

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]

core_applications_retrieve

models::Application core_applications_retrieve(slug)

Application Viewset

Parameters

Name	Type	Description	Required	Notes
slug	String		[required]

Return type

models::Application

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]

core_applications_set_icon_create

core_applications_set_icon_create(slug, file, clear)

Set application icon

Parameters

Name	Type	Description	Required	Notes
slug	String		[required]
file	Option<std::path::PathBuf>
clear	Option<bool>			[default to false]

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

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

core_applications_set_icon_url_create

core_applications_set_icon_url_create(slug, file_path_request)

Set application icon (as URL)

Parameters

Name	Type	Description	Required	Notes
slug	String		[required]
file_path_request	FilePathRequest		[required]

Return type

(empty response body)

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]

core_applications_update

models::Application core_applications_update(slug, application_request)

Application Viewset

Parameters

Name	Type	Description	Required	Notes
slug	String		[required]
application_request	ApplicationRequest		[required]

Return type

models::Application

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]

core_applications_used_by_list

Vecmodels::UsedBy core_applications_used_by_list(slug)

Get a list of all objects that use this object

Parameters

Name	Type	Description	Required	Notes
slug	String		[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]

core_authenticated_sessions_destroy

core_authenticated_sessions_destroy(uuid)

AuthenticatedSession Viewset

Parameters

Name	Type	Description	Required	Notes
uuid	uuid::Uuid	A UUID string identifying this Authenticated Session.	[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]

core_authenticated_sessions_list

models::PaginatedAuthenticatedSessionList core_authenticated_sessions_list(last_ip, last_user_agent, ordering, page, page_size, search, user__username)

AuthenticatedSession Viewset

Parameters

Name	Type	Description	Required	Notes
last_ip	Option<String>
last_user_agent	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.
user__username	Option<String>

Return type

models::PaginatedAuthenticatedSessionList

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]

core_authenticated_sessions_retrieve

models::AuthenticatedSession core_authenticated_sessions_retrieve(uuid)

AuthenticatedSession Viewset

Parameters

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

Return type

models::AuthenticatedSession

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]

core_authenticated_sessions_used_by_list

Vecmodels::UsedBy core_authenticated_sessions_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 Authenticated Session.	[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]

core_brands_create

models::Brand core_brands_create(brand_request)

Brand Viewset

Parameters

Name	Type	Description	Required	Notes
brand_request	BrandRequest		[required]

Return type

models::Brand

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]

core_brands_current_retrieve

models::CurrentBrand core_brands_current_retrieve()

Get current brand

Parameters

This endpoint does not need any parameter.

Return type

models::CurrentBrand

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]

core_brands_destroy

core_brands_destroy(brand_uuid)

Brand Viewset

Parameters

Name	Type	Description	Required	Notes
brand_uuid	uuid::Uuid	A UUID string identifying this Brand.	[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]

core_brands_list

models::PaginatedBrandList core_brands_list(brand_uuid, branding_favicon, branding_logo, branding_title, default, domain, flow_authentication, flow_device_code, flow_invalidation, flow_recovery, flow_unenrollment, flow_user_settings, ordering, page, page_size, search, web_certificate)

Brand Viewset

Parameters

Name	Type	Description	Required	Notes
brand_uuid	Option<uuid::Uuid>
branding_favicon	Option<String>
branding_logo	Option<String>
branding_title	Option<String>
default	Option<bool>
domain	Option<String>
flow_authentication	Option<uuid::Uuid>
flow_device_code	Option<uuid::Uuid>
flow_invalidation	Option<uuid::Uuid>
flow_recovery	Option<uuid::Uuid>
flow_unenrollment	Option<uuid::Uuid>
flow_user_settings	Option<uuid::Uuid>
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.
web_certificate	Option<uuid::Uuid>

Return type

models::PaginatedBrandList

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]

core_brands_partial_update

models::Brand core_brands_partial_update(brand_uuid, patched_brand_request)

Brand Viewset

Parameters

Name	Type	Description	Required	Notes
brand_uuid	uuid::Uuid	A UUID string identifying this Brand.	[required]
patched_brand_request	Option<PatchedBrandRequest>

Return type

models::Brand

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]

core_brands_retrieve

models::Brand core_brands_retrieve(brand_uuid)

Brand Viewset

Parameters

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

Return type

models::Brand

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]

core_brands_update

models::Brand core_brands_update(brand_uuid, brand_request)

Brand Viewset

Parameters

Name	Type	Description	Required	Notes
brand_uuid	uuid::Uuid	A UUID string identifying this Brand.	[required]
brand_request	BrandRequest		[required]

Return type

models::Brand

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]

core_brands_used_by_list

Vecmodels::UsedBy core_brands_used_by_list(brand_uuid)

Get a list of all objects that use this object

Parameters

Name	Type	Description	Required	Notes
brand_uuid	uuid::Uuid	A UUID string identifying this Brand.	[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]

core_groups_add_user_create

core_groups_add_user_create(group_uuid, user_account_request)

Add user to group

Parameters

Name	Type	Description	Required	Notes
group_uuid	uuid::Uuid	A UUID string identifying this Group.	[required]
user_account_request	UserAccountRequest		[required]

Return type

(empty response body)

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]

core_groups_create

models::Group core_groups_create(group_request)

Group Viewset

Parameters

Name	Type	Description	Required	Notes
group_request	GroupRequest		[required]

Return type

models::Group

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]

core_groups_destroy

core_groups_destroy(group_uuid)

Group Viewset

Parameters

Name	Type	Description	Required	Notes
group_uuid	uuid::Uuid	A UUID string identifying this Group.	[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]

core_groups_list

models::PaginatedGroupList core_groups_list(attributes, include_users, is_superuser, members_by_pk, members_by_username, name, ordering, page, page_size, search)

Group Viewset

Parameters

Name	Type	Description	Required	Notes
attributes	Option<String>	Attributes
include_users	Option<bool>			[default to true]
is_superuser	Option<bool>
members_by_pk	Option<Vec>
members_by_username	Option<Vec>	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
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::PaginatedGroupList

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]

core_groups_partial_update

models::Group core_groups_partial_update(group_uuid, patched_group_request)

Group Viewset

Parameters

Name	Type	Description	Required	Notes
group_uuid	uuid::Uuid	A UUID string identifying this Group.	[required]
patched_group_request	Option<PatchedGroupRequest>

Return type

models::Group

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]

core_groups_remove_user_create

core_groups_remove_user_create(group_uuid, user_account_request)

Add user to group

Parameters

Name	Type	Description	Required	Notes
group_uuid	uuid::Uuid	A UUID string identifying this Group.	[required]
user_account_request	UserAccountRequest		[required]

Return type

(empty response body)

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]

core_groups_retrieve

models::Group core_groups_retrieve(group_uuid, include_users)

Group Viewset

Parameters

Name	Type	Description	Required	Notes
group_uuid	uuid::Uuid	A UUID string identifying this Group.	[required]
include_users	Option<bool>			[default to true]

Return type

models::Group

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]

core_groups_update

models::Group core_groups_update(group_uuid, group_request)

Group Viewset

Parameters

Name	Type	Description	Required	Notes
group_uuid	uuid::Uuid	A UUID string identifying this Group.	[required]
group_request	GroupRequest		[required]

Return type

models::Group

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]

core_groups_used_by_list

Vecmodels::UsedBy core_groups_used_by_list(group_uuid)

Get a list of all objects that use this object

Parameters

Name	Type	Description	Required	Notes
group_uuid	uuid::Uuid	A UUID string identifying this Group.	[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]

core_tokens_create

models::Token core_tokens_create(token_request)

Token Viewset

Parameters

Name	Type	Description	Required	Notes
token_request	TokenRequest		[required]

Return type

models::Token

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]

core_tokens_destroy

core_tokens_destroy(identifier)

Token Viewset

Parameters

Name	Type	Description	Required	Notes
identifier	String		[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]

core_tokens_list

models::PaginatedTokenList core_tokens_list(description, expires, expiring, identifier, intent, managed, ordering, page, page_size, search, user__username)

Token Viewset

Parameters

Name	Type	Description	Required	Notes
description	Option<String>
expires	Option<String>
expiring	Option<bool>
identifier	Option<String>
intent	Option<String>
managed	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.
user__username	Option<String>

Return type

models::PaginatedTokenList

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]

core_tokens_partial_update

models::Token core_tokens_partial_update(identifier, patched_token_request)

Token Viewset

Parameters

Name	Type	Description	Required	Notes
identifier	String		[required]
patched_token_request	Option<PatchedTokenRequest>

Return type

models::Token

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]

core_tokens_retrieve

models::Token core_tokens_retrieve(identifier)

Token Viewset

Parameters

Name	Type	Description	Required	Notes
identifier	String		[required]

Return type

models::Token

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]

core_tokens_set_key_create

core_tokens_set_key_create(identifier, token_set_key_request)

Set token key. Action is logged as event. authentik_core.set_token_key permission is required.

Parameters

Name	Type	Description	Required	Notes
identifier	String		[required]
token_set_key_request	TokenSetKeyRequest		[required]

Return type

(empty response body)

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]

core_tokens_update

models::Token core_tokens_update(identifier, token_request)

Token Viewset

Parameters

Name	Type	Description	Required	Notes
identifier	String		[required]
token_request	TokenRequest		[required]

Return type

models::Token

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]

core_tokens_used_by_list

Vecmodels::UsedBy core_tokens_used_by_list(identifier)

Get a list of all objects that use this object

Parameters

Name	Type	Description	Required	Notes
identifier	String		[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]

core_tokens_view_key_retrieve

models::TokenView core_tokens_view_key_retrieve(identifier)

Return token key and log access

Parameters

Name	Type	Description	Required	Notes
identifier	String		[required]

Return type

models::TokenView

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]

core_transactional_applications_update

models::TransactionApplicationResponse core_transactional_applications_update(transaction_application_request)

Convert data into a blueprint, validate it and apply it

Parameters

Name	Type	Description	Required	Notes
transaction_application_request	TransactionApplicationRequest		[required]

Return type

models::TransactionApplicationResponse

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]

core_user_consent_destroy

core_user_consent_destroy(id)

UserConsent Viewset

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this User Consent.	[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]

core_user_consent_list

models::PaginatedUserConsentList core_user_consent_list(application, ordering, page, page_size, search, user)

UserConsent Viewset

Parameters

Name	Type	Description	Required	Notes
application	Option<uuid::Uuid>
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.
user	Option<i32>

Return type

models::PaginatedUserConsentList

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]

core_user_consent_retrieve

models::UserConsent core_user_consent_retrieve(id)

UserConsent Viewset

Parameters

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

Return type

models::UserConsent

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]

core_user_consent_used_by_list

Vecmodels::UsedBy core_user_consent_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 User Consent.	[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]

core_users_create

models::User core_users_create(user_request)

User Viewset

Parameters

Name	Type	Description	Required	Notes
user_request	UserRequest		[required]

Return type

models::User

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]

core_users_destroy

core_users_destroy(id)

User Viewset

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this User.	[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]

core_users_impersonate_create

core_users_impersonate_create(id, impersonation_request)

Impersonate a user

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this User.	[required]
impersonation_request	ImpersonationRequest		[required]

Return type

(empty response body)

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]

core_users_impersonate_end_retrieve

core_users_impersonate_end_retrieve()

End Impersonation a user

Parameters

This endpoint does not need any parameter.

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]

core_users_list

models::PaginatedUserList core_users_list(attributes, email, groups_by_name, groups_by_pk, include_groups, is_active, is_superuser, name, ordering, page, page_size, path, path_startswith, search, r#type, username, uuid)

User Viewset

Parameters

Name	Type	Description	Required	Notes
attributes	Option<String>	Attributes
email	Option<String>
groups_by_name	Option<Vec>
groups_by_pk	Option<Vecuuid::Uuid>
include_groups	Option<bool>			[default to true]
is_active	Option<bool>
is_superuser	Option<bool>
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.
path	Option<String>
path_startswith	Option<String>
search	Option<String>	A search term.
r#type	Option<Vec>
username	Option<String>
uuid	Option<uuid::Uuid>

Return type

models::PaginatedUserList

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]

core_users_me_retrieve

models::SessionUser core_users_me_retrieve()

Get information about current user

Parameters

This endpoint does not need any parameter.

Return type

models::SessionUser

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]

core_users_metrics_retrieve

models::UserMetrics core_users_metrics_retrieve(id)

User metrics per 1h

Parameters

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

Return type

models::UserMetrics

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]

core_users_partial_update

models::User core_users_partial_update(id, patched_user_request)

User Viewset

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this User.	[required]
patched_user_request	Option<PatchedUserRequest>

Return type

models::User

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]

core_users_paths_retrieve

models::UserPath core_users_paths_retrieve(search)

Get all user paths

Parameters

Name	Type	Description	Required	Notes
search	Option<String>

Return type

models::UserPath

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]

core_users_recovery_create

models::Link core_users_recovery_create(id)

Create a temporary link that a user can use to recover their accounts

Parameters

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

Return type

models::Link

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]

core_users_recovery_email_create

core_users_recovery_email_create(email_stage, id)

Create a temporary link that a user can use to recover their accounts

Parameters

Name	Type	Description	Required	Notes
email_stage	String		[required]
id	i32	A unique integer value identifying this User.	[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]

core_users_retrieve

models::User core_users_retrieve(id)

User Viewset

Parameters

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

Return type

models::User

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]

core_users_service_account_create

models::UserServiceAccountResponse core_users_service_account_create(user_service_account_request)

Create a new user account that is marked as a service account

Parameters

Name	Type	Description	Required	Notes
user_service_account_request	UserServiceAccountRequest		[required]

Return type

models::UserServiceAccountResponse

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]

core_users_set_password_create

core_users_set_password_create(id, user_password_set_request)

Set password for user

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this User.	[required]
user_password_set_request	UserPasswordSetRequest		[required]

Return type

(empty response body)

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]

core_users_update

models::User core_users_update(id, user_request)

User Viewset

Parameters

Name	Type	Description	Required	Notes
id	i32	A unique integer value identifying this User.	[required]
user_request	UserRequest		[required]

Return type

models::User

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]

core_users_used_by_list

Vecmodels::UsedBy core_users_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 User.	[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]