Skip to content
adversarial

Create a capability configuration

POST
/v1/integrations/{provider}/{installation_id}/configs
curl --request POST \
  --url https://api.adversarial.com/api/v1/integrations/example/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/configs \
  --header 'Content-Type: application/json' \
  --data '{ "capability": "RISK_REGISTER", "config": {}, "display_name": "example", "enabled": true }'

Adds a named configuration of one capability under the installation. Two configurations of one capability under one installation cannot have the same name.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
provider
required
string

Provider slug

installation_id
required
string format: uuid

Installation identifier

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

A new capability configuration under an installation.

object
capability
required

Capability selected from the provider catalog.

string
Allowed values: RISK_REGISTER INCIDENT_REGISTER RISK_TICKET INCIDENT_TICKET NOTIFICATION
config

Complete configuration value. Omitted means an empty configuration.

object
display_name
required

Instance name shown wherever this configuration appears. Unique among the capability’s configurations under one installation.

string
enabled
required

Whether this configuration can execute.

boolean

Responses

Section titled “Responses”

201

Section titled “201”

Capability configuration created

Media typeapplication/json

One capability configuration under an installation.

object
capability
required

Capability identifier.

string
Allowed values: RISK_REGISTER INCIDENT_REGISTER RISK_TICKET INCIDENT_TICKET NOTIFICATION
config
required

Complete validated configuration value.

object
created_date
required

Creation time.

string format: date-time
display_name
required

Name that tells sibling configurations of one capability apart under one installation.

string
enabled
required

Whether the platform can execute this configuration.

boolean
id
required

Configuration identifier.

string format: uuid
installation_id
required

Installation whose credential this configuration runs with.

string format: uuid
updated_date
required

Last update time.

string format: date-time
Example
{
  "capability": "RISK_REGISTER"
}

400

Section titled “400”

Unsupported capability or invalid configuration

404

Section titled “404”

Unknown provider or installation

409

Section titled “409”

Configuration name is already in use