1. Packages
  2. Authentik Provider
  3. API Docs
  4. SourceTelegram
authentik 2025.10.0 published on Monday, Oct 27, 2025 by goauthentik
goauthentik/terraform-provider-authentik

authentik.SourceTelegram

Start a Neo task
Explain and create an authentik.SourceTelegram resource
authentik logo
authentik 2025.10.0 published on Monday, Oct 27, 2025 by goauthentik
goauthentik/terraform-provider-authentik

    Create SourceTelegram Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SourceTelegram(name: string, args: SourceTelegramArgs, opts?: CustomResourceOptions);
    @overload
def SourceTelegram(resource_name: str,
                   args: SourceTelegramArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def SourceTelegram(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   pre_authentication_flow: Optional[str] = None,
                   bot_token: Optional[str] = None,
                   bot_username: Optional[str] = None,
                   slug: Optional[str] = None,
                   property_mappings: Optional[Sequence[str]] = None,
                   name: Optional[str] = None,
                   policy_engine_mode: Optional[str] = None,
                   enrollment_flow: Optional[str] = None,
                   authentication_flow: Optional[str] = None,
                   property_mappings_groups: Optional[Sequence[str]] = None,
                   request_message_access: Optional[bool] = None,
                   enabled: Optional[bool] = None,
                   source_telegram_id: Optional[str] = None,
                   user_matching_mode: Optional[str] = None,
                   user_path_template: Optional[str] = None,
                   uuid: Optional[str] = None)
    func NewSourceTelegram(ctx *Context, name string, args SourceTelegramArgs, opts ...ResourceOption) (*SourceTelegram, error)
    public SourceTelegram(string name, SourceTelegramArgs args, CustomResourceOptions? opts = null)
    public SourceTelegram(String name, SourceTelegramArgs args)
public SourceTelegram(String name, SourceTelegramArgs args, CustomResourceOptions options)

    type: authentik:SourceTelegram
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SourceTelegramArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SourceTelegramArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SourceTelegramArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceTelegramArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceTelegramArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sourceTelegramResource = new Authentik.SourceTelegram("sourceTelegramResource", new()
{
    PreAuthenticationFlow = "string",
    BotToken = "string",
    BotUsername = "string",
    Slug = "string",
    PropertyMappings = new[]
    {
        "string",
    },
    Name = "string",
    PolicyEngineMode = "string",
    EnrollmentFlow = "string",
    AuthenticationFlow = "string",
    PropertyMappingsGroups = new[]
    {
        "string",
    },
    RequestMessageAccess = false,
    Enabled = false,
    SourceTelegramId = "string",
    UserMatchingMode = "string",
    UserPathTemplate = "string",
    Uuid = "string",
});

    example, err := authentik.NewSourceTelegram(ctx, "sourceTelegramResource", &authentik.SourceTelegramArgs{
	PreAuthenticationFlow: pulumi.String("string"),
	BotToken:              pulumi.String("string"),
	BotUsername:           pulumi.String("string"),
	Slug:                  pulumi.String("string"),
	PropertyMappings: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:               pulumi.String("string"),
	PolicyEngineMode:   pulumi.String("string"),
	EnrollmentFlow:     pulumi.String("string"),
	AuthenticationFlow: pulumi.String("string"),
	PropertyMappingsGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	RequestMessageAccess: pulumi.Bool(false),
	Enabled:              pulumi.Bool(false),
	SourceTelegramId:     pulumi.String("string"),
	UserMatchingMode:     pulumi.String("string"),
	UserPathTemplate:     pulumi.String("string"),
	Uuid:                 pulumi.String("string"),
})

    var sourceTelegramResource = new SourceTelegram("sourceTelegramResource", SourceTelegramArgs.builder()
    .preAuthenticationFlow("string")
    .botToken("string")
    .botUsername("string")
    .slug("string")
    .propertyMappings("string")
    .name("string")
    .policyEngineMode("string")
    .enrollmentFlow("string")
    .authenticationFlow("string")
    .propertyMappingsGroups("string")
    .requestMessageAccess(false)
    .enabled(false)
    .sourceTelegramId("string")
    .userMatchingMode("string")
    .userPathTemplate("string")
    .uuid("string")
    .build());

    source_telegram_resource = authentik.SourceTelegram("sourceTelegramResource",
    pre_authentication_flow="string",
    bot_token="string",
    bot_username="string",
    slug="string",
    property_mappings=["string"],
    name="string",
    policy_engine_mode="string",
    enrollment_flow="string",
    authentication_flow="string",
    property_mappings_groups=["string"],
    request_message_access=False,
    enabled=False,
    source_telegram_id="string",
    user_matching_mode="string",
    user_path_template="string",
    uuid="string")

    const sourceTelegramResource = new authentik.SourceTelegram("sourceTelegramResource", {
    preAuthenticationFlow: "string",
    botToken: "string",
    botUsername: "string",
    slug: "string",
    propertyMappings: ["string"],
    name: "string",
    policyEngineMode: "string",
    enrollmentFlow: "string",
    authenticationFlow: "string",
    propertyMappingsGroups: ["string"],
    requestMessageAccess: false,
    enabled: false,
    sourceTelegramId: "string",
    userMatchingMode: "string",
    userPathTemplate: "string",
    uuid: "string",
});

    type: authentik:SourceTelegram
properties:
    authenticationFlow: string
    botToken: string
    botUsername: string
    enabled: false
    enrollmentFlow: string
    name: string
    policyEngineMode: string
    preAuthenticationFlow: string
    propertyMappings:
        - string
    propertyMappingsGroups:
        - string
    requestMessageAccess: false
    slug: string
    sourceTelegramId: string
    userMatchingMode: string
    userPathTemplate: string
    uuid: string

    SourceTelegram Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SourceTelegram resource accepts the following input properties:

    BotToken string
    BotUsername string
    PreAuthenticationFlow string
    Slug string
    AuthenticationFlow string
    Enabled bool
    Defaults to true.
    EnrollmentFlow string
    Name string
    PolicyEngineMode string
    Allowed values: - all - any Defaults to any.
    PropertyMappings List<string>
    PropertyMappingsGroups List<string>
    RequestMessageAccess bool
    Defaults to false.
    SourceTelegramId string
    UserMatchingMode string
    Allowed values: - identifier - email_link - email_deny - username_link - username_deny Defaults to identifier.
    UserPathTemplate string
    Defaults to goauthentik.io/sources/%(slug)s.
    Uuid string
    Generated.
    BotToken string
    BotUsername string
    PreAuthenticationFlow string
    Slug string
    AuthenticationFlow string
    Enabled bool
    Defaults to true.
    EnrollmentFlow string
    Name string
    PolicyEngineMode string
    Allowed values: - all - any Defaults to any.
    PropertyMappings []string
    PropertyMappingsGroups []string
    RequestMessageAccess bool
    Defaults to false.
    SourceTelegramId string
    UserMatchingMode string
    Allowed values: - identifier - email_link - email_deny - username_link - username_deny Defaults to identifier.
    UserPathTemplate string
    Defaults to goauthentik.io/sources/%(slug)s.
    Uuid string
    Generated.
    botToken String
    botUsername String
    preAuthenticationFlow String
    slug String
    authenticationFlow String
    enabled Boolean
    Defaults to true.
    enrollmentFlow String
    name String
    policyEngineMode String
    Allowed values: - all - any Defaults to any.
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    requestMessageAccess Boolean
    Defaults to false.
    sourceTelegramId String
    userMatchingMode String
    Allowed values: - identifier - email_link - email_deny - username_link - username_deny Defaults to identifier.
    userPathTemplate String
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid String
    Generated.
    botToken string
    botUsername string
    preAuthenticationFlow string
    slug string
    authenticationFlow string
    enabled boolean
    Defaults to true.
    enrollmentFlow string
    name string
    policyEngineMode string
    Allowed values: - all - any Defaults to any.
    propertyMappings string[]
    propertyMappingsGroups string[]
    requestMessageAccess boolean
    Defaults to false.
    sourceTelegramId string
    userMatchingMode string
    Allowed values: - identifier - email_link - email_deny - username_link - username_deny Defaults to identifier.
    userPathTemplate string
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid string
    Generated.
    bot_token str
    bot_username str
    pre_authentication_flow str
    slug str
    authentication_flow str
    enabled bool
    Defaults to true.
    enrollment_flow str
    name str
    policy_engine_mode str
    Allowed values: - all - any Defaults to any.
    property_mappings Sequence[str]
    property_mappings_groups Sequence[str]
    request_message_access bool
    Defaults to false.
    source_telegram_id str
    user_matching_mode str
    Allowed values: - identifier - email_link - email_deny - username_link - username_deny Defaults to identifier.
    user_path_template str
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid str
    Generated.
    botToken String
    botUsername String
    preAuthenticationFlow String
    slug String
    authenticationFlow String
    enabled Boolean
    Defaults to true.
    enrollmentFlow String
    name String
    policyEngineMode String
    Allowed values: - all - any Defaults to any.
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    requestMessageAccess Boolean
    Defaults to false.
    sourceTelegramId String
    userMatchingMode String
    Allowed values: - identifier - email_link - email_deny - username_link - username_deny Defaults to identifier.
    userPathTemplate String
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid String
    Generated.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SourceTelegram resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SourceTelegram Resource

    Get an existing SourceTelegram resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SourceTelegramState, opts?: CustomResourceOptions): SourceTelegram
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication_flow: Optional[str] = None,
        bot_token: Optional[str] = None,
        bot_username: Optional[str] = None,
        enabled: Optional[bool] = None,
        enrollment_flow: Optional[str] = None,
        name: Optional[str] = None,
        policy_engine_mode: Optional[str] = None,
        pre_authentication_flow: Optional[str] = None,
        property_mappings: Optional[Sequence[str]] = None,
        property_mappings_groups: Optional[Sequence[str]] = None,
        request_message_access: Optional[bool] = None,
        slug: Optional[str] = None,
        source_telegram_id: Optional[str] = None,
        user_matching_mode: Optional[str] = None,
        user_path_template: Optional[str] = None,
        uuid: Optional[str] = None) -> SourceTelegram
    func GetSourceTelegram(ctx *Context, name string, id IDInput, state *SourceTelegramState, opts ...ResourceOption) (*SourceTelegram, error)
    public static SourceTelegram Get(string name, Input<string> id, SourceTelegramState? state, CustomResourceOptions? opts = null)
    public static SourceTelegram get(String name, Output<String> id, SourceTelegramState state, CustomResourceOptions options)
    resources:  _:    type: authentik:SourceTelegram    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AuthenticationFlow string
    BotToken string
    BotUsername string
    Enabled bool
    Defaults to true.
    EnrollmentFlow string
    Name string
    PolicyEngineMode string
    Allowed values: - all - any Defaults to any.
    PreAuthenticationFlow string
    PropertyMappings List<string>
    PropertyMappingsGroups List<string>
    RequestMessageAccess bool
    Defaults to false.
    Slug string
    SourceTelegramId string
    UserMatchingMode string
    Allowed values: - identifier - email_link - email_deny - username_link - username_deny Defaults to identifier.
    UserPathTemplate string
    Defaults to goauthentik.io/sources/%(slug)s.
    Uuid string
    Generated.
    AuthenticationFlow string
    BotToken string
    BotUsername string
    Enabled bool
    Defaults to true.
    EnrollmentFlow string
    Name string
    PolicyEngineMode string
    Allowed values: - all - any Defaults to any.
    PreAuthenticationFlow string
    PropertyMappings []string
    PropertyMappingsGroups []string
    RequestMessageAccess bool
    Defaults to false.
    Slug string
    SourceTelegramId string
    UserMatchingMode string
    Allowed values: - identifier - email_link - email_deny - username_link - username_deny Defaults to identifier.
    UserPathTemplate string
    Defaults to goauthentik.io/sources/%(slug)s.
    Uuid string
    Generated.
    authenticationFlow String
    botToken String
    botUsername String
    enabled Boolean
    Defaults to true.
    enrollmentFlow String
    name String
    policyEngineMode String
    Allowed values: - all - any Defaults to any.
    preAuthenticationFlow String
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    requestMessageAccess Boolean
    Defaults to false.
    slug String
    sourceTelegramId String
    userMatchingMode String
    Allowed values: - identifier - email_link - email_deny - username_link - username_deny Defaults to identifier.
    userPathTemplate String
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid String
    Generated.
    authenticationFlow string
    botToken string
    botUsername string
    enabled boolean
    Defaults to true.
    enrollmentFlow string
    name string
    policyEngineMode string
    Allowed values: - all - any Defaults to any.
    preAuthenticationFlow string
    propertyMappings string[]
    propertyMappingsGroups string[]
    requestMessageAccess boolean
    Defaults to false.
    slug string
    sourceTelegramId string
    userMatchingMode string
    Allowed values: - identifier - email_link - email_deny - username_link - username_deny Defaults to identifier.
    userPathTemplate string
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid string
    Generated.
    authentication_flow str
    bot_token str
    bot_username str
    enabled bool
    Defaults to true.
    enrollment_flow str
    name str
    policy_engine_mode str
    Allowed values: - all - any Defaults to any.
    pre_authentication_flow str
    property_mappings Sequence[str]
    property_mappings_groups Sequence[str]
    request_message_access bool
    Defaults to false.
    slug str
    source_telegram_id str
    user_matching_mode str
    Allowed values: - identifier - email_link - email_deny - username_link - username_deny Defaults to identifier.
    user_path_template str
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid str
    Generated.
    authenticationFlow String
    botToken String
    botUsername String
    enabled Boolean
    Defaults to true.
    enrollmentFlow String
    name String
    policyEngineMode String
    Allowed values: - all - any Defaults to any.
    preAuthenticationFlow String
    propertyMappings List<String>
    propertyMappingsGroups List<String>
    requestMessageAccess Boolean
    Defaults to false.
    slug String
    sourceTelegramId String
    userMatchingMode String
    Allowed values: - identifier - email_link - email_deny - username_link - username_deny Defaults to identifier.
    userPathTemplate String
    Defaults to goauthentik.io/sources/%(slug)s.
    uuid String
    Generated.

    Package Details

    Repository
    authentik goauthentik/terraform-provider-authentik
    License
    Notes
    This Pulumi package is based on the authentik Terraform Provider.
    authentik logo
    authentik 2025.10.0 published on Monday, Oct 27, 2025 by goauthentik
    goauthentik/terraform-provider-authentik
      Meet Neo: Your AI Platform Teammate