LogoLogo
API Reference
HomeDocumentation and GuidesAPI ReferenceMetadata for Integration Config
API Reference
HomeDocumentation and GuidesAPI ReferenceMetadata for Integration Config
  • API OVERVIEW
    • Getting started using Apono API
    • API Authentication
  • APONO
    • Access Bundles
    • Access Flows
    • Identities
    • Connectors
    • Integrations
    • Users
    • Access Requests
    • Activity
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. APONO

Integrations

PreviousConnectorsNextUsers

Last updated 5 months ago

Was this helpful?

list integration configs

get
Authorizations
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.apono.io/api/v2/integrations-catalog' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "data": [
    {
      "name": "text",
      "type": "text",
      "description": "text",
      "params": [
        {
          "id": "text",
          "label": "text",
          "values": [
            "text"
          ],
          "default": "text",
          "optional": true
        }
      ],
      "requires_secret": true,
      "supported_secret_types": [
        "text"
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

OK

get integration config

get
Authorizations
Path parameters
typestringrequired
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.apono.io/api/v2/integrations-catalog/{type}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "name": "text",
  "type": "text",
  "description": "text",
  "params": [
    {
      "id": "text",
      "label": "text",
      "values": [
        "text"
      ],
      "default": "text",
      "optional": true
    }
  ],
  "requires_secret": true,
  "supported_secret_types": [
    "text"
  ]
}

OK

get integration

get
Authorizations
Path parameters
idstringrequired
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.apono.io/api/v2/integrations/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "id": "text",
  "name": "text",
  "type": "text",
  "status": "Initializing",
  "details": "text",
  "provisioner_id": "text",
  "connection": {},
  "last_sync_time": 1,
  "metadata": {},
  "secret_config": {},
  "connected_resource_types": [
    "text"
  ],
  "custom_access_details": "text"
}

OK

delete integration

delete
Authorizations
Path parameters
idstringrequired
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url 'https://api.apono.io/api/v2/integrations/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "message": "text"
}

OK

refresh integration

post
Authorizations
Path parameters
idstringrequired
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.apono.io/api/v2/integrations/{id}/refresh' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "message": "text"
}

OK

get user tags of a resource

get
Authorizations
Path parameters
resource_idstringrequired
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.apono.io/api/v3/integrations/resources/{resource_id}/user-tags' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "resource_id": "text",
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

OK

get integration permissions for the entire tenant

get
Authorizations
Path parameters
idstringrequired
Query parameters
resource-typestring | nullableoptional
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.apono.io/api/v3/integrations/{id}/permissions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "data": [
    {
      "name": "text",
      "id": "text",
      "resource_type": "text"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

OK

get integration resources for the entire tenant

get
Authorizations
Path parameters
idstringrequired
Query parameters
resource-typestring | nullableoptional
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.apono.io/api/v3/integrations/{id}/resources' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "data": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "status": {
        "status": "Active",
        "message": "text"
      }
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

OK

  • GETlist integrations
  • POSTcreate integration
  • GETlist integration configs
  • GETget integration config
  • GETget integration
  • PUTupdate integration
  • DELETEdelete integration
  • POSTrefresh integration
  • GETget user tags of a resource
  • PUTupdate user tags of a resource
  • GETget integration permissions for the entire tenant
  • GETget integration resources for the entire tenant

list integrations

get
Authorizations
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://api.apono.io/api/v2/integrations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
200
{
  "data": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "status": "Initializing",
      "details": "text",
      "provisioner_id": "text",
      "connection": {},
      "last_sync_time": 1,
      "metadata": {},
      "secret_config": {},
      "connected_resource_types": [
        "text"
      ],
      "custom_access_details": "text"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

OK

create integration

post
Authorizations
Body
namestringrequired
typestringrequired
provisioner_idstring | nullableoptional
metadataobjectrequired
secret_configall of | nullableoptional

connected_resource_typesstring[] | nullableoptional
custom_access_detailsstring | nullableoptional
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.apono.io/api/v2/integrations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "type": "text",
    "provisioner_id": "text",
    "metadata": {},
    "secret_config": {},
    "connected_resource_types": [
      "text"
    ],
    "custom_access_details": "text"
  }'
200
{
  "id": "text",
  "name": "text",
  "type": "text",
  "status": "Initializing",
  "details": "text",
  "provisioner_id": "text",
  "connection": {},
  "last_sync_time": 1,
  "metadata": {},
  "secret_config": {},
  "connected_resource_types": [
    "text"
  ],
  "custom_access_details": "text"
}

OK

update integration

put
Authorizations
Path parameters
idstringrequired
Body
namestringrequired
provisioner_idstring | nullableoptional
metadataobjectrequired
secret_configall of | nullableoptional

connected_resource_typesstring[] | nullableoptional
custom_access_detailsstring | nullableoptional
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url 'https://api.apono.io/api/v2/integrations/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "provisioner_id": "text",
    "metadata": {},
    "secret_config": {},
    "connected_resource_types": [
      "text"
    ],
    "custom_access_details": "text"
  }'
200
{
  "id": "text",
  "name": "text",
  "type": "text",
  "status": "Initializing",
  "details": "text",
  "provisioner_id": "text",
  "connection": {},
  "last_sync_time": 1,
  "metadata": {},
  "secret_config": {},
  "connected_resource_types": [
    "text"
  ],
  "custom_access_details": "text"
}

OK

update user tags of a resource

put
Authorizations
Path parameters
resource_idstringrequired
Body
tagsobjectrequired

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url 'https://api.apono.io/api/v3/integrations/resources/{resource_id}/user-tags' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "tags": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }'
200
{
  "message": "text"
}

OK