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

    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.