APIs / connectors

Generic Connector

Overview

This API has been available since 1.18.0

The following APIs are provided to manage Generic Connectors.

Create the Generic Connector

Request

Create a Generic Connector with a randomly generated Id.

POST /api/connector

Create a Generic Connector with the provided unique Id.

POST /api/connector/{connectorId}

The type in the request JSON is used to determine that you are creating the Generic Connector.

Request Parameters

connectorIdUUIDDefaults 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.authenticationURLStringrequired

The fully qualified URL used to send an HTTP request to authenticate the user. Must be a valid URL.

connector.connectTimeoutIntegerrequired

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

connector.dataObject

An object that can hold any information about the Connector that should be persisted.

connector.debugBooleanDefaults to false

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

connector.headersObject

An object that can hold HTTPHeader key and value pairs.

connector.httpAuthenticationPasswordString

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

connector.httpAuthenticationUsernameString

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

connector.nameStringrequired

The unique Connector name.

connector.readTimeoutIntegerrequired

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

connector.sslCertificateKeyIdUUID

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

connector.typeStringrequired

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

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.authenticationURLString

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

connector.connectTimeoutInteger

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

connector.dataObject

An object that can hold any information about the Connector that should be persisted.

connector.debugBoolean

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

connector.headersObject

An object that can hold HTTPHeader key and value pairs.

connector.httpAuthenticationPasswordString

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

connector.httpAuthenticationUsernameString

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

connector.idUUID

The unique Id of the Connector.

connector.insertInstantLong

The instant when the Connector was created.

connector.lastUpdateInstantLong

The instant when the Connector was last updated.

connector.nameString

The unique Connector name.

connector.readTimeoutInteger

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

connector.sslCertificateKeyIdUUID

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

connector.typeString

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

GET /api/connector/{connectorId}

Request Parameters

connectorIdUUIDrequired

The 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 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.authenticationURLString

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

connector.connectTimeoutInteger

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

connector.dataObject

An object that can hold any information about the Connector that should be persisted.

connector.debugBoolean

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

connector.headersObject

An object that can hold HTTPHeader key and value pairs.

connector.httpAuthenticationPasswordString

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

connector.httpAuthenticationUsernameString

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

connector.idUUID

The unique Id of the Connector.

connector.insertInstantLong

The instant when the Connector was created.

connector.lastUpdateInstantLong

The instant when the Connector was last updated.

connector.nameString

The unique Connector name.

connector.readTimeoutInteger

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

connector.sslCertificateKeyIdUUID

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

connector.typeString

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 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

PUT /api/connector/{connectorId}

PATCH /api/connector/{connectorId}

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.

When using the PATCH method with a Content-Type of application/json the provided request parameters will be merged 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

connectorIdUUIDrequired

The Id of the Connector to update.

Request Body

connector.authenticationURLStringrequired

The fully qualified URL used to send an HTTP request to authenticate the user. Must be a valid URL.

connector.connectTimeoutIntegerrequired

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

connector.dataObject

An object that can hold any information about the Connector that should be persisted.

connector.debugBooleanDefaults to false

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

connector.headersObject

An object that can hold HTTPHeader key and value pairs.

connector.httpAuthenticationPasswordString

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

connector.httpAuthenticationUsernameString

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

connector.nameStringrequired

The unique Connector name.

connector.readTimeoutIntegerrequired

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

connector.sslCertificateKeyIdUUID

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

connector.typeStringrequired

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.

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.authenticationURLString

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

connector.connectTimeoutInteger

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

connector.dataObject

An object that can hold any information about the Connector that should be persisted.

connector.debugBoolean

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

connector.headersObject

An object that can hold HTTPHeader key and value pairs.

connector.httpAuthenticationPasswordString

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

connector.httpAuthenticationUsernameString

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

connector.idUUID

The unique Id of the Connector.

connector.insertInstantLong

The instant when the Connector was created.

connector.lastUpdateInstantLong

The instant when the Connector was last updated.

connector.nameString

The unique Connector name.

connector.readTimeoutInteger

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

connector.sslCertificateKeyIdUUID

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

connector.typeString

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

DELETE /api/connector/{connectorId}

connectorIdUUIDrequired

The Id of the Connector to delete.

Response

This API does not return a JSON response body.

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.

Results

Recent

Generic Connector

Overview

Create the Generic Connector

Request

Request Parameters

Request Body

Response

Response Body

Retrieve the Generic Connector

Request

Request Parameters

Response

Response Body

Update the Generic Connector

Request

Request Parameters

Request Body

Response

Response Body

Delete the Generic Connector

Request

Response

Results

Recent