@itentialopensource/adapter-microsoft_graph 1.4.7 → 1.5.0

package/.eslintrc.js

@@ -9,6 +9,7 @@ module.exports = {
     'json'
   ],
   parserOptions: {
+    ecmaVersion: 2020,
     sourceType: 'module'
   },
   rules: {

package/AUTH.md

@@ -1,6 +1,6 @@
 ## Authenticating Microsoft Graph Adapter 
 
-This document will go through the steps for authenticating the Microsoft Graph adapter with OAuth Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>. 
+This document will go through the steps for authenticating the Microsoft Graph adapter with OAuth Authentication. Properly configuring the properties for an adapter in Itential Platform is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>. 
 
 Companies periodically change authentication methods to provide better security. As this happens this section should be updated and contributed/merge back into the adapter repository.
 
@@ -11,7 +11,7 @@ You will need to register an application with the <a href="https://learn.microso
 
 STEPS  
 1. Ensure you have access to a Microsoft Graph server and that it is running
-2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
+2. Follow the steps in the README.md to import the adapter into Itential Platform if you have not already done so
 3. Use the properties below for the ```properties.authentication``` field. Note that the token_URI_path has a variable which should be replaced with a valid tenant value
 ```json
 "authentication": {
@@ -47,8 +47,8 @@ STEPS
 
 ### Troubleshooting
 - Make sure you copied over the correct client_id and client_secret.
-- 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).
+- Turn on debug level logs for the adapter in Itential Platform Admin Essentials.
+- Turn on auth_logging for the adapter in Itential Platform 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.

package/BROKER.md

@@ -1,6 +1,6 @@
-## Integrating Microsoft_graph Adapter with IAP Device Broker
+## Integrating Microsoft_graph Adapter with Itential Platform Device Broker
 
-This document will go through the steps for integrating the Microsoft_graph adapter with IAP's Device Broker. IAP Device Broker integration allows for easier interation into several of IAPs applications (e.g. Configuration Manager). Properly configuring the properties for the adapter in IAP is critical for getting the device broker integration to work. Their is additional information in the configuration section of the adapter readme. This document will go through each of the calls that are utilized by the Device Broker.
+This document will go through the steps for integrating the Microsoft_graph adapter with Itential Platform's Device Broker. Itential Platform Device Broker integration allows for easier interation into several of Itential Platform's applications (e.g. Configuration Manager). Properly configuring the properties for the adapter in Itential Platform is critical for getting the device broker integration to work. Their is additional information in the configuration section of the adapter readme. This document will go through each of the calls that are utilized by the Device Broker.
 
 ### getDevicesFiltered
 getDevicesFiltered(options, callback) → This call returns all of the devices within Microsoft_graph that match the provided filter.
@@ -13,7 +13,7 @@ options {object}: defines the options for the search. At current filter is the m
 
 An Object containing the total number of matching devices and a list containing an array of the details for each device. For example, { total: 2, list: [ { name: ‘abc’, ostype: ‘type’, port: 80, ipaddress: ‘10.10.10.10’ }, { name: ‘def’, ostype: ‘type2’, port: 443, ipaddress: ‘10.10.10.15’ }] }
 
-The fields name and ostype are required by the broker and should be mapped through properties to data from the other system. In addition, ipaddress and port should also be mapped as it is utilized by some north bound IAP applications (e.g. Config Manager). There are other fields that can be set as well but consider these the minimal fields.
+The fields name and ostype are required by the broker and should be mapped through properties to data from the other system. In addition, ipaddress and port should also be mapped as it is utilized by some north bound Itential Platform applications (e.g. Config Manager). There are other fields that can be set as well but consider these the minimal fields.
 
 Below is an example of how you may set up the properties for this call.
 
@@ -69,7 +69,7 @@ Below is an example of how you may set up the properties for this call.
 
 Notice with the path, there is a variable in it ({org}). This variable must be provided in the data available to the call. For getDevicesFiltered this means the requestFields as a static value. In other calls, it may also come from the result of the getDevicesFiltered call.
 
-Notice with the responseFields, it wants the IAP data key as the key and where it is supposed to find the data in the response as the value. You can use nested fields in the response object using standard object notation. You can also add static data as shown in the port field. Finally, you can append data to the response from the requestInformation using its key (e.g. org). The ostypePrefix is a special field that allows you to add static data to the ostype to help define the system you are getting the device from.
+Notice with the responseFields, it wants the Itential Platform data key as the key and where it is supposed to find the data in the response as the value. You can use nested fields in the response object using standard object notation. You can also add static data as shown in the port field. Finally, you can append data to the response from the requestInformation using its key (e.g. org). The ostypePrefix is a special field that allows you to add static data to the ostype to help define the system you are getting the device from.
 
 Notice here that you can also have multiple calls that make up the results provided to the Device Broker. In this example we are making calls to two different organizations and returning the results from both. 
 

package/CALLS.md

@@ -4,7 +4,7 @@ The `adapter.js` file contains the calls the adapter makes available to the rest
 
 ### Generic Adapter Calls
 
-These are adapter methods that IAP or you might use. There are some other methods not shown here that might be used for internal adapter functionality.
+These are adapter methods that Itential Platform or you might use. There are some other methods not shown here that might be used for internal adapter functionality.
 
 <table border="1" class="bordered-table">
   <tr>
@@ -14,7 +14,7 @@ These are adapter methods that IAP or you might use. There are some other method
   </tr>
   <tr>
     <td style="padding:15px">connect()</td>
-    <td style="padding:15px">This call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly.</td>
+    <td style="padding:15px">This call is run when the Adapter is first loaded by the Itential Platform. It validates the properties have been provided correctly.</td>
     <td style="padding:15px">No</td>
   </tr>
   <tr>
@@ -34,7 +34,7 @@ These are adapter methods that IAP or you might use. There are some other method
   </tr>
   <tr>
     <td style="padding:15px">iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)</td>
-    <td style="padding:15px">This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.</td>
+    <td style="padding:15px">This call provides the ability to update the adapter configuration from Itential Platform - includes actions, schema, mockdata and other configurations.</td>
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
@@ -58,7 +58,7 @@ These are adapter methods that IAP or you might use. There are some other method
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">iapTroubleshootAdapter(props, persistFlag, adapter, callback)</td>
+    <td style="padding:15px">iapTroubleshootAdapter(props, adapter, callback)</td>
     <td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td>
     <td style="padding:15px">Yes</td>
   </tr>
@@ -73,13 +73,13 @@ These are adapter methods that IAP or you might use. There are some other method
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">iapRunAdapterBasicGet(callback)</td>
-    <td style="padding:15px">This call will return the results of running basic get API calls.</td>
+    <td style="padding:15px">iapRunAdapterBasicGet(maxCalls, callback)</td>
+    <td style="padding:15px">This call will return the results of running basic get API calls. By default 5 get calls without parameters will be run. You can ask for more or less by setting maxCalls.</td>
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
     <td style="padding:15px">iapMoveAdapterEntitiesToDB(callback)</td>
-    <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
+    <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or Itential Platform Database.</td>
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
@@ -150,7 +150,7 @@ These are adapter methods that are used for adapter caching. If configured, the
   
 ### Adapter Broker Calls
 
-These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.
+These are adapter methods that are used to integrate to Itential Platform Brokers. This adapter currently supports the following broker calls.
 
 <table border="1" class="bordered-table">
   <tr>
@@ -160,7 +160,7 @@ These are adapter methods that are used to integrate to IAP Brokers. This adapte
   </tr>
   <tr>
     <td style="padding:15px">hasEntities(entityType, entityList, callback)</td>
-    <td style="padding:15px">This call is utilized by the IAP Device Broker to determine if the adapter has a specific entity and item of the entity.</td>
+    <td style="padding:15px">This call is utilized by the Itential Platform Device Broker to determine if the adapter has a specific entity and item of the entity.</td>
     <td style="padding:15px">No</td>
   </tr>
   <tr>

package/ENHANCE.md

@@ -2,7 +2,7 @@
 
 ### Adding a Second Instance of an Adapter
 
-You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.
+You can add a second instance of this adapter without adding new code on the file system. To do this go into the Itential Platform Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.
 
 ### Adding Adapter Calls
 
@@ -18,7 +18,7 @@ npm run adapter:update
 
 If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.
 
-If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.
+If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in Itential Platform, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter Technical Resources</a> on our Documentation Site.
 
 ```text
 Files to update
@@ -32,7 +32,7 @@ Files to update
 
 ### Adding Adapter Properties
 
-While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
+While changing adapter properties is done in the service instance configuration section of Itential Platform, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
 
 ```text
 Files to update

package/PROPERTIES.md

@@ -1,6 +1,6 @@
 ## Configuration
 
-This section defines **all** the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or IAP are provided in the sampleProperties.
+This section defines **all** the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or Itential Platform are provided in the sampleProperties.
 
 ```json
   {
@@ -82,12 +82,15 @@ This section defines **all** the properties that are available for the adapter,
         "password": "",
       },
       "mongo": {
+        "url": "",
         "host": "",
         "port": 0,
         "database": "",
+        "dbAuth": false,
         "username": "",
         "password": "",
         "replSet": "",
+        "addSrv": false,
         "db_ssl": {
           "enabled": false,
           "accept_invalid_cert": false,
@@ -215,7 +218,7 @@ These base properties are used to connect to Microsoft_graph upon the adapter in
 </table>
 <br>
 
-A connectivity check tells IAP the adapter has loaded successfully.
+A connectivity check tells Itential Platform the adapter has loaded successfully.
 
 ### Authentication Properties
 
@@ -343,7 +346,7 @@ The request section defines properties to help handle requests.
   </tr>
   <tr>
     <td style="padding:15px">failover_codes</td>
-    <td style="padding:15px">An array of error codes for which the adapter will send back a failover flag to IAP so that the Platform can attempt the action in another adapter.</td>
+    <td style="padding:15px">An array of error codes for which the adapter will send back a failover flag to Itential Platform so that the Platform can attempt the action in another adapter.</td>
   </tr>
   <tr>
     <td style="padding:15px">attempt_timeout</td>
@@ -375,7 +378,7 @@ The request section defines properties to help handle requests.
   </tr>
   <tr>
     <td style="padding:15px">return_raw</td>
-    <td style="padding:15px">Optional. Tells the adapter whether the raw response should be returned as well as the IAP response. This is helpful when running integration tests to save mock data. It does add overhead to the response object so it is not ideal from production.</td>
+    <td style="padding:15px">Optional. Tells the adapter whether the raw response should be returned as well as the Itential Platform response. This is helpful when running integration tests to save mock data. It does add overhead to the response object so it is not ideal from production.</td>
   </tr>
   <tr>
     <td style="padding:15px">archiving</td>
@@ -521,29 +524,41 @@ The mongo section defines the properties used to connect to a Mongo database. Mo
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Property</span></th>
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
   </tr>
+  <tr>
+    <td style="padding:15px">url</td>
+    <td style="padding:15px">Optional. Mongo's complete connection URL. This property overrides host, port, database, username, password and replSet settings.</td>
+  </tr>
   <tr>
     <td style="padding:15px">host</td>
-    <td style="padding:15px">Optional. Host information for the mongo server.</td>
+    <td style="padding:15px">Optional. Host information for the Mongo server.</td>
   </tr>
   <tr>
     <td style="padding:15px">port</td>
-    <td style="padding:15px">Optional. Port information for the mongo server.</td>
+    <td style="padding:15px">Optional. Port information for the Mongo server.</td>
   </tr>
   <tr>
     <td style="padding:15px">database</td>
     <td style="padding:15px">Optional. The database for the adapter to use for its data.</td>
   </tr>
+  <tr>
+    <td style="padding:15px">dbAuth</td>
+    <td style="padding:15px">Optional. Whether to use authentication for MongoDB connection. Default is false.</td>
+  </tr>
   <tr>
     <td style="padding:15px">username</td>
-    <td style="padding:15px">Optional. If credentials are required to access mongo, this is the user to login as.</td>
+    <td style="padding:15px">Optional. If credentials are required to access Mongo, this is the user to login as.</td>
   </tr>
   <tr>
     <td style="padding:15px">password</td>
-    <td style="padding:15px">Optional. If credentials are required to access mongo, this is the password to login with.</td>
+    <td style="padding:15px">Optional. If credentials are required to access Mongo, this is the password to login with.</td>
   </tr>
   <tr>
     <td style="padding:15px">replSet</td>
-    <td style="padding:15px">Optional. If the database is set up to use replica sets, define it here so it can be added to the database connection.</td>
+    <td style="padding:15px">Optional. If the database is set up to use replica sets, define it here so it can be added to the database connection. Not used when using mongodb+srv:// protocol</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">addSrv</td>
+    <td style="padding:15px">Optional. Whether the connection requires the mongodb+srv:// protocol. If true, uses mongodb+srv:// protocol. Note: mongodb+srv:// can also be used for non-Atlas deployments that support DNS SRV records</td>
   </tr>
   <tr>
     <td style="padding:15px">db_ssl</td>

package/README.md

@@ -12,13 +12,14 @@ Some of the page links in this document and links to other GitLab files do not w
 - [Generic Adapter Information](#generic-adapter-information)
   - [Overview](./SUMMARY.md)
   - [Versioning](#versioning)
-  - [Supported IAP Versions](#supported-iap-versions)
+  - [Supported Platform Versions](#supported-platform-versions)
   - [Getting Started](#getting-started)
     - [Helpful Background Information](#helpful-background-information)
     - [Prerequisites](#prerequisites)
     - [How to Install](#how-to-install)
     - [Testing](#testing)
   - [Configuration](./PROPERTIES.md)
+  - [Utilities](./UTILITIES.md)
   - [Additional Information](#additional-information)
     - [Enhancements](./ENHANCE.md)
     - [Contributing](./CONTRIBUTING.md)
@@ -48,19 +49,19 @@ Some of the page links in this document and links to other GitLab files do not w
 
 ### Versioning
 
-Itential Product and opensource adapters utilize SemVer for versioning. The current version of the adapter can be found in the `package.json` file or viewed in the IAP GUI on the System page. All Itential opensource adapters can be found in the <a href="https://gitlab.com/itentialopensource/adapters" target="_blank">Itential OpenSource Repository</a>.
+Itential Product and opensource adapters utilize SemVer for versioning. The current version of the adapter can be found in the `package.json` file or viewed in the Platform GUI on the System page. All Itential opensource adapters can be found in the <a href="https://gitlab.com/itentialopensource/adapters" target="_blank">Itential OpenSource Repository</a>.
 
 Any release prior to 1.0.0 is a pre-release. Initial builds of adapters are generally set up as pre-releases as there is often work that needs to be done to configure the adapter and make sure the authentication process to Microsoft_graph works appropriately.
 
 Release notes can be viewed in CHANGELOG.md.
 
-### Supported IAP Versions
+### Supported Platform Versions
 
-Itential Product adapters are built for particular versions of IAP and packaged with the versions they work with. 
+Itential Product adapters are built for particular versions of Platform and packaged with the versions they work with. 
 
-Itential opensource adapter as well as custom adapters built with the Itential Adapter Builder work acoss many releases of IAP. As a result, it is not often necessary to modify an adapter when upgrading IAP. If IAP has changes that impact the pronghorn.json, like adding a new required section, this will most likely require changes to all adapters when upgrading IAP.
+Itential opensource adapter as well as custom adapters built with the Itential Adapter Builder work acoss many releases of Platform. As a result, it is not often necessary to modify an adapter when upgrading Platform. If Platform has changes that impact the pronghorn.json, like adding a new required section, this will most likely require changes to all adapters when upgrading Platform.
 
-Many of the scripts that come with all adapters built using the Itential Adapter Builder do have some dependencies on IAP or the IAP database schema and so it is possible these scripts could stop working in different versions of IAP. If you notify Itential of any issues, the Adapter Team will attempt to fix the scripts for newer releases of IAP.
+Many of the scripts that come with all adapters built using the Itential Adapter Builder do have some dependencies on Platform or the Platform database schema and so it is possible these scripts could stop working in different versions of Platform. If you notify Itential of any issues, the Adapter Team will attempt to fix the scripts for newer releases of Platform.
 
 ### Getting Started
 
@@ -72,7 +73,7 @@ There is <a href="https://docs.itential.com/opensource/docs/adapters" target="_b
 
 ```text
 Authentication
-IAP Service Instance Configuration
+Platform Service Instance Configuration
 Code Files
 Endpoint Configuration (Action & Schema)
 Mock Data
@@ -120,10 +121,6 @@ The following list of packages are required for Itential opensource adapters or
     <td style="padding:15px">commander</td>
     <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
   </tr>
-  <tr>
-    <td style="padding:15px">dns-lookup-promise</td>
-    <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
-  </tr>
   <tr>
     <td style="padding:15px">fs-extra</td>
     <td style="padding:15px">Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality.</td>
@@ -176,18 +173,24 @@ testdouble
 
 #### How to Install
 
-1. Set up the name space location in your IAP node_modules.
+1a. If you are working on Itential Platform 2023.2 or earlier versions, set up the name space location in your Itential Platform node_modules.
 
 ```bash
 cd /opt/pronghorn/current/node_modules (* could be in a different place)
 if the @itentialopensource directory does not exist, create it:
     mkdir @itentialopensource
+cd @itentialopensource
 ```
 
-2. Clone/unzip/tar the adapter into your IAP environment.
+1b. If you are working on Platform 6, you need to install the adapter in the services directory.
+
+```bash
+cd /opt/itential/platform/services (* you may have configured it to be in a different place)
+```
+
+2. Clone/unzip/tar the adapter into your Platform environment.
 
 ```bash
-cd @itentialopensource
 git clone git@gitlab.com:@itentialopensource/adapters/adapter-microsoft_graph
 or
 unzip adapter-microsoft_graph.zip
@@ -195,7 +198,7 @@ or
 tar -xvf adapter-microsoft_graph.tar
 ```
 
-3. Run the adapter install script.
+3. install the adapter dependencies.
 
 ```bash
 cd adapter-microsoft_graph
@@ -204,17 +207,17 @@ npm run lint:errors
 npm run test
 ```
 
-4. Restart IAP
+4. Restart Platform
 
 ```bash
 systemctl restart pronghorn
 ```
 
-5. Create an adapter service instance configuration in IAP Admin Essentials GUI
+5. Create an adapter service instance configuration in Platform Admin Essentials GUI
 
 6. Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.
 
-7. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
+7. Change the adapter service instance configuration (host, port, credentials, etc) in Platform Admin Essentials GUI
 
 #### Testing
 
@@ -266,6 +269,8 @@ Test should also be written to clean up after themselves. However, it is importa
 
 ### [Configuration](./PROPERTIES.md)
 
+### [Utilities](./UTILITIES.md)
+
 ### Additional Information
 
 #### [Enhancements](./ENHANCE.md)
@@ -278,17 +283,13 @@ Test should also be written to clean up after themselves. However, it is importa
 
 #### Node Scripts
 
-There are several node scripts that now accompany the adapter. These scripts are provided to make several activities easier. Many of these scripts can have issues with different versions of IAP as they have dependencies on IAP and Mongo. If you have issues with the scripts please report them to the Itential Adapter Team. Each of these scripts are described below.
+There are several node scripts that now accompany the adapter. These scripts are provided to make several activities easier. Many of these scripts can have issues with different versions of Platform as they have dependencies on Platform and Mongo. If you have issues with the scripts please report them to the Itential Adapter Team. Each of these scripts are described below.
 
 <table border="1" class="bordered-table">
   <tr>
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Run</span></th>
     <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
   </tr>
-  <tr>
-    <td style="padding:15px">npm run adapter:install</td>
-    <td style="padding:15px">Provides an easier way to install the adapter.</td>
-  </tr>
   <tr>
     <td style="padding:15px">npm run adapter:checkMigrate</td>
     <td style="padding:15px">Checks whether your adapter can and should be migrated to the latest foundation.</td>

package/SUMMARY.md

@@ -1,9 +1,9 @@
 ## Overview
 
-This adapter is used to integrate the Itential Automation Platform (IAP) with the Microsoft_graph System. The API that was used to build the adapter for Microsoft_graph is usually available in the report directory of this adapter. The adapter utilizes the Microsoft_graph 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.
+This adapter is used to integrate the Itential Platform with the Microsoft_graph System. The API that was used to build the adapter for Microsoft_graph is usually available in the report directory of this adapter. The adapter utilizes the Microsoft_graph API to provide the integrations that are deemed pertinent to Itential Platform. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
 
 >**Note**: It is possible that some integrations will be supported through the Microsoft_graph adapter while other integrations will not. If you need additional API calls, you can use the Update capabilities provided by the Adapter Builder or request Itential to add them if the Adapter is an Itential opensourced adapter.
 
 Itential provides information on all of its product adapters in the Customer Knowledge Base. Information in the <a href="https://itential.atlassian.net/servicedesk/customer/portals" target="_blank">Customer Knowledge Base</a> is consistently maintained and goes through documentation reviews. As a result, it should be the first place to go for information.
 
-For opensourced and custom built adapters, the ReadMe is a starting point to understand what you have built, provide the information for you to be able to update the adapter, and assist you with deploying the adapter into IAP.
+For opensourced and custom built adapters, the ReadMe is a starting point to understand what you have built, provide the information for you to be able to update the adapter, and assist you with deploying the adapter into Itential Platform.

package/SYSTEMINFO.md

@@ -13,7 +13,7 @@ We classify Microsoft Graph into the Cloud domain as Microsoft Graph serves as a
 "It provides a unified programmability model that you can use to access the tremendous amount of data in Microsoft 365, Windows, and Enterprise Mobility + Security."  
 
 ## Why Integrate
-The Microsoft Graph adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Microsoft Graph. With this adapter you have the ability to perform operations such as:
+The Microsoft Graph adapter from Itential is used to integrate the Itential Platform with Microsoft Graph. With this adapter you have the ability to perform operations such as:
 
 - Build apps for organizations and consumers. 
 - AzureAD

package/TAB1.md

@@ -1,9 +1,9 @@
 # Overview 
 
-This adapter is used to integrate the Itential Automation Platform (IAP) with the Microsoft_graph System. The API that was used to build the adapter for Microsoft_graph is usually available in the report directory of this adapter. The adapter utilizes the Microsoft_graph 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.
+This adapter is used to integrate the Itential Platform with the Microsoft_graph System. The API that was used to build the adapter for Microsoft_graph is usually available in the report directory of this adapter. The adapter utilizes the Microsoft_graph API to provide the integrations that are deemed pertinent to Itential Platform. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
 
 ## Details 
-The Microsoft Graph adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Microsoft Graph. With this adapter you have the ability to perform operations such as:
+The Microsoft Graph adapter from Itential is used to integrate the Itential Platform with Microsoft Graph. With this adapter you have the ability to perform operations such as:
 
 - Build apps for organizations and consumers. 
 - AzureAD

package/TAB2.md

@@ -11,16 +11,18 @@
 ## Specific Adapter Information
 ### Authentication
 
-This document will go through the steps for authenticating the Microsoft Graph adapter with OAuth Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>. 
+This document will go through the steps for authenticating the Microsoft Graph adapter with OAuth Authentication. Properly configuring the properties for an adapter in Itential Platform is critical for getting the adapter online. You can read more about adapter authentication <a href="https://docs.itential.com/opensource/docs/authentication" target="_blank">HERE</a>. 
 
 Companies periodically change authentication methods to provide better security. As this happens this section should be updated and contributed/merge back into the adapter repository.
 
 #### OAuth Authentication
 The Microsoft Graph adapter requires OAuth Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
 
+You will need to register an application with the <a href="https://learn.microsoft.com/en-us/graph/auth-register-app-v2" target="_blank">Microsoft identity platform</a>. After registering the application, you will be given an Application (client) ID and a Directory (tenant) ID. Then you need to click "add cert or secret" to create the client secret. This information will then be inserted into the adapter service instance configuration.
+
 STEPS  
 1. Ensure you have access to a Microsoft Graph server and that it is running
-2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
+2. Follow the steps in the README.md to import the adapter into Itential Platform if you have not already done so
 3. Use the properties below for the ```properties.authentication``` field. Note that the token_URI_path has a variable which should be replaced with a valid tenant value
 ```json
 "authentication": {
@@ -56,8 +58,8 @@ STEPS
 
 #### Troubleshooting
 - Make sure you copied over the correct client_id and client_secret.
-- 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).
+- Turn on debug level logs for the adapter in Itential Platform Admin Essentials.
+- Turn on auth_logging for the adapter in Itential Platform 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.
@@ -67,11 +69,11 @@ STEPS
 
 ### 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.
+Sample Properties can be used to help you configure the adapter in the Itential Platform. You will need to update connectivity information such as the host, port, protocol and credentials.
 
 ```json
   "properties": {
-    "host": "localhost",
+    "host": "graph.microsoft.com",
     "port": 443,
     "base_path": "/",
     "choosepath": "",
@@ -94,14 +96,14 @@ Sample Properties can be used to help you configure the adapter in the Itential
       "auth_field": "header.headers.Authorization",
       "auth_field_format": "Bearer {token}",
       "auth_logging": false,
-      "client_id": "",
-      "client_secret": "",
+      "client_id": "clientid",
+      "client_secret": "clientsecret",
       "grant_type": "client_credentials",
       "sensitive": [],
       "sso": {
-        "protocol": "",
-        "host": "",
-        "port": 0
+        "protocol": "https",
+        "host": "login.microsoftonline.com",
+        "port": 443
       },
       "multiStepAuthCalls": [
         {
@@ -167,18 +169,22 @@ Sample Properties can be used to help you configure the adapter in the Itential
       "enabled": false,
       "accept_invalid_cert": false,
       "ca_file": "",
+      "ca_file_content": "",
       "key_file": "",
       "cert_file": "",
       "secure_protocol": "",
       "ciphers": ""
     },
     "mongo": {
+      "url": "",
       "host": "",
       "port": 0,
       "database": "",
+      "dbAuth": false,
       "username": "",
       "password": "",
       "replSet": "",
+      "addSrv": false,
       "db_ssl": {
         "enabled": false,
         "accept_invalid_cert": false,

package/TROUBLESHOOT.md

@@ -1,6 +1,6 @@
 ## Troubleshoot
 
-Run `npm run troubleshoot` to start the interactive troubleshooting process. The command allows you to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into IAP.
+Run `npm run troubleshoot` to start the interactive troubleshooting process. The command allows you to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into Itential Platform.
 
 You also have the option to run individual commands to perform specific test:
 
@@ -45,3 +45,12 @@ Go into the Itential Platform GUI and verify/update the properties
 ### Functional Issues
 
 Adapter logs are located in `/var/log/pronghorn`. In older releases of the Itential Platform, there is a `pronghorn.log` file which contains logs for all of the Itential Platform. In newer versions, adapters can be configured to log into their own files.
+
+### Adapter Results
+
+The majority of the http response codes from the adapter come directly from the downstream system. There are some exceptions to this:
+
+1. Timeout (-2): There is an attempt timeout property that defines how long the adapter should wait to receive a response before giving up. If that time expires before a resonse is received the adapter will respond with a code of -2. The message will say "The Adapter has run out of time for the request" and it will recommend that you "Increase your adapter request.attempt_timeout property".
+2. Econnreset (-1): When the downstream system or something within the network drops the connection, the adapter will receive and forward an ECONNRESET error with a -1 code. The message will say "The connection was terminated by the network or external system" and the recommendation will be for you to "Check connectivity to the external system and that the system is up".
+
+The adapter will also have various errors if it is unable to build the request. All of these errors come with messages and recommendations to help you understand what you need to do to resolve the issue.