FruxonDocs
IntegrationsCore

Verifies that the provided auth configuration can successfully connect to the integration.

Only supported for auth methods with `ConfigTestSupported = true`. Returns 400 if the auth method does not support verification.

POST
/v1/tenants/{tenant}/integrations/{integration}:verifyConfig
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

integration*string

The unique identifier of the integration.

tenant*string

The tenant identifier

The auth metadata ID and configuration to verify.

authMetadataId*string|null
authConfig*

Auth credentials for an integration — the chosen auth method plus its filled-in parameters (API keys, tokens, …).

configParameters?|null

Extra parameters (e.g. connection_string, base_url) needed by some testers that live outside the auth config.

[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/integrations/string:verifyConfig" \  -H "Content-Type: application/json" \  -d '{    "authMetadataId": "string",    "authConfig": {}  }'
{
  "success": false,
  "error": "string",
  "authorizationUrl": "string",
  "authMapResults": [
    {
      "parameters": {},
      "success": false,
      "error": "string",
      "authorizationUrl": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}