Skip to content

Commit a9b6488

Browse files
GirlBossRushtanberryfheislerTana M Berry
authored
website/docs: Flesh out integrations copy changes. (#13619)
* website/docs: Flesh out integrations copy changes. * Apply suggestions from code review Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: Teffen Ellis <[email protected]> * Lint. * Revert removed section. Fix links. * reorder integrations page sections Signed-off-by: Fletcher Heisler <[email protected]> * add back page title Signed-off-by: Fletcher Heisler <[email protected]> * move cards to very end of topic * fix broken anchor link --------- Signed-off-by: Teffen Ellis <[email protected]> Signed-off-by: Fletcher Heisler <[email protected]> Co-authored-by: Tana M Berry <[email protected]> Co-authored-by: Fletcher Heisler <[email protected]> Co-authored-by: Tana M Berry <[email protected]>
1 parent 5fda531 commit a9b6488

File tree

2 files changed

+25
-18
lines changed

2 files changed

+25
-18
lines changed

website/integrations/index.mdx

+14-6
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
---
22
title: Integrations overview
3+
sidebar_label: Overview
34
---
45

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

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

9-
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
11+
### Applications
1012

11-
## Sources
13+
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.
1214

13-
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.
15+
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).
1416

15-
To learn more, refer to the [Sources](https://docs.goauthentik.io/docs/users-sources/sources/index) documentation.
17+
To learn more, refer to the [Applications](../integrations/services) page.
18+
19+
### Federated and social sources
20+
21+
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)
22+
23+
To learn more, refer to the [Sources](../docs/users-sources/sources) page.

website/integrations/services/index.mdx

+11-12
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,26 @@ title: Integrate with Applications
33
sidebar_label: Applications
44
---
55

6-
# Applications
7-
86
import DocCardList from "@theme/DocCardList";
97
import SupportBadge from "@site/src/components/SupportBadge";
108

11-
Below is a list of all applications that are known to work with authentik.
9+
# Applications
1210

13-
:::info{title="Support Levels"}
14-
All app integrations will have one of these badges:
11+
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.
1512

16-
| | |
17-
| ----------------------------------- | ---------------------------------------------------------- |
18-
| <SupportBadge level="community" /> | The integration is community maintained. |
19-
| <SupportBadge level="vendor" /> | The integration is supported by the vendor. |
20-
| <SupportBadge level="authentik" /> | The integration is regularly tested by the authentik team. |
21-
| <SupportBadge level="deprecated" /> | The integration is deprecated and may be removed. |
13+
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://goauthentik.io/discord), or via email to [[email protected]](mailto:[email protected]). You can also add your own documentation for a new application integration following [these instructions](#add-a-new-application).
2214

23-
:::
15+
All documented app integrations will have one of these badges:
16+
17+
- <SupportBadge level="community" />: Community maintained.
18+
- <SupportBadge level="vendor" />: Supported by the vendor.
19+
- <SupportBadge level="authentik" />: Regularly tested by the authentik team.
20+
- <SupportBadge level="deprecated" />: Deprecated and may be removed.
2421

2522
### Add a new application
2623

24+
<a id="add-new"></a>
25+
2726
To add documentation for a new application (with support level Community or Vendor), please use the integration template [`service.md`](https://github.com/goauthentik/authentik/blob/main/website/integrations/template/service.md) file from our GitHub repo. You can download the template file using the following command:
2827

2928
```shell

0 commit comments

Comments
 (0)