Integration

Integration
Integration

State object representing an integration.

An integration identifies an integration type and an integration-specific properties.
HATEOAS links:
self - Integration - Self link to this integration

JSON Example
{
    "id": "9.0E49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "ownerType": "ad_group",
    "organizationId": "42413b31-1716-477e-9a88-9dc1c3cb1cdf",
    "orgId": "42413b31-1716-477e-9a88-9dc1c3cb1cdf",
    "_links": {
        "empty": false
    },
    "name": "my-name",
    "description": "my-description",
    "integrationType": "activedirectory | ansible | ipam | vro | com.github.saas",
    "integrationProperties": {
        "userName": "admin"
    },
    "customProperties": {
        "isExternal": "true"
    },
    "tags": [
        {
            "key": "env",
            "value": "dev"
        }
    ]
}
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user or display name of the group that owns the entity.

string
ownerType
Optional

Type of a owner(user/ad_group) that owns the entity.

string
organizationId
Optional

This field is deprecated. Use orgId instead. The id of the organization this entity belongs to.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

string
integrationType
Required

Integration type

object
integrationProperties
Required

Integration specific propertiesNote: Integration Properties can be blank for integrations requiring only username and password.

object
customProperties
Optional

Additional properties that may be used to extend the base type.

array of Tag
tags
Optional

A set of tag keys and optional values that were set on the Integration

Property Of
Returned By