Skip to main content

Integration service (v1)

Download OpenAPI specification:Download

Integrations

Get the list of integrations and their link statuses

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
null

Install integration with an external system

query Parameters
required
string or string

External system name

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
text/plain
null

Remove an integration with an external system

query Parameters
required
string or string

External system name

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}

OAuth

OAuth 2.0 link flow callback

path Parameters
required
string or string

A unique identifier of the flow, the same as in the initial request

required
string or string

An authorization code to be exchanged for an access token

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}