@itentialopensource/adapter-ciena_mcp 0.3.3 → 0.4.1

package/AUTH.md

@@ -1,9 +1,9 @@
 ## Authenticating Ciena MCP Adapter 
 
-This document will go through the steps for authenticating the Ciena MCP adapter with Basic 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://www.itential.com/automation-platform/integrations/adapters-resources/authentication/" target="_blank">HERE</a>. 
+This document will go through the steps for authenticating the Ciena MCP 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>. 
 
-### Basic Authentication
-The Ciena MCP adapter requires Basic Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
+### OAuth Authentication
+The Ciena MCP adapter requires OAuth Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
 
 STEPS  
 1. Ensure you have access to a Ciena MCP server and that it is running
@@ -11,21 +11,19 @@ STEPS
 3. Use the properties below for the ```properties.authentication``` field
 ```json
 "authentication": {
-  "auth_method": "basic user_password",
+  "auth_method": "request_token",
   "username": "<username>",
   "password": "<password>",
-  "token": "",
   "token_timeout": 1800000,
   "token_cache": "local",
   "invalid_token_error": 401,
   "auth_field": "header.headers.Authorization",
-  "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
-  "auth_logging": false,
-  "client_id": "",
-  "client_secret": "",
-  "grant_type": ""
+  "auth_field_format": "Bearer {token}",
+  "auth_logging": false
 }
 ```
+you can leave all of the other properties in the authentication section, they will not be used when the auth_method is request_token.
+
 4. Restart the adapter. If your properties were set correctly, the adapter should go online. 
 
 ### Troubleshooting
@@ -36,4 +34,5 @@ STEPS
   - 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 the username and password - including that there are erroneous spaces at the front or end.
 - Remember when you are done to turn auth_logging off as you do not want to log credentials.

package/BROKER.md

@@ -1,9 +1,9 @@
-## Integrating Ciena MCP Adapter with IAP Device Broker
+## Integrating CienaMcp Adapter with IAP Device Broker
 
-This document will go through the steps for integrating the Ciena MCP 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 CienaMcp 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.
 
 ### getDevicesFiltered
-getDevicesFiltered(options, callback) → This call returns all of the devices within Ciena MCP that match the provided filter.
+getDevicesFiltered(options, callback) → This call returns all of the devices within CienaMcp that match the provided filter.
 
 #### input