From cef5c2b084880ce19794f1df7200eb2b2494c2a0 Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Mon, 31 May 2021 17:08:39 +0200 Subject: [PATCH] website/docs: add note for CSRF in hass Signed-off-by: Jens Langhammer --- .../services/home-assistant/index.md | 4 ++++ website/docs/terminology.md | 16 ++++++++++------ 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/website/docs/integrations/services/home-assistant/index.md b/website/docs/integrations/services/home-assistant/index.md index 1275e5b71..bba6a1c28 100644 --- a/website/docs/integrations/services/home-assistant/index.md +++ b/website/docs/integrations/services/home-assistant/index.md @@ -10,6 +10,10 @@ From https://www.home-assistant.io/ Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts. Perfect to run on a Raspberry Pi or a local server. ::: +:::warning +You might run into CSRF errors, this is caused by Home-assistant and not authentik, see [this GitHub issue](https://github.com/goauthentik/authentik/issues/884#issuecomment-851542477). +::: + ## Preparation The following placeholders will be used: diff --git a/website/docs/terminology.md b/website/docs/terminology.md index fbdc55cb1..fedc9495d 100644 --- a/website/docs/terminology.md +++ b/website/docs/terminology.md @@ -5,21 +5,25 @@ title: Terminology ![](/img/authentik_objects.svg) -### Policy +### System tasks -At a base level a policy is a yes/no gate. It will either evaluate to True or False depending on the Policy Kind and settings. For example, a "Group Membership Policy" evaluates to True if the user is member of the specified Group and False if not. This can be used to conditionally apply Stages, grant/deny access to various objects, and for other custom logic. +These are longer-running tasks which authentik runs in the background. This is used to sync LDAP sources, backup the database, and other various tasks. -### Provider +### Application -A Provider is a way for other applications to authenticate against authentik. Common Providers are OpenID Connect (OIDC) and SAML. +An application links together Policies with a Provider, allowing you to control access. It also holds Information like UI Name, Icon and more. ### Source Sources are locations from which users can be added to authentik. For example, an LDAP Connection to import Users from Active Directory, or an OAuth2 Connection to allow Social Logins. -### Application +### Provider -An application links together Policies with a Provider, allowing you to control access. It also holds Information like UI Name, Icon and more. +A Provider is a way for other applications to authenticate against authentik. Common Providers are OpenID Connect (OIDC) and SAML. + +### Policy + +At a base level a policy is a yes/no gate. It will either evaluate to True or False depending on the Policy Kind and settings. For example, a "Group Membership Policy" evaluates to True if the user is member of the specified Group and False if not. This can be used to conditionally apply Stages, grant/deny access to various objects, and for other custom logic. ### Stages