Create a named provider connection
const url = 'https://api.adversarial.com/api/v1/integrations/example/connections';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"auth_method":"api_key","credentials":{},"display_name":"example","settings":{}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.adversarial.com/api/v1/integrations/example/connections \ --header 'Content-Type: application/json' \ --data '{ "auth_method": "api_key", "credentials": {}, "display_name": "example", "settings": {} }'Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Provider slug
Request Bodyrequired
Section titled “Request Bodyrequired”A new connection of a provider.
object
Authentication method selected from the provider catalog.
Complete write-only input for the selected authentication method.
object
Connection name, unique among this organization’s connections of the provider.
Provider connection values that do not contain secrets.
object
Responses
Section titled “Responses”Connection created
One installed provider connection.
object
Safe authentication error, cleared after successful recovery.
Time of the most recent authentication failure.
Sequential authentication failures since the last accepted provider request.
Selected authentication method.
Creation time.
Whether encrypted credentials are present.
Operator-chosen connection name, unique per organization and provider.
Connection identifier.
Instances owned by this connection.
One instance under a connection.
object
Capability identifier.
Complete validated configuration value.
object
Connection whose credential this configuration runs with.
Creation time.
Instance name, unique across the organization ignoring case; the two halves of a ticket card share one. The instance’s integration user carries it, so it is what Opened by shows for imported records.
Whether the platform can execute this configuration.
Configuration identifier.
Service account this configuration acts as, named as the configuration. Both halves of a ticket card share one.
Last update time.
Canonical provider identifier.
Non-secret connection values.
object
Current lifecycle status.
Last update time.
Example
{ "auth_method": "api_key", "instances": [ { "capability": "RISK_REGISTER" } ]}Invalid provider configuration
Unknown provider
Connection name is already in use