# Connector API

Learn about the APIs for creating, retrieving, updating and deleting identity providers.

> For the index of this section of the site, see [llms.txt](https://fusionauth.io/docs/llms.txt)

This feature is only available in paid plans. To learn more, see [our pricing page](https://fusionauth.io/pricing.md).

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:

*   [LDAP](https://fusionauth.io/docs/apis/connectors/ldap.md)
*   [Generic](https://fusionauth.io/docs/apis/connectors/generic.md)

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

[Global API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#global-api-key-authentication)

Retrieve all Connectors

`GET /api/connector`

[Global API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#global-api-key-authentication)

Retrieve a Connector by Id

`GET /api/connector/{connectorId}`

#### Request Parameters

`connectorId`

*   UUID
*   required

The unique Id of the Connector to retrieve.

### Response

*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](https://fusionauth.io/docs/apis/errors.md) 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](https://fusionauth.io/docs/apis/authentication.md). |
| 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.

*Example Response JSON*

```json
{
  "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"
    }
  ]
}
```
---

## Other pages in Apis

> For the full index of this section, see [Apis](https://fusionauth.io/docs/llms-apis.txt).

- [User Action API](https://fusionauth.io/docs/apis/actioning-users.md): Learn about the APIs for invoking a User Action on a User.
- [API Keys API](https://fusionauth.io/docs/apis/api-keys.md): Learn about the APIs for creating, retrieving, updating and deleting API Keys.
- [Application API](https://fusionauth.io/docs/apis/applications.md): Learn about the APIs for creating, retrieving, updating and deleting Applications.
- [Audit Log API](https://fusionauth.io/docs/apis/audit-logs.md): Learn about the APIs for adding entries to, searching, and exporting the audit log.
- [Authenticate with our APIs](https://fusionauth.io/docs/apis/authentication.md): Learn how the FusionAuth APIs authenticate requests.
- [Configure CORS](https://fusionauth.io/docs/apis/configure-cors.md): How to set up and use the FusionAuth API Explorer.
- [Consent API](https://fusionauth.io/docs/apis/consents.md): Learn about the APIs for creating, retrieving, updating and deleting consents.
- [Custom Form API](https://fusionauth.io/docs/apis/custom-forms.md): Learn about the APIs for configuring custom forms.
- [Email API](https://fusionauth.io/docs/apis/emails.md): Learn about the APIs for creating, retrieving, updating and deleting email templates as well as sending emails to users.
- [Entity API](https://fusionauth.io/docs/apis/entities.md): Learn about the APIs for creating, retrieving, updating and deleting entities and entity types.
- [Error Responses](https://fusionauth.io/docs/apis/errors.md): Learn about the error response that is returned from FusionAuth APIs.
- [Event Log API](https://fusionauth.io/docs/apis/event-logs.md): Learn about the APIs for searching and retrieving event logs.
- [Family API](https://fusionauth.io/docs/apis/families.md): Learn about the APIs for creating, retrieving, updating and deleting families.
- [Group API](https://fusionauth.io/docs/apis/groups.md): Learn about the APIs for creating, retrieving, updating and deleting groups.
- [Hosted Backend API](https://fusionauth.io/docs/apis/hosted-backend.md): Learn about the APIs that you to perform OAuth2 Authorization Code Flow login, logout, and refresh for applications.
- [Identity Provider API](https://fusionauth.io/docs/apis/identity-providers.md): Learn about the APIs for creating, retrieving, updating and deleting identity providers.
- [Identity Verify API](https://fusionauth.io/docs/apis/identity-verify.md): Learn about the APIs for starting, sending, and completing identity verification.
- [Integration API](https://fusionauth.io/docs/apis/integrations.md): Learn about the APIs for retrieving and updating integrations.
- [IP Access Control List API](https://fusionauth.io/docs/apis/ip-acl.md): Learn about the APIs for creating, retrieving, updating and deleting IP Access Control Lists.
- [JWTs & Refresh Token API](https://fusionauth.io/docs/apis/jwt.md): Learn about the APIs that allow you to manage Refresh Tokens, verify Access Tokens and retrieve public keys used for verifying JWT signatures.
- [Key API](https://fusionauth.io/docs/apis/keys.md): Learn about the APIs for generating, importing, retrieving, updating and deleting keys.
- [Lambda API](https://fusionauth.io/docs/apis/lambdas.md): Learn about the APIs for creating, retrieving, updating and deleting lambdas.
- [Login API](https://fusionauth.io/docs/apis/login.md): API documentation for the FusionAuth Login API.
- [Message Template API](https://fusionauth.io/docs/apis/message-templates.md): Learn about the APIs for creating, retrieving, updating and deleting message templates.
- [Messenger API](https://fusionauth.io/docs/apis/messengers.md): Learn about the APIs for creating, retrieving, updating and deleting messengers.
- [OAuth2 API](https://fusionauth.io/docs/apis/oauth.md): This page details FusionAuth's OAuth2 endpoints. Learn about the Authorization Code grant, `Implicit` grant, and other OAuth2 grants.
- [Passwordless API](https://fusionauth.io/docs/apis/passwordless.md): Learn about the APIs for magic link passwordless authentication.
- [Reactor API](https://fusionauth.io/docs/apis/reactor.md): Learn about the APIs for activating, deactivating, and retrieving the status of a FusionAuth Reactor license.
- [User Registration API](https://fusionauth.io/docs/apis/registrations.md): Learn about the APIs for creating, retrieving, updating and deleting User Registrations.
- [Report API](https://fusionauth.io/docs/apis/reports.md): Learn about the APIs for retrieving reports from FusionAuth.
- [SCIM API](https://fusionauth.io/docs/apis/scim.md): Learn about the APIs for provisioning SCIM Resources in FusionAuth using a SCIM Client.
- [OAuth Scopes API](https://fusionauth.io/docs/apis/scopes.md): Learn about the APIs for creating, retrieving, updating and deleting OAuth scopes.
- [System API](https://fusionauth.io/docs/apis/system.md): Learn about the APIs for retrieving and updating the system configuration.
- [Tenant Manager API](https://fusionauth.io/docs/apis/tenant-manager.md): Learn about the APIs for retrieving and updating Tenant Manager configuration.
- [Tenants API](https://fusionauth.io/docs/apis/tenants.md): Learn about the APIs for creating, retrieving, updating and deleting tenants.
- [Theme API](https://fusionauth.io/docs/apis/themes.md): Learn about the APIs for customizing a theme.
- [Multi-Factor API](https://fusionauth.io/docs/apis/two-factor.md): Learn about the APIs for enabling and disabling multi-factor authentication for users.
- [User Action Reason API](https://fusionauth.io/docs/apis/user-action-reasons.md): Learn about the APIs for creating, retrieving, updating and deleting user action reasons.
- [Manage User Action API](https://fusionauth.io/docs/apis/user-actions.md): Learn about the APIs for creating, retrieving, updating and deleting user actions.
- [User Comment API](https://fusionauth.io/docs/apis/user-comments.md): Learn about the APIs for creating and retrieving comments on users.
- [User API](https://fusionauth.io/docs/apis/users.md): Learn how to integrate with the FusionAuth User API. This documentation provides a comprehensive reference for managing users.
- [WebAuthn API](https://fusionauth.io/docs/apis/webauthn.md): Learn about the APIs for starting and completing WebAuthn ceremonies and retrieving, importing and deleting WebAuthn passkeys.
- [Webhook Event Log API](https://fusionauth.io/docs/apis/webhook-event-logs.md): Learn about the APIs for searching and retrieving webhook event and attempt logs.
- [Webhook API](https://fusionauth.io/docs/apis/webhooks.md): Learn about the APIs for creating, retrieving, updating and deleting Webhooks.
