@itentialopensource/adapter-f5_bigiq 0.3.4 → 0.4.0

package/AUTH.md

@@ -1,31 +1,29 @@
-## Authenticating f5 BIG-IQ Adapter 
+## Authenticating F5 BIG-IQ Adapter 
 
-This document will go through the steps for authenticating the f5 BIG-IQ 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 F5 BIG-IQ adapter with the authentication methods we have worked with in the past. 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 f5 BIG-IQ 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.
+
+### Two Step Token
+The F5 BIG-IQ adapter requires Two Step Token. 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 f5 BIG-IQ server and that it is running
+1. Ensure you have access to a F5 BIG-IQ 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",
-  "username": "<username>",
-  "password": "<password>",
-  "token": "",
+  "auth_method": "request_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_field": "header.headers.X-F5-AUTH-TOKEN",
+  "auth_field_format": "{token}",
   "auth_logging": false,
-  "client_id": "",
-  "client_secret": "",
-  "grant_type": ""
 }
 ```
+you can leave all of the other properties in the authentication section, they will not be used when the auth_method is request_token.<br>
+
 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.