Skip to content

Test credentials and resume the integration

POST
/v1/integrations/{provider}/connections/{connection_id}/resume
curl --request POST \
--url https://api.adversarial.com/api/v1/integrations/example/connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/resume

Sends a test message for notification providers. Clears authentication failures on success without changing configuration switches or sync history.

provider
required
string
connection_id
required
string format: uuid
Media typeapplication/json

One installed provider connection.

object
auth_error

Safe authentication error, cleared after successful recovery.

string | null
auth_failed_at

Time of the most recent authentication failure.

string | null format: date-time
auth_failure_count
required

Sequential authentication failures since the last accepted provider request.

integer format: int32
auth_method
required

Selected authentication method.

string
Allowed values: api_key basic bearer oauth2_client_credentials
created_date
required

Creation time.

string format: date-time
credentials_set
required

Whether encrypted credentials are present.

boolean
display_name
required

Operator-chosen connection name, unique per organization and provider.

string
id
required

Connection identifier.

string format: uuid
instances
required

Instances owned by this connection.

Array<object>

One instance under a connection.

object
capability
required

Capability identifier.

string
Allowed values: RISK_REGISTER INCIDENT_REGISTER RISK_TICKET INCIDENT_TICKET NOTIFICATION AGENT_CONTEXT
config
required

Complete validated configuration value.

object
connection_id
required

Connection whose credential this configuration runs with.

string format: uuid
created_date
required

Creation time.

string format: date-time
display_name
required

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.

string
enabled
required

Whether the platform can execute this configuration.

boolean
id
required

Configuration identifier.

string format: uuid
integration_user
required

Service account this configuration acts as, named as the configuration. Both halves of a ticket card share one.

string format: uuid
updated_date
required

Last update time.

string format: date-time
provider
required

Canonical provider identifier.

string
settings
required

Non-secret connection values.

object
status
required

Current lifecycle status.

string
updated_date
required

Last update time.

string format: date-time

Example

{
"auth_method": "api_key",
"instances": [
{
"capability": "RISK_REGISTER"
}
]
}

Provider test failed

Connection changed during the test