Skip to content
adversarial

List integration providers and current installations

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

Responses

Section titled “Responses”

200

Section titled “200”

Provider catalog and organization installations

Media typeapplication/json
Array<object>

One provider in the catalog, with this organization’s installations.

object
auth_methods
required

Authentication methods accepted by the provider.

Array<object>

One authentication method available for a provider.

object
credential_input_schema
required

Write-only credential input schema for this method.

object
name
required

Stable schema name.

string
schema
required

JSON Schema document.

object
method
required

Method stored with each installation.

string
Allowed values: api_key basic bearer oauth2_client_credentials
capabilities
required

Supported provider capabilities.

Array<object>

One capability available for a provider.

object
capability
required

Capability identifier.

string
Allowed values: RISK_REGISTER INCIDENT_REGISTER RISK_TICKET INCIDENT_TICKET NOTIFICATION
config_schema
required

Complete configuration schema for the capability.

object
name
required

Stable schema name.

string
schema
required

JSON Schema document.

object
connection_schema
required

Non-secret connection schema.

object
name
required

Stable schema name.

string
schema
required

JSON Schema document.

object
display_name
required

Human-readable provider name.

string
icon_url

Provider icon URL when available.

string | null
installations
required

Installations visible to the current organization.

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

Canonical provider identifier stored with installations.

string
slug
required

Lowercase slug used in API paths.

string
Example
[
  {
    "auth_methods": [
      {
        "method": "api_key"
      }
    ],
    "capabilities": [
      {
        "capability": "RISK_REGISTER"
      }
    ],
    "installations": [
      {
        "auth_method": "api_key",
        "configs": [
          {
            "capability": "RISK_REGISTER"
          }
        ]
      }
    ]
  }
]