@itentialopensource/adapter-dna_center 0.6.1 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/AUTH.md +12 -16
  2. package/CALLS.md +1079 -22
  3. package/CHANGELOG.md +16 -0
  4. package/CONTRIBUTING.md +1 -160
  5. package/ENHANCE.md +2 -2
  6. package/README.md +32 -23
  7. package/SYSTEMINFO.md +17 -5
  8. package/adapter.js +176 -348
  9. package/adapterBase.js +549 -879
  10. package/changelogs/changelog.md +126 -0
  11. package/metadata.json +63 -0
  12. package/package.json +24 -24
  13. package/pronghorn.json +981 -642
  14. package/propertiesSchema.json +422 -31
  15. package/refs?service=git-upload-pack +0 -0
  16. package/report/adapter-openapi.json +8112 -0
  17. package/report/adapter-openapi.yaml +6581 -0
  18. package/report/adapterInfo.json +8 -8
  19. package/report/updateReport1691507686368.json +120 -0
  20. package/report/updateReport1692202684973.json +120 -0
  21. package/report/updateReport1694462616209.json +120 -0
  22. package/sampleProperties.json +63 -2
  23. package/test/integration/adapterTestBasicGet.js +2 -4
  24. package/test/integration/adapterTestConnectivity.js +91 -42
  25. package/test/integration/adapterTestIntegration.js +130 -2
  26. package/test/unit/adapterBaseTestUnit.js +388 -313
  27. package/test/unit/adapterTestUnit.js +338 -112
  28. package/utils/adapterInfo.js +1 -1
  29. package/utils/addAuth.js +1 -1
  30. package/utils/artifactize.js +1 -1
  31. package/utils/checkMigrate.js +1 -1
  32. package/utils/entitiesToDB.js +2 -2
  33. package/utils/findPath.js +1 -1
  34. package/utils/methodDocumentor.js +260 -0
  35. package/utils/modify.js +13 -15
  36. package/utils/packModificationScript.js +1 -1
  37. package/utils/pre-commit.sh +2 -0
  38. package/utils/taskMover.js +309 -0
  39. package/utils/tbScript.js +89 -34
  40. package/utils/tbUtils.js +41 -21
  41. package/utils/testRunner.js +1 -1
  42. package/utils/troubleshootingAdapter.js +9 -6
  43. package/workflows/README.md +0 -3
package/AUTH.md CHANGED
@@ -1,9 +1,9 @@
1
1
  ## Authenticating Cisco DNA Center Adapter
2
2
 
3
- This document will go through the steps for authenticating the Cisco DNA Center 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>.
3
+ This document will go through the steps for authenticating the Cisco DNA Center adapter with Two Step 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>.
4
4
 
5
- ### Basic Authentication
6
- The Cisco DNA Center adapter requires Basic Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
5
+ ### Two Step Token Authentication
6
+ The Cisco DNA Center adapter requires Two Step Token Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.
7
7
 
8
8
  STEPS
9
9
  1. Ensure you have access to a Cisco DNA Center server and that it is running
@@ -11,19 +11,14 @@ STEPS
11
11
  3. Use the properties below for the ```properties.authentication``` field
12
12
  ```json
13
13
  "authentication": {
14
- "auth_method": "basic user_password",
15
- "username": "<username>",
16
- "password": "<password>",
17
- "token": "",
18
- "token_timeout": 1800000,
19
- "token_cache": "local",
20
- "invalid_token_error": 401,
21
- "auth_field": "header.headers.Authorization",
22
- "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
23
- "auth_logging": false,
24
- "client_id": "",
25
- "client_secret": "",
26
- "grant_type": ""
14
+ "auth_method": "request_token",
15
+ "username": "<username>",
16
+ "password": "<password>",
17
+ "token_timeout": 1800000,
18
+ "token_cache": "local",
19
+ "invalid_token_error": 401,
20
+ "auth_field": "header.headers.X-Auth-Token",
21
+ "auth_field_format": "{token}",
27
22
  }
28
23
  ```
29
24
  4. Restart the adapter. If your properties were set correctly, the adapter should go online.
@@ -36,4 +31,5 @@ STEPS
36
31
  - The FULL REQUEST log to make sure the proper headers are being sent with the request.
37
32
  - The FULL BODY log to make sure the payload is accurate.
38
33
  - The CALL RETURN log to see what the other system is telling us.
34
+ - 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.
39
35
  - Remember when you are done to turn auth_logging off as you do not want to log credentials.