Generic Connector APIs

    Overview

    This API has been available since 1.18.0

    The following APIs are provided to manage Generic Connectors.

    Operations

    Create the Generic Connector

    Request

    Create a Generic Connector with a randomly generated Id.

    URI

    POST /api/connector

    Create a Generic 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 the Generic 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] Optional

    The fully qualified URL used to send an HTTP request to authenticate the user.

    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.headers [Object] Optional

    An object that can hold HTTPHeader key and value pairs.

    connector.httpAuthenticationPassword [String] Optional

    The basic authentication password to use for requests to the Connector.

    connector.httpAuthenticationUsername [String] Optional

    The basic authentication username to use for requests to the Connector.

    connector.name [String] Required

    The unique Connector name.

    connector.readTimeout [Integer] Required

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

    connector.sslCertificateKeyId [UUID] Optional

    The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.

    connector.type [String] Required

    This field must be set to Generic.

    Example Generic Connector Request JSON
    
{
  "connector": {
    "authenticationURL": "http://localhost:3000/api/authenticate",
    "connectTimeout": 100,
    "data": {
      "modifiedBy": "richard"
    },
    "debug": true,
    "headers": {
      "header1": "value1",
      "header2": "value2"
    },
    "httpAuthenticationPassword": "basicPassword",
    "httpAuthenticationUsername": "basicUsername",
    "name": "My Generic Connector",
    "readTimeout": 100,
    "sslCertificateKeyId": "ce485a91-906f-4615-af75-81d37dc71e90",
    "type": "Generic"
  }
}

    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 URL used to send an HTTP request to authenticate the user.

    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]

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

    connector.headers [Object]

    An object that can hold HTTPHeader key and value pairs.

    connector.httpAuthenticationPassword [String]

    The basic authentication password to use for requests to the Connector.

    connector.httpAuthenticationUsername [String]

    The basic authentication username to use for requests to the Connector.

    connector.id [UUID]

    The unique Id of the Connector.

    connector.insertInstant [Long]

    The instant when the Connector was created.

    connector.lastUpdateInstant [Long]

    The instant when the Connector was last updated.

    connector.name [String]

    The unique Connector name.

    connector.readTimeout [Integer]

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

    connector.sslCertificateKeyId [UUID]

    The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.

    connector.type [String]

    This field must be set to Generic.

    Example Generic Connector Response JSON
    
{
  "connector": {
    "authenticationURL": "http://localhost:3000/api/authenticate",
    "connectTimeout": 100,
    "data": {
      "modifiedBy": "richard"
    },
    "debug": true,
    "headers": {
      "header1": "value1",
      "header2": "value2"
    },
    "httpAuthenticationPassword": "basicPassword",
    "httpAuthenticationUsername": "basicUsername",
    "id": "1188edfc-cef3-4555-910e-181ddf6153c0",
    "insertInstant": 1503513015493,
    "lastUpdateInstant": 1503513549421,
    "name": "My Generic Connector",
    "readTimeout": 100,
    "sslCertificateKeyId": "ce485a91-906f-4615-af75-81d37dc71e90",
    "type": "Generic"
  }
}

    Retrieve the Generic Connector

    Request

    Retrieve the Generic 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 URL used to send an HTTP request to authenticate the user.

    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]

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

    connector.headers [Object]

    An object that can hold HTTPHeader key and value pairs.

    connector.httpAuthenticationPassword [String]

    The basic authentication password to use for requests to the Connector.

    connector.httpAuthenticationUsername [String]

    The basic authentication username to use for requests to the Connector.

    connector.id [UUID]

    The unique Id of the Connector.

    connector.insertInstant [Long]

    The instant when the Connector was created.

    connector.lastUpdateInstant [Long]

    The instant when the Connector was last updated.

    connector.name [String]

    The unique Connector name.

    connector.readTimeout [Integer]

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

    connector.sslCertificateKeyId [UUID]

    The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.

    connector.type [String]

    This field must be set to Generic.

    Example Generic Connector Response JSON
    
{
  "connector": {
    "authenticationURL": "http://localhost:3000/api/authenticate",
    "connectTimeout": 100,
    "data": {
      "modifiedBy": "richard"
    },
    "debug": true,
    "headers": {
      "header1": "value1",
      "header2": "value2"
    },
    "httpAuthenticationPassword": "basicPassword",
    "httpAuthenticationUsername": "basicUsername",
    "id": "1188edfc-cef3-4555-910e-181ddf6153c0",
    "insertInstant": 1503513015493,
    "lastUpdateInstant": 1503513549421,
    "name": "My Generic Connector",
    "readTimeout": 100,
    "sslCertificateKeyId": "ce485a91-906f-4615-af75-81d37dc71e90",
    "type": "Generic"
  }
}

    Update the Generic Connector

    This API is used to update an existing Generic Connector.

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

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

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

    Request

    Update the Generic 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] Optional

    The fully qualified URL used to send an HTTP request to authenticate the user.

    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.headers [Object] Optional

    An object that can hold HTTPHeader key and value pairs.

    connector.httpAuthenticationPassword [String] Optional

    The basic authentication password to use for requests to the Connector.

    connector.httpAuthenticationUsername [String] Optional

    The basic authentication username to use for requests to the Connector.

    connector.name [String] Required

    The unique Connector name.

    connector.readTimeout [Integer] Required

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

    connector.sslCertificateKeyId [UUID] Optional

    The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.

    connector.type [String] Required

    This field must be set to Generic.

    Example Generic Connector Request JSON
    
{
  "connector": {
    "authenticationURL": "http://localhost:3000/api/authenticate",
    "connectTimeout": 100,
    "data": {
      "modifiedBy": "richard"
    },
    "debug": true,
    "headers": {
      "header1": "value1",
      "header2": "value2"
    },
    "httpAuthenticationPassword": "basicPassword",
    "httpAuthenticationUsername": "basicUsername",
    "name": "My Generic Connector",
    "readTimeout": 100,
    "sslCertificateKeyId": "ce485a91-906f-4615-af75-81d37dc71e90",
    "type": "Generic"
  }
}

    Response

    The response for this API contains the Generic 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 URL used to send an HTTP request to authenticate the user.

    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]

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

    connector.headers [Object]

    An object that can hold HTTPHeader key and value pairs.

    connector.httpAuthenticationPassword [String]

    The basic authentication password to use for requests to the Connector.

    connector.httpAuthenticationUsername [String]

    The basic authentication username to use for requests to the Connector.

    connector.id [UUID]

    The unique Id of the Connector.

    connector.insertInstant [Long]

    The instant when the Connector was created.

    connector.lastUpdateInstant [Long]

    The instant when the Connector was last updated.

    connector.name [String]

    The unique Connector name.

    connector.readTimeout [Integer]

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

    connector.sslCertificateKeyId [UUID]

    The Id of an existing Key. The X509 certificate is used for client certificate authentication in requests to the Connector.

    connector.type [String]

    This field must be set to Generic.

    Example Generic Connector Response JSON
    
{
  "connector": {
    "authenticationURL": "http://localhost:3000/api/authenticate",
    "connectTimeout": 100,
    "data": {
      "modifiedBy": "richard"
    },
    "debug": true,
    "headers": {
      "header1": "value1",
      "header2": "value2"
    },
    "httpAuthenticationPassword": "basicPassword",
    "httpAuthenticationUsername": "basicUsername",
    "id": "1188edfc-cef3-4555-910e-181ddf6153c0",
    "insertInstant": 1503513015493,
    "lastUpdateInstant": 1503513549421,
    "name": "My Generic Connector",
    "readTimeout": 100,
    "sslCertificateKeyId": "ce485a91-906f-4615-af75-81d37dc71e90",
    "type": "Generic"
  }
}

    Delete the Generic Connector

    Request

    Delete the Generic 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.