Skip to content
adversarial

Rename an installation or replace its authentication or connection values

PATCH
/v1/integrations/{provider}/{installation_id}
curl --request PATCH \
  --url https://api.adversarial.com/api/v1/integrations/example/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "auth_method": null, "connection": {}, "credentials": {}, "display_name": null }'

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

Changes to an existing installation. Omitted fields keep their value.

object
auth_method
One of:

Replacement authentication method. Supply credentials in the same request.

string
Allowed values: api_key basic bearer oauth2_client_credentials
connection

Replacement non-secret connection values.

object
credentials

Complete write-only credential replacement.

object
display_name

Replacement installation name.

string | null

Responses

Section titled “Responses”

200

Section titled “200”

Updated installation

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

Capability configurations owned by this installation.

Array<object>

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

Non-secret connection values.

object
created_date
required

Creation time.

string format: date-time
credentials_set
required

Whether encrypted credentials are present.

boolean
display_name
required

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

string
id
required

Installation identifier.

string format: uuid
integration_user
required

Service account the platform acts as for this installation.

string format: uuid
provider
required

Canonical provider identifier.

string
status
required

Current lifecycle status.

string
updated_date
required

Last update time.

string format: date-time
Example
{
  "auth_method": "api_key",
  "configs": [
    {
      "capability": "RISK_REGISTER"
    }
  ]
}

400

Section titled “400”

Invalid provider configuration

404

Section titled “404”

Unknown provider or installation

409

Section titled “409”

Installation name is already in use