Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

website/docs: Flesh out integrations copy changes. #13619

Merged
merged 8 commits into from
Mar 25, 2025
Merged

website/docs: Flesh out integrations copy changes. #13619

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f6c9c9d
website/docs: Flesh out integrations copy changes.
GirlBossRush Mar 21, 2025
9c62989
Apply suggestions from code review
GirlBossRush Mar 24, 2025
9f2955d
Lint.
GirlBossRush Mar 24, 2025
23ac129
Revert removed section. Fix links.
GirlBossRush Mar 24, 2025
ddfd635
reorder integrations page sections
fheisler Mar 25, 2025
a3588b3
add back page title
fheisler Mar 25, 2025
d133b2e
move cards to very end of topic
Mar 25, 2025
629d5e9
fix broken anchor link
Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions website/integrations/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
---
title: Integrations overview
sidebar_label: Overview
---

There are two main types of integrations with authentik: **Applications** and **Sources**.
## What is an integration?

## Applications
An integration is a how authentik connects to third-party applications, directories, and other identity providers.
Integrations are categorized into two categories: **Applications** and **Sources**.

authentik integrates with many applications. For a full list, and to learn more about adding documentation for a new application, refer to the [Applications](../integrations/services/index.mdx) documentation
### Applications

## Sources
Applications include vendor tools such as Google Workspace, GitHub, Slack, or AWS. These applications can be integrated with authentik to provide single sign-on capabilities to securely authenticate users.

In addition to applications, authentik also integrates with external sources, including federated directories like Active Directory and through protocols such as LDAP, OAuth, SAML, and SCIM sources. Sources are a way for authentik to use external credentials for authentication and verification. Sources in authentik can also be used for social logins, using external providers such as Facebook, Twitter, etc.
If you want to integrate an application that isn't listed, authentik can be configured to work with most applications that support authentication protocols such as [SAML](../docs/add-secure-apps/providers/saml), [OAuth and OpenID Connect](../docs/add-secure-apps/providers/oauth2).

To learn more, refer to the [Sources](https://docs.goauthentik.io/docs/users-sources/sources/index) documentation.
To learn more, refer to the [Applications](../integrations/services) page.

### Federated and social sources

Sources are a way for authentik to use external user credentials for authentication. Supported integrations with external sources via authentik include federated directories like Active Directory and social logins such as Facebook, Twitter, etc. These integrations support all major protocols, including [LDAP](../docs/users-sources/sources/protocols/ldap), [SCIM](../docs/users-sources/sources/protocols/scim), [SAML](../docs/users-sources/sources/protocols/saml), and [OAuth and OpenID Connect](../docs/users-sources/sources/protocols/oauth)

To learn more, refer to the [Sources](../docs/users-sources/sources) page.
19 changes: 7 additions & 12 deletions website/integrations/services/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,17 @@ title: Integrate with Applications
sidebar_label: Applications
---

# Applications

import DocCardList from "@theme/DocCardList";
import SupportBadge from "@site/src/components/SupportBadge";

Below is a list of all applications that are known to work with authentik.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Specifically, I think we reworked that order most importantly to get rid of this sentence!


:::info{title="Support Levels"}
All app integrations will have one of these badges:

| | |
| ----------------------------------- | ---------------------------------------------------------- |
| <SupportBadge level="community" /> | The integration is community maintained. |
| <SupportBadge level="vendor" /> | The integration is supported by the vendor. |
| <SupportBadge level="authentik" /> | The integration is regularly tested by the authentik team. |
| <SupportBadge level="deprecated" /> | The integration is deprecated and may be removed. |

:::
- <SupportBadge level="community" />: Community maintained.
- <SupportBadge level="vendor" />: Supported by the vendor.
- <SupportBadge level="authentik" />: Regularly tested by the authentik team.
- <SupportBadge level="deprecated" />: Deprecated and may be removed.

### Add a new application

Expand All @@ -32,6 +25,8 @@ wget https://raw.githubusercontent.com/goauthentik/authentik/main/website/integr

Don't forget to edit the `sidebarsIntegrations.js` file to add your new integration to the lefthand navigation bar.

## Integration categories
Most third-party services that support authentication protocols such as SAML, OAuth, and OpenID Connect can be integrated with authentik, allowing users to log in to these services using their authentik credentials.
Copy link
Contributor

@tanberry tanberry Mar 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GirlBossRush in the Friday co-writing session, this is the new section that we want to add up top, before the info about how to add a new one, and before the cards. So the two paragraphs in this screenshot should be up top. I thought it was like that at end of meeting on Friday; sorry if I missed it then or in the review I did Friday.

Apps-page

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also let's add back in the H2 "Integration categories", please, right above the cards.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, we ended up with the ~opposite order from this screenshot: 1) We probably already work with your application, 2) you can submit docs for new ones, 3) here are the categories for all the following apps


If you don't see an application you're looking for, let us know. You can reach us on [GitHub](https://github.com/goauthentik/authentik), [Discord](https://discord.com/channels/809154715984199690/809154716507963434), or via email to [[email protected]](mailto:[email protected]).

<DocCardList />
Loading