Files
authentik/website/docs/users-sources/sources/social-logins/telegram/index.md
Teffen Ellis 6ed5cb5249 website/docs: Modal and wizard button labels (#21549)
* website/integrations: rename "Create with Provider" to "New Application"

The application list page now uses a split-button labeled
"New Application" instead of the old "Create with Provider" dropdown.
Update all 113 integration guides to match.

* website/docs: update flow, stage, and policy button labels

- "Create" → "New Flow", "New Stage", "New Policy" for trigger buttons
- "Finish" → "Create Flow", "Create Stage", "Create Policy" for submit
- "Create and bind stage" → "New Stage" / "Bind Existing Stage"
- "Create" (binding submit) → "Create Stage Binding"

* website/docs: update provider button labels

- "Create" → "New Provider" for trigger buttons
- "Create with Provider" → "New Application" in RAC docs
- "Create" → "New Property Mapping", "New RAC Endpoint", "New Prompt"
  for related entity creation

* website/docs: update directory button labels

- "Create" → "New Source" for federation/social login pages
- "Create" → "New Role", submit → "Create Role"
- "Create" → "New Invitation"
- Policy binding submit → "Create Policy Binding"

* website/docs: update endpoint device and system management button labels

- "Create" → "New Endpoint Connector", "New Enrollment Token",
  "New Device Access Group", "New Flow"
- Submit → "Create Device Access Group"
- "Create" → "New Notification Rule", "New Notification Transport"
- Binding submit → "Create Policy Binding"

* Reorganize policy documentation

* website/docs: address policy docs review feedback

* post-rebase

* website/docs: Reorganize policy documentation -- Revisions (#21601)

* apply suggestions

* Fix escaped.

* Fix whitespace.

* Update button label.

* Fix phrasing.

* Fix phrasing.

* Clean up stragglers.

* Format.

---------

Co-authored-by: Dominic R <dominic@sdko.org>
2026-04-16 17:35:38 +00:00

2.6 KiB

title, support_level
title support_level
Telegram community

Configuring Telegram as a source allows users to authenticate within authentik using their Telegram account credentials.

Preparation

Using Telegram as a source requires that your authentik instance is served from a domain.

Telegram configuration

To use Telegram as a source, you first need to register a Telegram bot:

  1. Start a chat with @BotFather on Telegram.
  2. Use the /newbot command to create a new bot. Define a name and username for your new bot (e.g., authentik_bot).
  3. BotFather will provide you with a token for the new bot. Take note of the username and token because they will be required when setting up the source in authentik.
  4. Link the bot to your authentik domain name using the /setdomain command.

:::note The domain name set in Telegram must exactly match the FQDN of the authentik installation. :::

Now that the bot is configured you can proceed to creating a source in authentik.

authentik configuration

  1. Log in to authentik as an administrator and open the authentik Admin interface.

  2. Navigate to Directory > Federation and Social login, click New Source, and then configure the following settings:

    • Select type: select Telegram as the source type.
    • Create Telegram Source: provide a name, a slug, and the following required configurations:
      • Bot username: The username of your Telegram bot (e.g., authentik_bot).
      • Bot token: The token of your Telegram bot.
      • Request access to send messages from your bot: enable this to allow your bot to send messages to authentik users utilizing the Telegram source for authentication.
  3. Click Save.

:::note For instructions on how to display the new source on the authentik login page, refer to the Add sources to default login page documentation. :::

Telegram source property mappings

Property mappings can be used to map Telegram user properties to authentik user properties.

Expression data

Telegram user data is accessible to Telegram source property mappings as a dictionary named info. The dictionary contains the following fields:

  • id - Telegram user ID
  • username - Username of the user. Might not be present.
  • first_name - First name of the user. Might not be present.
  • last_name - Last name of the user. Might not be present.
  • photo_url - URL of the user's profile photo. Might not be present.

Resources