Connector API
On this page
This feature requires at least a Starter plan.
A Connector is a named object that provides configuration for allowing authentication against external systems. When you configure a Connector, you can write flexible rules determining which users will use the Connector and whether to migrate the external user information to FusionAuth. FusionAuth will authenticate users against external systems. FusionAuth currently supports the following Connector types:
Generic Connector
Learn about the APIs for creating, retrieving, and updating Generic Connectors.
LDAP Connector
Learn about the APIs for creating, retrieving, and updating LDAP Connectors.
The type of the connector will determine the object's properties as well as the validation that is performed. You can click into any of the connector API docs to get a list of that connector's properties.
Retrieve All Connectors#
Request#
Retrieve all of the Connectors, or provide an Id to retrieve a single Connector.
OpenAPI Spec
OpenAPI Spec
Path Parameters#
connectorIdThe unique Id of the Connector to retrieve.
Response#
| Code | Description |
|---|---|
| 200 | The request succeeded. The response contains a JSON body. |
| 400 | The request was invalid or malformed. The response contains an Errors JSON object with the specific errors. FusionAuth also returns a 400 when the request needs a paid FusionAuth license and no license is present. |
| 401 | The request has no valid Authorization header. The header is missing, or the API key isn't valid. The response is empty. For more information, see Authentication. |
| 500 | FusionAuth had an internal error and logged a stack trace in the FusionAuth log files. The response is empty. |
The response JSON might include different types of connectors. Therefore, you should refer to the documentation for each type of connector to determine the response JSON format for that particular type. Each type has a Retrieve section in its documentation. This format will be the same format used by this API.
{
"connectors": [
{
"authenticationURL": "http://localhost:9000",
"connectTimeout": 1000,
"data": {
"modifiedBy": "richard"
},
"debug": false,
"headers": {
"header1": "value1",
"header2": "value2"
},
"httpAuthenticationPassword": "basicPassword",
"httpAuthenticationUsername": "basicUsername",
"id": "ce485a91-906f-4615-af75-81d37dc71e90",
"insertInstant": 1595454613885,
"lastUpdateInstant": 1595454640843,
"name": "Connector 1",
"readTimeout": 2000,
"type": "Generic"
},
{
"authenticationURL": "ldap://localhost:363",
"baseStructure": "dc=mydomain,dc=org",
"connectTimeout": 1000,
"data": {
"modifiedBy": "gretchen"
},
"debug": false,
"loginIdAttribute": "mail",
"id": "8174f72f-5ecd-4eae-8de8-7fef597b3473",
"identifyingAttribute": "uid",
"insertInstant": 1595454613885,
"lastUpdateInstant": 1595454640843,
"lambdaConfiguration": {},
"name": "Connector 2",
"readTimeout": 2000,
"securityMethod": "None",
"requestedAttributes": [
"cn",
"employeeType",
"labeledURI",
"mail",
"objectClass",
"telephoneNumber",
"uid"
],
"systemAccountDN": "uid=admin,ou=system",
"systemAccountPassword": "secret",
"type": "LDAP"
},
{
"debug": false,
"id": "e3306678-a53a-4964-9040-1c96f36dda72",
"insertInstant": 1595454613885,
"lastUpdateInstant": 1595454640843,
"name": "Default",
"type": "FusionAuth"
}
]
}Related
Learn about the APIs for creating, retrieving, and updating Generic Connectors.
Learn about the APIs for creating, retrieving, and updating LDAP Connectors.
Learn about the APIs for invoking a User Action on a User.
API documentation for the FusionAuth Create an API Key API.