List provider installations

GET

/v1/integrations/{provider}/installations

const url = 'https://api.adversarial.com/api/v1/integrations/example/installations';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.adversarial.com/api/v1/integrations/example/installations

Parameters

Path Parameters

provider

required

string

Provider slug

Responses

200

Provider installations

application/json

Array<object>

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

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

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"
      }
    ]
  }
]

404

Unknown provider