@itentialopensource/adapter-viptela 0.10.7 → 0.11.0

package/AUTH.md

@@ -1,39 +1,46 @@
-## Authenticating Viptela Adapter 
+## Authenticating Viptela Adapter
 
-This document will go through the steps for authenticating the Viptela 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 Viptela adapter with Dynamic Token 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 Viptela adapter requires Basic Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
+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.
 
-STEPS  
+### Dynamic Token Authentication
+The Viptela adapter authenticates with a dynamic token.
+
+STEPS
 1. Ensure you have access to a Viptela 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
 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_timeout": 180000,
   "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": [
+    "header.headers.Cookie",
+    "header.headers.X-XSRF-TOKEN",
+    "header.headers.Authorization"
+  ],
+  "auth_field_format": [
+    "JSESSIONID={token}",
+    "{tokenp2}",
+    "Basic {b64}{username}:{password}{/b64}"
+  ],
 }
 ```
-4. Restart the adapter. If your properties were set correctly, the adapter should go online. 
+you can leave all of the other properties in the authentication section, they will not be used for Viptela dynamic token authentication.
+4. 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.
+- Make sure you copied over the correct username and password as these are used to retrieve the token.
 - 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 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.