published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a LDAP connector and its configuration in a Descope project. Use this connector to authenticate users against an LDAP directory server with support for both password and mTLS authentication.
Create LdapConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LdapConnector(name: string, args: LdapConnectorArgs, opts?: CustomResourceOptions);@overload
def LdapConnector(resource_name: str,
args: LdapConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def LdapConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
server_url: Optional[str] = None,
client_certificate: Optional[str] = None,
bind_dn: Optional[str] = None,
client_key: Optional[str] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
engine_id: Optional[str] = None,
name: Optional[str] = None,
ca_certificate: Optional[str] = None,
reject_unauthorized: Optional[bool] = None,
bind_password: Optional[str] = None,
use_mtls: Optional[bool] = None)func NewLdapConnector(ctx *Context, name string, args LdapConnectorArgs, opts ...ResourceOption) (*LdapConnector, error)public LdapConnector(string name, LdapConnectorArgs args, CustomResourceOptions? opts = null)
public LdapConnector(String name, LdapConnectorArgs args)
public LdapConnector(String name, LdapConnectorArgs args, CustomResourceOptions options)
type: descope:LdapConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_ldap_connector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args LdapConnectorArgs
- 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 LdapConnectorArgs
- 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 LdapConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LdapConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LdapConnectorArgs
- 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 ldapConnectorResource = new Descope.LdapConnector("ldapConnectorResource", new()
{
ProjectId = "string",
ServerUrl = "string",
ClientCertificate = "string",
BindDn = "string",
ClientKey = "string",
Description = "string",
Disabled = false,
EngineId = "string",
Name = "string",
CaCertificate = "string",
RejectUnauthorized = false,
BindPassword = "string",
UseMtls = false,
});
example, err := descope.NewLdapConnector(ctx, "ldapConnectorResource", &descope.LdapConnectorArgs{
ProjectId: pulumi.String("string"),
ServerUrl: pulumi.String("string"),
ClientCertificate: pulumi.String("string"),
BindDn: pulumi.String("string"),
ClientKey: pulumi.String("string"),
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
EngineId: pulumi.String("string"),
Name: pulumi.String("string"),
CaCertificate: pulumi.String("string"),
RejectUnauthorized: pulumi.Bool(false),
BindPassword: pulumi.String("string"),
UseMtls: pulumi.Bool(false),
})
resource "descope_ldap_connector" "ldapConnectorResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
server_url = "string"
client_certificate = "string"
bind_dn = "string"
client_key = "string"
description = "string"
disabled = false
engine_id = "string"
name = "string"
ca_certificate = "string"
reject_unauthorized = false
bind_password = "string"
use_mtls = false
}
var ldapConnectorResource = new LdapConnector("ldapConnectorResource", LdapConnectorArgs.builder()
.projectId("string")
.serverUrl("string")
.clientCertificate("string")
.bindDn("string")
.clientKey("string")
.description("string")
.disabled(false)
.engineId("string")
.name("string")
.caCertificate("string")
.rejectUnauthorized(false)
.bindPassword("string")
.useMtls(false)
.build());
ldap_connector_resource = descope.LdapConnector("ldapConnectorResource",
project_id="string",
server_url="string",
client_certificate="string",
bind_dn="string",
client_key="string",
description="string",
disabled=False,
engine_id="string",
name="string",
ca_certificate="string",
reject_unauthorized=False,
bind_password="string",
use_mtls=False)
const ldapConnectorResource = new descope.LdapConnector("ldapConnectorResource", {
projectId: "string",
serverUrl: "string",
clientCertificate: "string",
bindDn: "string",
clientKey: "string",
description: "string",
disabled: false,
engineId: "string",
name: "string",
caCertificate: "string",
rejectUnauthorized: false,
bindPassword: "string",
useMtls: false,
});
type: descope:LdapConnector
properties:
bindDn: string
bindPassword: string
caCertificate: string
clientCertificate: string
clientKey: string
description: string
disabled: false
engineId: string
name: string
projectId: string
rejectUnauthorized: false
serverUrl: string
useMtls: false
LdapConnector 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 LdapConnector resource accepts the following input properties:
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Server
Url string - The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
- Bind
Dn string - The Distinguished Name to bind with for searching.
- Bind
Password string - The password for the bind DN.
- Ca
Certificate string - The Certificate Authority certificate in PEM format for validating the server certificate.
- Client
Certificate string - The client certificate in PEM format for mTLS authentication.
- Client
Key string - The client private key in PEM format for mTLS authentication.
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Engine
Id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- Name string
- A custom name for your connector.
- bool
- Reject connections to LDAP servers with invalid certificates.
- Use
Mtls bool - Enable mutual TLS authentication for LDAP connection.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Server
Url string - The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
- Bind
Dn string - The Distinguished Name to bind with for searching.
- Bind
Password string - The password for the bind DN.
- Ca
Certificate string - The Certificate Authority certificate in PEM format for validating the server certificate.
- Client
Certificate string - The client certificate in PEM format for mTLS authentication.
- Client
Key string - The client private key in PEM format for mTLS authentication.
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Engine
Id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- Name string
- A custom name for your connector.
- bool
- Reject connections to LDAP servers with invalid certificates.
- Use
Mtls bool - Enable mutual TLS authentication for LDAP connection.
- project_
id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- server_
url string - The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
- bind_
dn string - The Distinguished Name to bind with for searching.
- bind_
password string - The password for the bind DN.
- ca_
certificate string - The Certificate Authority certificate in PEM format for validating the server certificate.
- client_
certificate string - The client certificate in PEM format for mTLS authentication.
- client_
key string - The client private key in PEM format for mTLS authentication.
- description string
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine_
id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name string
- A custom name for your connector.
- bool
- Reject connections to LDAP servers with invalid certificates.
- use_
mtls bool - Enable mutual TLS authentication for LDAP connection.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- server
Url String - The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
- bind
Dn String - The Distinguished Name to bind with for searching.
- bind
Password String - The password for the bind DN.
- ca
Certificate String - The Certificate Authority certificate in PEM format for validating the server certificate.
- client
Certificate String - The client certificate in PEM format for mTLS authentication.
- client
Key String - The client private key in PEM format for mTLS authentication.
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine
Id String - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name String
- A custom name for your connector.
- Boolean
- Reject connections to LDAP servers with invalid certificates.
- use
Mtls Boolean - Enable mutual TLS authentication for LDAP connection.
- project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- server
Url string - The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
- bind
Dn string - The Distinguished Name to bind with for searching.
- bind
Password string - The password for the bind DN.
- ca
Certificate string - The Certificate Authority certificate in PEM format for validating the server certificate.
- client
Certificate string - The client certificate in PEM format for mTLS authentication.
- client
Key string - The client private key in PEM format for mTLS authentication.
- description string
- A description of what your connector is used for.
- disabled boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine
Id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name string
- A custom name for your connector.
- boolean
- Reject connections to LDAP servers with invalid certificates.
- use
Mtls boolean - Enable mutual TLS authentication for LDAP connection.
- project_
id str - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- server_
url str - The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
- bind_
dn str - The Distinguished Name to bind with for searching.
- bind_
password str - The password for the bind DN.
- ca_
certificate str - The Certificate Authority certificate in PEM format for validating the server certificate.
- client_
certificate str - The client certificate in PEM format for mTLS authentication.
- client_
key str - The client private key in PEM format for mTLS authentication.
- description str
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine_
id str - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name str
- A custom name for your connector.
- bool
- Reject connections to LDAP servers with invalid certificates.
- use_
mtls bool - Enable mutual TLS authentication for LDAP connection.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- server
Url String - The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
- bind
Dn String - The Distinguished Name to bind with for searching.
- bind
Password String - The password for the bind DN.
- ca
Certificate String - The Certificate Authority certificate in PEM format for validating the server certificate.
- client
Certificate String - The client certificate in PEM format for mTLS authentication.
- client
Key String - The client private key in PEM format for mTLS authentication.
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine
Id String - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name String
- A custom name for your connector.
- Boolean
- Reject connections to LDAP servers with invalid certificates.
- use
Mtls Boolean - Enable mutual TLS authentication for LDAP connection.
Outputs
All input properties are implicitly available as output properties. Additionally, the LdapConnector 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 LdapConnector Resource
Get an existing LdapConnector 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?: LdapConnectorState, opts?: CustomResourceOptions): LdapConnector@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
bind_dn: Optional[str] = None,
bind_password: Optional[str] = None,
ca_certificate: Optional[str] = None,
client_certificate: Optional[str] = None,
client_key: Optional[str] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
engine_id: Optional[str] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
reject_unauthorized: Optional[bool] = None,
server_url: Optional[str] = None,
use_mtls: Optional[bool] = None) -> LdapConnectorfunc GetLdapConnector(ctx *Context, name string, id IDInput, state *LdapConnectorState, opts ...ResourceOption) (*LdapConnector, error)public static LdapConnector Get(string name, Input<string> id, LdapConnectorState? state, CustomResourceOptions? opts = null)public static LdapConnector get(String name, Output<String> id, LdapConnectorState state, CustomResourceOptions options)resources: existingLdapConnector: type: descope:LdapConnector get: id: ${id}import {
to = descope_ldap_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.
- state LdapConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- 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 LdapConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- 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.
- state LdapConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- 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.
- state LdapConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Bind
Dn string - The Distinguished Name to bind with for searching.
- Bind
Password string - The password for the bind DN.
- Ca
Certificate string - The Certificate Authority certificate in PEM format for validating the server certificate.
- Client
Certificate string - The client certificate in PEM format for mTLS authentication.
- Client
Key string - The client private key in PEM format for mTLS authentication.
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Engine
Id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- Name string
- A custom name for your connector.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- bool
- Reject connections to LDAP servers with invalid certificates.
- Server
Url string - The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
- Use
Mtls bool - Enable mutual TLS authentication for LDAP connection.
- Bind
Dn string - The Distinguished Name to bind with for searching.
- Bind
Password string - The password for the bind DN.
- Ca
Certificate string - The Certificate Authority certificate in PEM format for validating the server certificate.
- Client
Certificate string - The client certificate in PEM format for mTLS authentication.
- Client
Key string - The client private key in PEM format for mTLS authentication.
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Engine
Id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- Name string
- A custom name for your connector.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- bool
- Reject connections to LDAP servers with invalid certificates.
- Server
Url string - The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
- Use
Mtls bool - Enable mutual TLS authentication for LDAP connection.
- bind_
dn string - The Distinguished Name to bind with for searching.
- bind_
password string - The password for the bind DN.
- ca_
certificate string - The Certificate Authority certificate in PEM format for validating the server certificate.
- client_
certificate string - The client certificate in PEM format for mTLS authentication.
- client_
key string - The client private key in PEM format for mTLS authentication.
- description string
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine_
id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name string
- A custom name for your connector.
- project_
id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- bool
- Reject connections to LDAP servers with invalid certificates.
- server_
url string - The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
- use_
mtls bool - Enable mutual TLS authentication for LDAP connection.
- bind
Dn String - The Distinguished Name to bind with for searching.
- bind
Password String - The password for the bind DN.
- ca
Certificate String - The Certificate Authority certificate in PEM format for validating the server certificate.
- client
Certificate String - The client certificate in PEM format for mTLS authentication.
- client
Key String - The client private key in PEM format for mTLS authentication.
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine
Id String - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name String
- A custom name for your connector.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Boolean
- Reject connections to LDAP servers with invalid certificates.
- server
Url String - The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
- use
Mtls Boolean - Enable mutual TLS authentication for LDAP connection.
- bind
Dn string - The Distinguished Name to bind with for searching.
- bind
Password string - The password for the bind DN.
- ca
Certificate string - The Certificate Authority certificate in PEM format for validating the server certificate.
- client
Certificate string - The client certificate in PEM format for mTLS authentication.
- client
Key string - The client private key in PEM format for mTLS authentication.
- description string
- A description of what your connector is used for.
- disabled boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine
Id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name string
- A custom name for your connector.
- project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- boolean
- Reject connections to LDAP servers with invalid certificates.
- server
Url string - The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
- use
Mtls boolean - Enable mutual TLS authentication for LDAP connection.
- bind_
dn str - The Distinguished Name to bind with for searching.
- bind_
password str - The password for the bind DN.
- ca_
certificate str - The Certificate Authority certificate in PEM format for validating the server certificate.
- client_
certificate str - The client certificate in PEM format for mTLS authentication.
- client_
key str - The client private key in PEM format for mTLS authentication.
- description str
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine_
id str - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name str
- A custom name for your connector.
- project_
id str - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- bool
- Reject connections to LDAP servers with invalid certificates.
- server_
url str - The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
- use_
mtls bool - Enable mutual TLS authentication for LDAP connection.
- bind
Dn String - The Distinguished Name to bind with for searching.
- bind
Password String - The password for the bind DN.
- ca
Certificate String - The Certificate Authority certificate in PEM format for validating the server certificate.
- client
Certificate String - The client certificate in PEM format for mTLS authentication.
- client
Key String - The client private key in PEM format for mTLS authentication.
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine
Id String - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name String
- A custom name for your connector.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Boolean
- Reject connections to LDAP servers with invalid certificates.
- server
Url String - The LDAP server URL (e.g., ldap://localhost:389 or ldaps://localhost:636 for SSL/TLS).
- use
Mtls Boolean - Enable mutual TLS authentication for LDAP connection.
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope