FusionAuth developer image
FusionAuth developer logo
  • Back to site
  • Expert Advice
  • Blog
  • Developers
  • Downloads
  • Account
  • Contact sales
Navigate to...
  • Welcome
  • Getting Started
    • Getting Started
    • 5-minute Setup Guide
      • Overview
      • Docker
      • Fast Path
      • Sandbox
    • Setup Wizard & First Login
    • Register a User and Login
    • Self-service Registration
    • Start and Stop FusionAuth
    • Core Concepts
      • Overview
      • Users
      • Roles
      • Groups
      • Registrations
      • Applications
      • Tenants
      • Identity Providers
      • Authentication/Authorization
      • Integration Points
    • Example Apps
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • PHP
      • Python
      • Ruby
    • Tutorials
  • Installation Guide
    • Overview
    • System Requirements
    • Server Layout
    • Cloud
    • Cluster
    • Docker
    • Fast Path
    • Kubernetes
      • Overview
      • Deployment Guide
      • Minikube Setup
      • Amazon EKS Setup
      • Google GKE Setup
      • Microsoft AKS Setup
    • Kickstart™
    • Homebrew
    • Marketplaces
    • Packages
    • Database
    • FusionAuth App
    • FusionAuth Search
    • Common Configuration
  • Migration Guide
    • Overview
    • General
    • Auth0
    • Keycloak
    • Amazon Cognito
    • Firebase
    • Microsoft Azure AD B2C
    • Tutorial
  • Admin Guide
    • Overview
    • Account Portal
    • Config Management
    • Editions and Features
    • Key Rotation
    • Licensing
    • Monitoring
    • Prometheus Setup
    • Proxy Setup
    • Reference
      • Overview
      • Configuration
      • CORS
      • Data Types
      • Hosted Login Pages Cookies
      • Known Limitations
      • Password Hashes
    • Releases
    • Roadmap
    • Search And FusionAuth
    • Securing
    • Switch Search Engines
    • Technical Support
    • Troubleshooting
    • Upgrading
    • WebAuthn
  • Login Methods
    • Identity Providers
      • Overview
      • Apple
      • Epic Games
      • External JWT
        • Overview
        • Example
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
        • Overview
        • Amazon Cognito
        • Azure AD
        • Discord
        • Github
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • SAML v2
        • Overview
        • ADFS
        • Azure AD
      • SAML v2 IdP Initiated
        • Overview
        • Okta
      • Xbox
    • OIDC & OAuth 2.0
      • Overview
      • Endpoints
      • Tokens
      • OAuth Modes
    • Passwordless
      • Overview
      • Magic Links
      • WebAuthn & Passkeys
    • SAML v2 IdP
      • Overview
      • Google
      • Zendesk
  • Developer Guide
    • Overview
    • API Gateways
      • Overview
      • ngrok Cloud Edge
    • Client Libraries & SDKs
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • Node
      • OpenAPI
      • PHP
      • Python
      • React
      • Ruby
      • Typescript
    • Events & Webhooks
      • Overview
      • Writing a Webhook
      • Securing Webhooks
      • Events
        • Overview
        • Audit Log Create
        • Event Log Create
        • JWT Public Key Update
        • JWT Refresh
        • JWT Refresh Token Revoke
        • Kickstart Success
        • Group Create
        • Group Create Complete
        • Group Delete
        • Group Delete Complete
        • Group Update
        • Group Update Complete
        • Group Member Add
        • Group Member Add Complete
        • Group Member Remove
        • Group Member Remove Complete
        • Group Member Update
        • Group Member Update Complete
        • User Action
        • User Bulk Create
        • User Create
        • User Create Complete
        • User Deactivate
        • User Delete
        • User Delete Complete
        • User Email Update
        • User Email Verified
        • User IdP Link
        • User IdP Unlink
        • User Login Failed
        • User Login Id Dup. Create
        • User Login Id Dup. Update
        • User Login New Device
        • User Login Success
        • User Login Suspicious
        • User Password Breach
        • User Password Reset Send
        • User Password Reset Start
        • User Password Reset Success
        • User Password Update
        • User Reactivate
        • User Reg. Create
        • User Reg. Create Complete
        • User Reg. Delete
        • User Reg. Delete Complete
        • User Registration Update
        • User Reg. Update Complete
        • User Reg. Verified
        • User 2FA Method Add
        • User 2FA Method Remove
        • User Update
        • User Update Complete
    • Guides
      • Overview
      • Authentication Tokens
      • Exposing A Local Instance
      • JSON Web Tokens
      • Key Master
      • Localization and Internationalization
      • Multi-Factor Authentication
      • Multi-Tenant
      • Passwordless
      • Registration-based Email Verification
      • Searching With Elasticsearch
      • Securing Your APIs
      • Silent Mode
      • Single Sign-on
      • Two Factor (pre 1.26)
    • Integrations
      • Overview
      • CleanSpeak
      • Kafka
      • Twilio
    • Plugins
      • Overview
      • Writing a Plugin
      • Custom Password Hashing
    • User Control & Gating
      • Overview
      • Gate Unverified Users
      • Gate Unverified Registrations
      • User Account Lockout
  • Customization
    • Email & Templates
      • Overview
      • Configure Email
      • Email Templates
      • Email Variables
      • Message Templates
    • Lambdas
      • Overview
      • Apple Reconcile
      • Client Cred. JWT Populate
      • Epic Games Reconcile
      • External JWT Reconcile
      • Facebook Reconcile
      • Google Reconcile
      • HYPR Reconcile
      • JWT Populate
      • LDAP Connector Reconcile
      • LinkedIn Reconcile
      • Nintendo Reconcile
      • OpenID Connect Reconcile
      • SAML v2 Populate
      • SAML v2 Reconcile
      • SCIM Group Req. Converter
      • SCIM Group Resp. Convtr.
      • SCIM User Req. Converter
      • SCIM User Resp. Converter
      • Sony PSN Reconcile
      • Steam Reconcile
      • Twitch Reconcile
      • Twitter Reconcile
      • Xbox Reconcile
    • Messengers
      • Overview
      • Generic Messenger
      • Twilio Messenger
    • Themes
      • Overview
      • Examples
      • Helpers
      • Localization
      • Template Variables
  • Premium Features
    • Overview
    • Advanced Registration Forms
    • Advanced Threat Detection
    • Application Specific Themes
    • Breached Password Detection
    • Connectors
      • Overview
      • Generic Connector
      • LDAP Connector
      • FusionAuth Connector
    • Entity Management
    • SCIM
      • Overview
      • Azure AD Client
      • Okta Client
      • SCIM-SDK
    • Self Service Account Mgmt
      • Overview
      • Updating User Data & Password
      • Add Two-Factor Authenticator
      • Add Two-Factor Email
      • Add Two-Factor SMS
      • Add WebAuthn Passkey
      • Customizing
      • Troubleshooting
    • WebAuthn
  • APIs
    • Overview
    • Authentication
    • Errors
    • API Explorer
    • Actioning Users
    • API Keys
    • Applications
    • Audit Logs
    • Connectors
      • Overview
      • Generic
      • LDAP
    • Consents
    • Emails
    • Entity Management
      • Overview
      • Entities
      • Entity Types
      • Grants
    • Event Logs
    • Families
    • Forms
    • Form Fields
    • Groups
    • Identity Providers
      • Overview
      • Links
      • Apple
      • External JWT
      • Epic Games
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
      • SAML v2
      • SAML v2 IdP Initiated
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • Xbox
    • Integrations
    • IP Access Control Lists
    • JWT
    • Keys
    • Lambdas
    • Login
    • Message Templates
    • Messengers
      • Overview
      • Generic
      • Twilio
    • Multi-Factor/Two Factor
    • Passwordless
    • Reactor
    • Registrations
    • Reports
    • SCIM
      • Overview
      • SCIM User
      • SCIM Group
      • SCIM EnterpriseUser
      • SCIM Service Provider Config.
    • System
    • Tenants
    • Themes
    • Users
    • User Actions
    • User Action Reasons
    • User Comments
    • WebAuthn
    • Webhooks
  • Release Notes

    LDAP Connector APIs

    Overview

    This API has been available since 1.18.0

    The following APIs are provided to manage LDAP Connectors.

    Operations

    • Create the LDAP Connector

    • Retrieve the LDAP Connector

    • Update the LDAP Connector

    • Delete the LDAP Connector

    Create the LDAP Connector

    Request

    Create a LDAP Connector with a randomly generated Id.

    URI

    POST /api/connector

    Create a LDAP Connector with the provided unique Id.

    URI

    POST /api/connector/{connectorId}

    The type in the request JSON is used to determine that you are creating a LDAP Connector.

    Request Parameters

    connectorId [UUID] Optional defaults to secure random UUID

    The Id to use for the new Connector. If not specified a secure random UUID will be generated.

    Request Body

    connector.authenticationURL [String] Required

    The fully qualified LDAP URL to authenticate.

    connector.baseStructure [String] Required

    The top of the LDAP directory hierarchy. Typically this contains the dc (domain component) element.

    connector.connectTimeout [Integer] Required

    The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.

    connector.data [Object] Optional

    An object that can hold any information about the Connector that should be persisted.

    connector.debug [Boolean] Optional defaults to false

    Determines if debug should be enabled to create an event log to assist in debugging integration errors.

    connector.identifyingAttribute [String] Required

    The entry attribute name which is the first component of the distinguished name of entries in the directory.

    connector.lambdaConfiguration.reconcileId [UUID] Required

    The Id of an existing Lambda. The lambda is executed after the user authenticates with the connector. This lambda can create a user, registrations, and group memberships in FusionAuth based on attributes returned from the connector.

    connector.loginIdAttribute [String] Required

    The entity attribute name which stores the identifier that is used for logging the user in.

    connector.name [String] Required

    The unique LDAP Connector name.

    connector.readTimeout [Integer] Required

    The read timeout for the HTTP connection, in milliseconds. Value must be greater than 0.

    connector.requestedAttributes [Array<String>] Required

    The attributes to request for an entry from the DIT (Directory Information Tree).

    connector.securityMethod [String] Required

    The LDAP security method. Possible values are:

    • None - Requests will be made without encryption.

    • LDAPS - A secure connection will be made to a secure port over using the LDAPS protocol.

    • StartTLS - An un-secured connection will initially be established, followed by secure connection established using the StartTLS extension.

    connector.systemAccountDN [String] Required

    The distinguished name of an entry that has read access to the directory.

    connector.systemAccountPassword [String] Required

    The password of an entry that has read access to the directory.

    connector.type [String] Required

    This field must be set to LDAP.

    Example LDAP Connector Request JSON
    
    {
      "connector": {
        "authenticationURL": "ldap://localhost:389",
        "baseStructure": "dc=mydomain,dc=org",
        "connectTimeout": 100,
        "data": {
          "modifiedBy": "richard"
        },
        "debug": true,
        "identifyingAttribute": "uid",
        "lambdaConfiguration": {
          "reconcileId": "b3360a2d-e81d-4314-b9f1-244a916ca52f"
        },
        "loginIdAttribute": "mail",
        "name": "My LDAP Connector",
        "readTimeout": 100,
        "requestedAttributes": [
          "mail",
          "uid",
          "objectClass",
          "cn",
          "employeeType",
          "labeledURI",
          "telephoneNumber"
        ],
        "securityMethod": "None",
        "systemAccountDN": "uid=admin,ou=system",
        "systemAccountPassword": "secret",
        "type": "LDAP"
      }
    }

    Response

    Table 1. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Response Body

    connector.authenticationURL [String]

    The fully qualified LDAP URL to authenticate.

    connector.baseStructure [String]

    The top of the LDAP directory hierarchy. Typically this contains the dc (domain component) element.

    connector.connectTimeout [Integer]

    The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.

    connector.data [Object]

    An object that can hold any information about the Connector that should be persisted.

    connector.debug [Boolean] [default]#

    Determines if debug should be enabled to create an event log to assist in debugging integration errors.

    connector.id [UUID]

    The unique Id of the LDAP Connector.

    connector.identifyingAttribute [String]

    The entry attribute name which is the first component of the distinguished name of entries in the directory.

    connector.insertInstant [Long]

    The instant when the LDAP Connector was created.

    connector.lambdaConfiguration.reconcileId [UUID]

    The Id of an existing Lambda. The lambda is executed after the user authenticates with the connector. This lambda can create a user, registrations, and group memberships in FusionAuth based on attributes returned from the connector.

    connector.lastUpdateInstant [Long]

    The instant when the LDAP Connector was last updated.

    connector.loginIdAttribute [String]

    The entity attribute name which stores the identifier that is used for logging the user in.

    connector.name [String]

    The unique LDAP Connector name.

    connector.readTimeout [Integer]

    The read timeout for the HTTP connection, in milliseconds. Value must be greater than 0.

    connector.requestedAttributes [Array<String>]

    The attributes to request for an entry from the DIT (Directory Information Tree).

    connector.securityMethod [String]

    The LDAP security method. Possible values are:

    • None - Requests will be made without encryption.

    • LDAPS - A secure connection will be made to a secure port over using the LDAPS protocol.

    • StartTLS - An un-secured connection will initially be established, followed by secure connection established using the StartTLS extension.

    connector.systemAccountDN [String]

    The distinguished name of an entry that has read access to the directory.

    connector.systemAccountPassword [String]

    The password of an entry that has read access to the directory.

    connector.type [String]

    This field must be set to LDAP.

    Example LDAP Connector Response JSON
    
    {
      "connector": {
        "authenticationURL": "ldap://localhost:389",
        "baseStructure": "dc=mydomain,dc=org",
        "connectTimeout": 100,
        "data": {
          "modifiedBy": "richard"
        },
        "debug": true,
        "id": "1c212e59-0d0e-6b1a-ad48-f4f92793be32",
        "identifyingAttribute": "uid",
        "insertInstant": 1503513015493,
        "lambdaConfiguration": {
          "reconcileId": "fbd1210-2818-4353-adb2-952613eb5d96"
        },
        "lastUpdateInstant": 1503513549421,
        "loginIdAttribute": "mail",
        "name": "My LDAP Connector",
        "readTimeout": 100,
        "requestedAttributes": [
          "mail",
          "uid",
          "objectClass",
          "cn",
          "employeeType",
          "labeledURI",
          "telephoneNumber"
        ],
        "securityMethod": "None",
        "systemAccountDN": "uid=admin,ou=system",
        "systemAccountPassword": "secret",
        "type": "LDAP"
      }
    }

    Retrieve the LDAP Connector

    Request

    Retrieve the LDAP Connector by Id

    URI

    GET /api/connector/{connectorId}

    Request Parameters

    connectorId [UUID] Required

    The Id of the Connector to retrieve.

    Response

    Table 2. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you requested doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Response Body

    connector.authenticationURL [String]

    The fully qualified LDAP URL to authenticate.

    connector.baseStructure [String]

    The top of the LDAP directory hierarchy. Typically this contains the dc (domain component) element.

    connector.connectTimeout [Integer]

    The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.

    connector.data [Object]

    An object that can hold any information about the Connector that should be persisted.

    connector.debug [Boolean] [default]#

    Determines if debug should be enabled to create an event log to assist in debugging integration errors.

    connector.id [UUID]

    The unique Id of the LDAP Connector.

    connector.identifyingAttribute [String]

    The entry attribute name which is the first component of the distinguished name of entries in the directory.

    connector.insertInstant [Long]

    The instant when the LDAP Connector was created.

    connector.lambdaConfiguration.reconcileId [UUID]

    The Id of an existing Lambda. The lambda is executed after the user authenticates with the connector. This lambda can create a user, registrations, and group memberships in FusionAuth based on attributes returned from the connector.

    connector.lastUpdateInstant [Long]

    The instant when the LDAP Connector was last updated.

    connector.loginIdAttribute [String]

    The entity attribute name which stores the identifier that is used for logging the user in.

    connector.name [String]

    The unique LDAP Connector name.

    connector.readTimeout [Integer]

    The read timeout for the HTTP connection, in milliseconds. Value must be greater than 0.

    connector.requestedAttributes [Array<String>]

    The attributes to request for an entry from the DIT (Directory Information Tree).

    connector.securityMethod [String]

    The LDAP security method. Possible values are:

    • None - Requests will be made without encryption.

    • LDAPS - A secure connection will be made to a secure port over using the LDAPS protocol.

    • StartTLS - An un-secured connection will initially be established, followed by secure connection established using the StartTLS extension.

    connector.systemAccountDN [String]

    The distinguished name of an entry that has read access to the directory.

    connector.systemAccountPassword [String]

    The password of an entry that has read access to the directory.

    connector.type [String]

    This field must be set to LDAP.

    Example LDAP Connector Response JSON
    
    {
      "connector": {
        "authenticationURL": "ldap://localhost:389",
        "baseStructure": "dc=mydomain,dc=org",
        "connectTimeout": 100,
        "data": {
          "modifiedBy": "richard"
        },
        "debug": true,
        "id": "1c212e59-0d0e-6b1a-ad48-f4f92793be32",
        "identifyingAttribute": "uid",
        "insertInstant": 1503513015493,
        "lambdaConfiguration": {
          "reconcileId": "fbd1210-2818-4353-adb2-952613eb5d96"
        },
        "lastUpdateInstant": 1503513549421,
        "loginIdAttribute": "mail",
        "name": "My LDAP Connector",
        "readTimeout": 100,
        "requestedAttributes": [
          "mail",
          "uid",
          "objectClass",
          "cn",
          "employeeType",
          "labeledURI",
          "telephoneNumber"
        ],
        "securityMethod": "None",
        "systemAccountDN": "uid=admin,ou=system",
        "systemAccountPassword": "secret",
        "type": "LDAP"
      }
    }

    Update the LDAP Connector

    This API is used to update an existing LDAP Connector.

    You must specify the Id of the LDAP Connector you are updating on the URI.

    You must specify all of the properties of the LDAP Connector when calling this API with the PUT HTTP method. When used with PUT, this API doesn’t merge the existing LDAP Connector and your new data. It replaces the existing LDAP Connector with your new data.

    Utilize the PATCH HTTP method to send specific changes to merge into an existing LDAP Connector.

    Request

    Update the LDAP Connector by Id

    URI

    PUT /api/connector/{connectorId}

    PATCH /api/connector/{connectorId}

    Available since 1.39.0

    When using the PATCH method, you can either use the same request body documentation that is provided for the PUT request for backward compatibility. Or you may use either JSON Patch/RFC 6902 or JSON Merge Patch/RFC 7396. See the PATCH documentation for more information.

    Available since 1.12.0

    When using the PATCH method, use the same request body documentation that is provided for the PUT request. The PATCH method will merge the provided request parameters into the existing object, this means all parameters are optional when using the PATCH method and you only provide the values you want changed. A null value can be used to remove a value. Patching an Array will result in all values from the new list being appended to the existing list, this is a known limitation to the current implementation of PATCH.

     

    Request Parameters

    connectorId [UUID] Required

    The Id of the Connector to update.

    Request Body

    connector.authenticationURL [String] Required

    The fully qualified LDAP URL to authenticate.

    connector.baseStructure [String] Required

    The top of the LDAP directory hierarchy. Typically this contains the dc (domain component) element.

    connector.connectTimeout [Integer] Required

    The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.

    connector.data [Object] Optional

    An object that can hold any information about the Connector that should be persisted.

    connector.debug [Boolean] Optional defaults to false

    Determines if debug should be enabled to create an event log to assist in debugging integration errors.

    connector.identifyingAttribute [String] Required

    The entry attribute name which is the first component of the distinguished name of entries in the directory.

    connector.lambdaConfiguration.reconcileId [UUID] Required

    The Id of an existing Lambda. The lambda is executed after the user authenticates with the connector. This lambda can create a user, registrations, and group memberships in FusionAuth based on attributes returned from the connector.

    connector.loginIdAttribute [String] Required

    The entity attribute name which stores the identifier that is used for logging the user in.

    connector.name [String] Required

    The unique LDAP Connector name.

    connector.readTimeout [Integer] Required

    The read timeout for the HTTP connection, in milliseconds. Value must be greater than 0.

    connector.requestedAttributes [Array<String>] Required

    The attributes to request for an entry from the DIT (Directory Information Tree).

    connector.securityMethod [String] Required

    The LDAP security method. Possible values are:

    • None - Requests will be made without encryption.

    • LDAPS - A secure connection will be made to a secure port over using the LDAPS protocol.

    • StartTLS - An un-secured connection will initially be established, followed by secure connection established using the StartTLS extension.

    connector.systemAccountDN [String] Required

    The distinguished name of an entry that has read access to the directory.

    connector.systemAccountPassword [String] Required

    The password of an entry that has read access to the directory.

    connector.type [String] Required

    This field must be set to LDAP.

    Example LDAP Connector Request JSON
    
    {
      "connector": {
        "authenticationURL": "ldap://localhost:389",
        "baseStructure": "dc=mydomain,dc=org",
        "connectTimeout": 100,
        "data": {
          "modifiedBy": "richard"
        },
        "debug": true,
        "identifyingAttribute": "uid",
        "lambdaConfiguration": {
          "reconcileId": "b3360a2d-e81d-4314-b9f1-244a916ca52f"
        },
        "loginIdAttribute": "mail",
        "name": "My LDAP Connector",
        "readTimeout": 100,
        "requestedAttributes": [
          "mail",
          "uid",
          "objectClass",
          "cn",
          "employeeType",
          "labeledURI",
          "telephoneNumber"
        ],
        "securityMethod": "None",
        "systemAccountDN": "uid=admin,ou=system",
        "systemAccountPassword": "secret",
        "type": "LDAP"
      }
    }

    Response

    The response for this API contains the LDAP Connector.

    Table 3. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you are trying to update doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Response Body

    connector.authenticationURL [String]

    The fully qualified LDAP URL to authenticate.

    connector.baseStructure [String]

    The top of the LDAP directory hierarchy. Typically this contains the dc (domain component) element.

    connector.connectTimeout [Integer]

    The connect timeout for the HTTP connection, in milliseconds. Value must be greater than 0.

    connector.data [Object]

    An object that can hold any information about the Connector that should be persisted.

    connector.debug [Boolean] [default]#

    Determines if debug should be enabled to create an event log to assist in debugging integration errors.

    connector.id [UUID]

    The unique Id of the LDAP Connector.

    connector.identifyingAttribute [String]

    The entry attribute name which is the first component of the distinguished name of entries in the directory.

    connector.insertInstant [Long]

    The instant when the LDAP Connector was created.

    connector.lambdaConfiguration.reconcileId [UUID]

    The Id of an existing Lambda. The lambda is executed after the user authenticates with the connector. This lambda can create a user, registrations, and group memberships in FusionAuth based on attributes returned from the connector.

    connector.lastUpdateInstant [Long]

    The instant when the LDAP Connector was last updated.

    connector.loginIdAttribute [String]

    The entity attribute name which stores the identifier that is used for logging the user in.

    connector.name [String]

    The unique LDAP Connector name.

    connector.readTimeout [Integer]

    The read timeout for the HTTP connection, in milliseconds. Value must be greater than 0.

    connector.requestedAttributes [Array<String>]

    The attributes to request for an entry from the DIT (Directory Information Tree).

    connector.securityMethod [String]

    The LDAP security method. Possible values are:

    • None - Requests will be made without encryption.

    • LDAPS - A secure connection will be made to a secure port over using the LDAPS protocol.

    • StartTLS - An un-secured connection will initially be established, followed by secure connection established using the StartTLS extension.

    connector.systemAccountDN [String]

    The distinguished name of an entry that has read access to the directory.

    connector.systemAccountPassword [String]

    The password of an entry that has read access to the directory.

    connector.type [String]

    This field must be set to LDAP.

    Example LDAP Connector Response JSON
    
    {
      "connector": {
        "authenticationURL": "ldap://localhost:389",
        "baseStructure": "dc=mydomain,dc=org",
        "connectTimeout": 100,
        "data": {
          "modifiedBy": "richard"
        },
        "debug": true,
        "id": "1c212e59-0d0e-6b1a-ad48-f4f92793be32",
        "identifyingAttribute": "uid",
        "insertInstant": 1503513015493,
        "lambdaConfiguration": {
          "reconcileId": "fbd1210-2818-4353-adb2-952613eb5d96"
        },
        "lastUpdateInstant": 1503513549421,
        "loginIdAttribute": "mail",
        "name": "My LDAP Connector",
        "readTimeout": 100,
        "requestedAttributes": [
          "mail",
          "uid",
          "objectClass",
          "cn",
          "employeeType",
          "labeledURI",
          "telephoneNumber"
        ],
        "securityMethod": "None",
        "systemAccountDN": "uid=admin,ou=system",
        "systemAccountPassword": "secret",
        "type": "LDAP"
      }
    }

    Delete the LDAP Connector

    Request

    Delete the LDAP Connector by Id

    URI

    DELETE /api/connector/{connectorId}

    connectorId [UUID] Required

    The Id of the Connector to delete.

    Response

    This API does not return a JSON response body.

    Table 4. Response Codes
    Code Description

    200

    The request was successful. The response will be empty.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you are trying to delete doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo

    Have a question or comment to share?

    Visit the FusionAuth community forum.

    © 2023 FusionAuth
    Subscribe for developer updates