POST /sources/telegram — authentik

sources

Mixin to add a used_by endpoint to return a list of all objects using this object

post/sources/telegram/

Request body

namestring required

Source's display Name.

slugstring required

Internal source name, used in URLs.

enabledboolean

promotedboolean

When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

authentication_flowstring uuid nullable

Flow to use when authenticating existing users.

enrollment_flowstring uuid nullable

Flow to use when enrolling new users.

user_property_mappingsstring[]

group_property_mappingsstring[]

policy_engine_mode'all' | 'any'

user_matching_mode'identifier' | 'email_link' | 'email_deny' | 'username_link' | 'username_deny'

user_path_templatestring

iconstring

bot_usernamestring required

Telegram bot username

bot_tokenstring required

Telegram bot token

request_message_accessboolean

Request access to send messages from your bot.

pre_authentication_flowstring uuid required

Flow used before authentication.

Response

pkstring uuid required

namestring required

Source's display Name.

slugstring required

Internal source name, used in URLs.

enabledboolean

promotedboolean

When enabled, this source will be displayed as a prominent button on the login page, instead of a small icon.

authentication_flowstring uuid nullable

Flow to use when authenticating existing users.

enrollment_flowstring uuid nullable

Flow to use when enrolling new users.

user_property_mappingsstring[]

group_property_mappingsstring[]

componentstring required

Get object component so that we know how to edit the object

verbose_namestring required

Return object's verbose_name

verbose_name_pluralstring required

Return object's plural verbose_name

meta_model_namestring required

Return internal model name

policy_engine_mode'all' | 'any'

user_matching_mode'identifier' | 'email_link' | 'email_deny' | 'username_link' | 'username_deny'

managedstring nullable required

Objects that are managed by authentik. These objects are created and updated automatically. This flag only indicates that an object can be overwritten by migrations. You can still modify the objects via the API, but expect changes to be overwritten in a later update.