Adapter
Adapter for Integration to Microsoft Teams
Overview
This adapter is used to integrate the Itential Automation Platform (IAP) with the Msteams System. The API that was used to build the adapter for Msteams is usually available in the report directory of this adapter. The adapter utilizes the Msteams API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
Details
The MS Teams adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Microsoft Teams. With this adapter you have the ability to perform operations such as:
- Send Notification
For further technical details on how to install and use this adapter, please click the Technical Documentation tab.
Adapter for Microsoft Teams
Table of Contents
Specific Adapter Information
Authentication
This document will go through the steps for authenticating the Adapter for Microsoft Teams adapter. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication HERE.
No Authentication
The Adapter for Microsoft Teams adapter does not require authentication. It uses webhook key that can be passed as a task input. To generate a webhook please follow Microsoft documentation. The first part of the generate webhook will be the host for adapter service config, for example "org.webhook.office.com" and the rest will be the webhook key that need to be passed as the task input.
"authentication": {
"auth_method": "no_authentication",
"username": "user",
"password": "pass",
"token": "token",
"token_timeout": 600000,
"token_cache": "local",
"invalid_token_error": 401,
"auth_field": "header.headers.Authorization",
"auth_field_format": "Basic {b64}{username}:{password}{/b64}"
}
- Restart the adapter. If your properties were set correctly, the adapter should go online.
Troubleshooting
- Make sure you copied over the correct username and password.
- Turn on debug level logs for the adapter in IAP Admin Essentials.
- Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
- Investigate the logs - in particular:
- The FULL REQUEST log to make sure the proper headers are being sent with the request.
- The FULL BODY log to make sure the payload is accurate.
- The CALL RETURN log to see what the other system is telling us.
- Credentials should be masked by the adapter so make sure you verify token
- Remember when you are done to turn auth_logging off as you do not want to log credentials.
Sample Properties
Sample Properties can be used to help you configure the adapter in the Itential Automation Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
"properties": {
"host": "localhost",
"port": 443,
"base_path": "/",
"version": "v1.0",
"cache_location": "none",
"encode_pathvars": false,
"encode_queryvars": true,
"save_metric": false,
"stub": true,
"protocol": "https",
"authentication": {
"auth_method": "no_authentication",
"username": "username",
"password": "password",
"token": "token",
"token_timeout": 1800000,
"token_cache": "local",
"invalid_token_error": 401,
"auth_field": "header.headers.X-AUTH-TOKEN",
"auth_field_format": "{token}",
"auth_logging": false,
"client_id": "",
"client_secret": "",
"grant_type": ""
},
"healthcheck": {
"type": "startup",
"frequency": 300000,
"query_object": {}
},
"throttle": {
"throttle_enabled": false,
"number_pronghorns": 1,
"sync_async": "sync",
"max_in_queue": 1000,
"concurrent_max": 1,
"expire_timeout": 0,
"avg_runtime": 200,
"priorities": [
{
"value": 0,
"percent": 100
}
]
},
"request": {
"number_redirects": 0,
"number_retries": 3,
"limit_retry_error": 401,
"failover_codes": [],
"attempt_timeout": 5000,
"global_request": {
"payload": {},
"uriOptions": {},
"addlHeaders": {},
"authData": {}
},
"healthcheck_on_timeout": true,
"return_raw": false,
"archiving": false,
"return_request": false
},
"proxy": {
"enabled": false,
"host": "",
"port": 1,
"protocol": "http",
"username": "",
"password": ""
},
"ssl": {
"ecdhCurve": "",
"enabled": false,
"accept_invalid_cert": true,
"ca_file": "",
"key_file": "",
"cert_file": "",
"secure_protocol": "",
"ciphers": ""
},
"mongo": {
"host": "",
"port": 0,
"database": "",
"username": "",
"password": "",
"replSet": "",
"db_ssl": {
"enabled": false,
"accept_invalid_cert": false,
"ca_file": "",
"key_file": "",
"cert_file": ""
}
},
"devicebroker": {
"enabled": false,
"getDevice": [
{
"path": "/not/mapped",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"insample": "{port}"
},
"responseDatakey": "",
"responseFields": {
"name": "{this}{||}{that}",
"ostype": "{osfield}",
"ostypePrefix": "meraki-",
"port": "{port}",
"ipaddress": "{ip_addr}",
"serial": "{serial}"
}
}
],
"getDevicesFiltered": [
{
"path": "/not/mapped",
"method": "GET",
"pagination": {
"offsetVar": "",
"limitVar": "",
"incrementBy": "limit",
"requestLocation": "query"
},
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {
"name": "{this}{||}{that}",
"ostype": "{osfield}",
"ostypePrefix": "meraki-",
"port": "{port}",
"ipaddress": "{ip_addr}",
"serial": "{serial}",
"id": "{myid}"
}
}
],
"isAlive": [
{
"path": "/not/mapped/{devID}",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"devID": "{id}"
},
"responseDatakey": "",
"responseFields": {
"status": "return2xx",
"statusValue": "AD.200"
}
}
],
"getConfig": [
{
"path": "/not/mapped/{devID}",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"devID": "{id}"
},
"responseDatakey": "",
"responseFields": {}
}
],
"getCount": [
{
"path": "/not/mapped",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {}
}
]
},
"cache": {
"enabled": false,
"entities": [
{
"entityType": "device",
"frequency": 3600,
"flushOnFail": false,
"limit": 10000,
"retryAttempts": 5,
"sort": true,
"populate": [
{
"path": "/not/mapped",
"method": "GET",
"pagination": {
"offsetVar": "",
"limitVar": "",
"incrementBy": "limit",
"requestLocation": "query"
},
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {},
"responseDatakey": "",
"responseFields": {
"name": "{this}{||}{that}",
"ostype": "{osfield}",
"ostypePrefix": "meraki-",
"port": "{port}",
"ipaddress": "{ip_addr}",
"serial": "{serial}",
"id": "{myid}"
}
}
],
"cachedTasks": [
{
"name": "",
"filterField": "",
"filterLoc": ""
}
]
}
]
}
}