1. Registry
  2. Packages
  3. Dex Provider
  4. API Docs
  5. resources
  6. LocalConnector
Viewing docs for Dex v0.8.0
published on Thursday, Feb 19, 2026 by Kotaicode GmbH
Dex
Viewing docs for Dex v0.8.0
published on Thursday, Feb 19, 2026 by Kotaicode GmbH

    Manages a local/builtin connector in Dex. The local connector provides username/password authentication stored in Dex’s database. This is useful for testing or when you don’t have an external identity provider.

    Create LocalConnector Resource

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

    Constructor syntax

    new LocalConnector(name: string, args: LocalConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def LocalConnector(resource_name: str,
                       args: LocalConnectorArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def LocalConnector(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       connector_id: Optional[str] = None,
                       name: Optional[str] = None,
                       enabled: Optional[bool] = None)
    func NewLocalConnector(ctx *Context, name string, args LocalConnectorArgs, opts ...ResourceOption) (*LocalConnector, error)
    public LocalConnector(string name, LocalConnectorArgs args, CustomResourceOptions? opts = null)
    public LocalConnector(String name, LocalConnectorArgs args)
    public LocalConnector(String name, LocalConnectorArgs args, CustomResourceOptions options)
    
    type: dex:resources:LocalConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "dex_resources_local_connector" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args LocalConnectorArgs
    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 LocalConnectorArgs
    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 LocalConnectorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LocalConnectorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LocalConnectorArgs
    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 localConnectorResource = new Dex.Resources.LocalConnector("localConnectorResource", new()
    {
        ConnectorId = "string",
        Name = "string",
        Enabled = false,
    });
    
    example, err := resources.NewLocalConnector(ctx, "localConnectorResource", &resources.LocalConnectorArgs{
    	ConnectorId: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Enabled:     pulumi.Bool(false),
    })
    
    resource "dex_resources_local_connector" "localConnectorResource" {
      lifecycle {
        create_before_destroy = true
      }
      connector_id = "string"
      name         = "string"
      enabled      = false
    }
    
    var localConnectorResource = new LocalConnector("localConnectorResource", LocalConnectorArgs.builder()
        .connectorId("string")
        .name("string")
        .enabled(false)
        .build());
    
    local_connector_resource = dex.resources.LocalConnector("localConnectorResource",
        connector_id="string",
        name="string",
        enabled=False)
    
    const localConnectorResource = new dex.resources.LocalConnector("localConnectorResource", {
        connectorId: "string",
        name: "string",
        enabled: false,
    });
    
    type: dex:resources:LocalConnector
    properties:
        connectorId: string
        enabled: false
        name: string
    

    LocalConnector 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 LocalConnector resource accepts the following input properties:

    ConnectorId string
    Unique identifier for the local connector.
    Name string
    Human-readable name for the connector, displayed to users during login.
    Enabled bool
    Whether the local connector is enabled. Defaults to true.
    ConnectorId string
    Unique identifier for the local connector.
    Name string
    Human-readable name for the connector, displayed to users during login.
    Enabled bool
    Whether the local connector is enabled. Defaults to true.
    connector_id string
    Unique identifier for the local connector.
    name string
    Human-readable name for the connector, displayed to users during login.
    enabled bool
    Whether the local connector is enabled. Defaults to true.
    connectorId String
    Unique identifier for the local connector.
    name String
    Human-readable name for the connector, displayed to users during login.
    enabled Boolean
    Whether the local connector is enabled. Defaults to true.
    connectorId string
    Unique identifier for the local connector.
    name string
    Human-readable name for the connector, displayed to users during login.
    enabled boolean
    Whether the local connector is enabled. Defaults to true.
    connector_id str
    Unique identifier for the local connector.
    name str
    Human-readable name for the connector, displayed to users during login.
    enabled bool
    Whether the local connector is enabled. Defaults to true.
    connectorId String
    Unique identifier for the local connector.
    name String
    Human-readable name for the connector, displayed to users during login.
    enabled Boolean
    Whether the local connector is enabled. Defaults to true.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LocalConnector 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 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 LocalConnector Resource

    Get an existing LocalConnector 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>, opts?: CustomResourceOptions): LocalConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> LocalConnector
    func GetLocalConnector(ctx *Context, name string, id IDInput, state *LocalConnectorState, opts ...ResourceOption) (*LocalConnector, error)
    public static LocalConnector Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static LocalConnector get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingLocalConnector:    type: dex:resources:LocalConnector    get:      id: ${id}
    import {
      to = dex_resources_local_connector.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state LocalConnectorState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Package Details

    Repository
    dex kotaicode/pulumi-dex
    License
    Dex
    Viewing docs for Dex v0.8.0
    published on Thursday, Feb 19, 2026 by Kotaicode GmbH

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial