Files
authentik/website/docs/core/terminology.md
Jens L fdcc1dcb36 stages: source stage (#8330)
* stages: source stage

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* include stage name in dummy stage

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* use data instead of instance for login button

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* make mostly work

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* fix ident stage

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* make it work

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* pass more data

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* fix flow inspector not always loading

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* fix dark theme for stepper

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* fix inspector styling

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* don't skip source stage unless returning

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* auto open flow inspector when debug

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* fix lint

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* fixup

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* fix lint

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* fix validation

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* include raw saml response in flow context

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* add some tests

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* move

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* add docs

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* Apply suggestions from code review

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Signed-off-by: Jens L. <jens@beryju.org>

* fix import

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

---------

Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Signed-off-by: Jens L. <jens@beryju.org>
Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
2024-03-14 19:46:27 +01:00

3.4 KiB

id, title, slug
id title slug
terminology Terminology /terminology
graph LR
    source_ldap((LDAP Source)) <-->|Synchronizes| datasource_ldap["FreeIPA/
    Active Directory"]
    datasource_oauth1(Twitter) --> source_oauth((OAuth/SAML\nSource))
    datasource_oauth2(GitHub) --> source_oauth((OAuth/SAML\nSource))
    source_oauth --> authentik_db(authentik Database)
    source_ldap --> authentik_db(authentik Database)

    app_sso(Gitlab) --> authentik_provider[Provider]
    authentik_provider --> authentik_db
    authentik_provider --> authentik_app["Application
    (Stores permissions and UI details)"]
    authentik_app --> authentik_policy_engine[Policy Engine]
    authentik_policy_engine --> authentik_db

    app_ldap("Applications that only
    support LDAP (e.g. pfSense)") --> authentik_outpost_ldap[LDAP Outpost]
    app_proxy("Applications that don't
    support any SSO (e.g. Plex)") --> authentik_outpost_proxy[Proxy Outpost]
    authentik_outpost_ldap --> authentik_outposts[Outposts]
    authentik_outpost_proxy --> authentik_outposts[Outposts]
    authentik_outposts --> authentik_provider

Application

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.

Provider

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.

See Policies

Flows & Stages

Flows are an ordered sequence of stages. These flows can be used to define how a user authenticates, enrolls, etc.

A stage represents a single verification or logic step. They are used to authenticate users, enroll users, and more. These stages can optionally be applied to a flow via policies.

Dynamic in-memory stage

Certain use cases within authentik add steps that are run as part of a flow. These steps are a special type of stage called the "Dynamic in-memory" stage, as they are added to flows dynamically when required, only exist in memory, and are thus not configurable by administrators.

See Flows

Property Mappings

Property Mappings allow you to make information available for external applications. For example, if you want to login to AWS with authentik, you'd use Property Mappings to set the user's roles in AWS based on their group memberships in authentik.

See Property Mappings

Outpost

An outpost is a separate component of authentik, which can be deployed anywhere, regardless of the authentik deployment. The outpost offers services that aren't implemented directly into the authentik core, e.g. Reverse Proxying.

See Outposts

System tasks

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.