Connector API Overview
Overview
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:
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.
This is a paid edition feature and is unavailable in the community edition. Please visit our pricing page to learn more about paid editions.
Global Operations
Retrieve all Connectors
Request
GET /api/connector
GET /api/connector/{connectorId}
Request Parameters
- connectorId [UUID] Required
-
The unique Id of the Connector to retrieve.
Response
| 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. |
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,
"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,
"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"
}
]
}