@itentialopensource/adapter-alkira 0.1.1

package/entities/Users/mockdatafiles/createUsersUsingPOST-default.json

@@ -0,0 +1,17 @@
+{
+  "email": "john@abc.com",
+  "firstName": "John",
+  "id": "78772b5e-ed20-11ea-adc1-0242ac120777",
+  "idpId": "78772b5e-ed20-11ea-adc1-0242ac120002",
+  "lastLoggedIn": 8,
+  "lastName": "Doe",
+  "password": "string",
+  "roles": [
+    "netadmin"
+  ],
+  "tenantId": "1",
+  "userName": "john",
+  "userType": null,
+  "jwksUri": "https://www.alkira.com",
+  "serviceProvider": null
+}

package/entities/Users/mockdatafiles/getAllUsersUsingGET-default.json

@@ -0,0 +1,70 @@
+[
+  {
+    "email": "john@abc.com",
+    "firstName": "John",
+    "id": "78772b5e-ed20-11ea-adc1-0242ac120777",
+    "idpId": "78772b5e-ed20-11ea-adc1-0242ac120002",
+    "lastLoggedIn": 8,
+    "lastName": "Doe",
+    "password": "string",
+    "roles": [
+      "netadmin"
+    ],
+    "tenantId": "1",
+    "userName": "john",
+    "userType": null,
+    "jwksUri": "https://www.alkira.com",
+    "serviceProvider": null
+  },
+  {
+    "email": "john@abc.com",
+    "firstName": "John",
+    "id": "78772b5e-ed20-11ea-adc1-0242ac120777",
+    "idpId": "78772b5e-ed20-11ea-adc1-0242ac120002",
+    "lastLoggedIn": 1,
+    "lastName": "Doe",
+    "password": "string",
+    "roles": [
+      "netadmin"
+    ],
+    "tenantId": "1",
+    "userName": "john",
+    "userType": null,
+    "jwksUri": "https://www.alkira.com",
+    "serviceProvider": null
+  },
+  {
+    "email": "john@abc.com",
+    "firstName": "John",
+    "id": "78772b5e-ed20-11ea-adc1-0242ac120777",
+    "idpId": "78772b5e-ed20-11ea-adc1-0242ac120002",
+    "lastLoggedIn": 5,
+    "lastName": "Doe",
+    "password": "string",
+    "roles": [
+      "netadmin"
+    ],
+    "tenantId": "1",
+    "userName": "john",
+    "userType": null,
+    "jwksUri": "https://www.alkira.com",
+    "serviceProvider": null
+  },
+  {
+    "email": "john@abc.com",
+    "firstName": "John",
+    "id": "78772b5e-ed20-11ea-adc1-0242ac120777",
+    "idpId": "78772b5e-ed20-11ea-adc1-0242ac120002",
+    "lastLoggedIn": 1,
+    "lastName": "Doe",
+    "password": "string",
+    "roles": [
+      "netadmin"
+    ],
+    "tenantId": "1",
+    "userName": "john",
+    "userType": null,
+    "jwksUri": "https://www.alkira.com",
+    "serviceProvider": null
+  }
+]

package/entities/Users/mockdatafiles/getUsersByIdUsingGET-default.json

@@ -0,0 +1,17 @@
+{
+  "email": "john@abc.com",
+  "firstName": "John",
+  "id": "78772b5e-ed20-11ea-adc1-0242ac120777",
+  "idpId": "78772b5e-ed20-11ea-adc1-0242ac120002",
+  "lastLoggedIn": 10,
+  "lastName": "Doe",
+  "password": "string",
+  "roles": [
+    "netadmin"
+  ],
+  "tenantId": "1",
+  "userName": "john",
+  "userType": null,
+  "jwksUri": "https://www.alkira.com",
+  "serviceProvider": null
+}

package/entities/Users/mockdatafiles/updateUsersByIdUsingPUT-default.json

@@ -0,0 +1,17 @@
+{
+  "email": "john@abc.com",
+  "firstName": "John",
+  "id": "78772b5e-ed20-11ea-adc1-0242ac120777",
+  "idpId": "78772b5e-ed20-11ea-adc1-0242ac120002",
+  "lastLoggedIn": 6,
+  "lastName": "Doe",
+  "password": "string",
+  "roles": [
+    "netadmin"
+  ],
+  "tenantId": "1",
+  "userName": "john",
+  "userType": null,
+  "jwksUri": "https://www.alkira.com",
+  "serviceProvider": null
+}

package/entities/Users/schema.json

@@ -0,0 +1,25 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "getAllUsersUsingGET",
+      "enum": [
+        "getAllUsersUsingGET",
+        "createUsersUsingPOST",
+        "getUsersByIdUsingGET",
+        "updateUsersByIdUsingPUT",
+        "deleteUsersByIdUsingDELETE",
+        "getUserProfileUsingGET",
+        "updateUserProfileUsingPUT"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/entities/ZscalerInternetAccessServices/action.json

@@ -0,0 +1,106 @@
+{
+  "actions": [
+    {
+      "name": "getZscalerInternetAccessServices",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/tenantnetworks/{pathv1}/zscaler-internet-access-services?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getZscalerInternetAccessServices-default.json"
+        }
+      ]
+    },
+    {
+      "name": "createZscalerInternetAccessService",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/tenantnetworks/{pathv1}/zscaler-internet-access-services?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getZscalerInternetAccessService",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/tenantnetworks/{pathv1}/zscaler-internet-access-services/{pathv2}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "updateZscalerInternetAccessService",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/tenantnetworks/{pathv1}/zscaler-internet-access-services/{pathv2}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "deleteZscalerInternetAccessService",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/tenantnetworks/{pathv1}/zscaler-internet-access-services/{pathv2}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/ZscalerInternetAccessServices/mockdatafiles/getZscalerInternetAccessServices-default.json

@@ -0,0 +1,84 @@
+[
+  {
+    "billingTags": [
+      9,
+      4,
+      4,
+      3
+    ],
+    "cxp": "US-WEST",
+    "description": "Service connecting to US west PoP.",
+    "id": 12345,
+    "internalName": "svc-zia-9ec0a944-f7ae-4140-ae36-e789e5ad",
+    "ipsecConfiguration": {
+      "espDhGroupNumber": null,
+      "espEncryptionAlgorithm": null,
+      "espIntegrityAlgorithm": null,
+      "ikeDhGroupNumber": null,
+      "ikeEncryptionAlgorithm": null,
+      "ikeIntegrityAlgorithm": null,
+      "localFqdnId": "example-site@example.com",
+      "preSharedKey": "98791ddd-d77c-4193-a275-8a49c61a2522",
+      "healthCheckType": "HTTP_PROBE",
+      "pingProbeIp": "185.46.212.88",
+      "httpProbeUrl": "gateway.zscloud.net/vpntest"
+    },
+    "name": "Zia-US-West-PoP",
+    "primaryPublicEdgeIp": "100.0.0.1",
+    "secondaryPublicEdgeIp": "200.0.0.1",
+    "segmentIds": [
+      10,
+      5
+    ],
+    "segments": [
+      "string",
+      "string"
+    ],
+    "size": null,
+    "tunnelType": null
+  },
+  {
+    "billingTags": [
+      1,
+      2,
+      10,
+      2
+    ],
+    "cxp": "US-WEST",
+    "description": "Service connecting to US west PoP.",
+    "id": 12345,
+    "internalName": "svc-zia-9ec0a944-f7ae-4140-ae36-e789e5ad",
+    "ipsecConfiguration": {
+      "espDhGroupNumber": null,
+      "espEncryptionAlgorithm": null,
+      "espIntegrityAlgorithm": null,
+      "ikeDhGroupNumber": null,
+      "ikeEncryptionAlgorithm": null,
+      "ikeIntegrityAlgorithm": null,
+      "localFqdnId": "example-site@example.com",
+      "preSharedKey": "98791ddd-d77c-4193-a275-8a49c61a2522",
+      "healthCheckType": "HTTP_PROBE",
+      "pingProbeIp": "185.46.212.88",
+      "httpProbeUrl": "gateway.zscloud.net/vpntest"
+    },
+    "name": "Zia-US-West-PoP",
+    "primaryPublicEdgeIp": "100.0.0.1",
+    "secondaryPublicEdgeIp": "200.0.0.1",
+    "segmentIds": [
+      6,
+      1,
+      3,
+      7
+    ],
+    "segments": [
+      "string",
+      "string",
+      "string",
+      "string",
+      "string",
+      "string"
+    ],
+    "size": null,
+    "tunnelType": null
+  }
+]

package/entities/ZscalerInternetAccessServices/schema.json

@@ -0,0 +1,23 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "getZscalerInternetAccessServices",
+      "enum": [
+        "getZscalerInternetAccessServices",
+        "createZscalerInternetAccessService",
+        "getZscalerInternetAccessService",
+        "updateZscalerInternetAccessService",
+        "deleteZscalerInternetAccessService"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/error.json

@@ -0,0 +1,190 @@
+{
+  "errors": [
+    {
+      "key": "Unable To Save To Database",
+      "icode": "AD.100",
+      "displayString": "Error on saving to Database $VARIABLE$",
+      "recommendation": "Verify the database connectivity and credentials"
+    },
+    {
+      "key": "Database Error",
+      "icode": "AD.101",
+      "displayString": "Database Error: $VARIABLE$",
+      "recommendation": "Verify the database connectivity, schema and permissions"
+    },
+    {
+      "key": "Database Credentials",
+      "icode": "AD.102",
+      "displayString": "Database Error: Invalid Credentials",
+      "recommendation": "Verify the database credentials"
+    },
+    {
+      "key": "No Queue Item",
+      "icode": "AD.110",
+      "displayString": "Queue Item $VARIABLE$ not found in queue",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Unable To Create Queue",
+      "icode": "AD.111",
+      "displayString": "Unable to create queue: $VARIABLE$",
+      "recommendation": "Verify access to the database, redis or system memory"
+    },
+    {
+      "key": "Queue Full",
+      "icode": "AD.112",
+      "displayString": "Request $VARIABLE$ Transaction $VARIABLE$ rejected - queue full at $VARIABLE$",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Unable To Clear Queue",
+      "icode": "AD.113",
+      "displayString": "Unable to clear queue: $VARIABLE$",
+      "recommendation": "Make sure the queue exists"
+    },
+    {
+      "key": "Unable To Claim Turn",
+      "icode": "AD.114",
+      "displayString": "Request $VARIABLE$ Transaction $VARIABLE$ unable to claim license: $VARIABLE$",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Unable To Free Turn",
+      "icode": "AD.115",
+      "displayString": "Request $VARIABLE$ Transaction $VARIABLE$ unable to free license: $VARIABLE$",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Item In Wrong State",
+      "icode": "AD.116",
+      "displayString": "Queue item is in the wrong state: $VARIABLE$ ",
+      "recommendation": "Make sure the queue is working properly"
+    },
+    {
+      "key": "Missing Data",
+      "icode": "AD.300",
+      "displayString": "$VARIABLE$ is required",
+      "recommendation": "Please provide the required data"
+    },
+    {
+      "key": "Missing File",
+      "icode": "AD.301",
+      "displayString": "Can not open file $VARIABLE$",
+      "recommendation": "Verify the file exists and has proper permissions"
+    },
+    {
+      "key": "Invalid Action File",
+      "icode": "AD.302",
+      "displayString": "Invalid action file: $VARIABLE$ in $VARIABLE$",
+      "recommendation": "Verify the action file"
+    },
+    {
+      "key": "Unsupported Protocol",
+      "icode": "AD.303",
+      "displayString": "Protocol $VARIABLE$ not currently supported",
+      "recommendation": "Verify the protocol on the action"
+    },
+    {
+      "key": "Invalid Schema File",
+      "icode": "AD.304",
+      "displayString": "Invalid schema file: $VARIABLE$ in $VARIABLE$",
+      "recommendation": "Verify the action file"
+    },
+    {
+      "key": "Invalid Properties",
+      "icode": "AD.305",
+      "displayString": "Invalid properties: $VARIABLE$",
+      "recommendation": "Verify the properties for the adapter"
+    },
+    {
+      "key": "Missing Properties",
+      "icode": "AD.306",
+      "displayString": "Property $VARIABLE$ is required",
+      "recommendation": "Please provide the required property"
+    },
+    {
+      "key": "Query Not Translated",
+      "icode": "AD.310",
+      "displayString": "Query Not Translated",
+      "recommendation": "Verify the information passed in the query object"
+    },
+    {
+      "key": "Payload Not Translated",
+      "icode": "AD.311",
+      "displayString": "Payload Not Translated",
+      "recommendation": "Verify the information passed in the payload object"
+    },
+    {
+      "key": "Schema Validation Failure",
+      "icode": "AD.312",
+      "displayString": "Schema validation failed on $VARIABLE$",
+      "recommendation": "Verify the information provided is in the correct format with everything required"
+    },
+    {
+      "key": "Entity Cache Not Loading",
+      "icode": "AD.320",
+      "displayString": "Could not load entity: $VARIABLE$, into cache",
+      "recommendation": "Verify the cache is working properly"
+    },
+    {
+      "key": "Error Verifying Entity Cache",
+      "icode": "AD.321",
+      "displayString": "Could not verify entity in cache",
+      "recommendation": "Verify the cache is working properly"
+    },
+    {
+      "key": "Unable To Authenticate",
+      "icode": "AD.400",
+      "displayString": "Unable to authenticate with $VARIABLE$, response $VARIABLE$",
+      "recommendation": "Verify the user credentials and check the response for more information"
+    },
+    {
+      "key": "Unable To Encode",
+      "icode": "AD.401",
+      "displayString": "Can not perform base64 encoding on $VARIABLE$",
+      "recommendation": "Check the authentication format"
+    },
+    {
+      "key": "Unable To Get Token",
+      "icode": "AD.402",
+      "displayString": "Unable to get token for user: $VARIABLE$",
+      "recommendation": "Verify the user credentials and the system information"
+    },
+    {
+      "key": "Error On Request",
+      "icode": "AD.500",
+      "displayString": "Error $VARIABLE$ received on request",
+      "recommendation": "Verify the request is accurate via debug logs and postman"
+    },
+    {
+      "key": "Request Timeout",
+      "icode": "AD.501",
+      "displayString": "The Adapter has run out of time for the request",
+      "recommendation": "Increase your adapter request.attempt_timeout property"
+    },
+    {
+      "key": "Invalid Response",
+      "icode": "AD.502",
+      "displayString": "Invalid response received for $VARIABLE$",
+      "recommendation": "Verify the request is accurate via debug logs and postman"
+    },
+    {
+      "key": "Failure Response",
+      "icode": "AD.503",
+      "displayString": "Failure response received for $VARIABLE$",
+      "recommendation": "Check the reason for failure in the stack trace"
+    },
+    {
+      "key": "Suspended Adapter",
+      "icode": "AD.600",
+      "displayString": "Adapter is suspended",
+      "recommendation": "Check if external system is functional and unsuspend if appropriate"
+    },
+    {
+      "key": "Caught Exception",
+      "icode": "AD.900",
+      "displayString": "Caught Exception $VARIABLE$",
+      "recommendation": "Evaluate why the exception took place"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@itentialopensource/adapter-alkira",
+  "version": "0.1.1",
+  "description": "This adapter integrates with system described as: alkiraApi.",
+  "main": "adapter.js",
+  "wizardVersion": "2.44.15",
+  "engineVersion": "1.62.7",
+  "adapterType": "http",
+  "scripts": {
+    "artifactize": "npm i && node utils/packModificationScript.js",
+    "preinstall": "node utils/setup.js && npm install --package-lock-only --ignore-scripts && npx npm-force-resolutions",
+    "deinstall": "node utils/removeHooks.js",
+    "lint": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js",
+    "lint:errors": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js --quiet",
+    "test:baseunit": "mocha test/unit/adapterBaseTestUnit.js --LOG=error",
+    "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
+    "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
+    "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
+    "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
+    "adapter:install": "npm i && node utils/tbScript.js install",
+    "adapter:checkMigrate": "node utils/checkMigrate.js",
+    "adapter:findPath": "node utils/findPath.js",
+    "adapter:migrate": "node utils/modify.js -m",
+    "adapter:update": "node utils/modify.js -u",
+    "adapter:revert": "node utils/modify.js -r",
+    "troubleshoot": "node utils/tbScript.js troubleshoot",
+    "healthcheck": "node utils/tbScript.js healthcheck",
+    "basicget": "node utils/tbScript.js basicget",
+    "connectivity": "node utils/tbScript.js connectivity",
+    "deploy": "npm publish --registry=https://registry.npmjs.org --access=public",
+    "build": "npm run deploy"
+  },
+  "keywords": [
+    "Itential",
+    "IAP",
+    "Automation",
+    "Integration",
+    "App-Artifacts",
+    "Adapter",
+    "Cloud",
+    "Alkira",
+    "Pre-Release"
+  ],
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">= 8.0.0",
+    "npm": ">= 6.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@gitlab.com:itentialopensource/adapters/cloud/adapter-alkira.git"
+  },
+  "author": "Itential",
+  "homepage": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-alkira#readme",
+  "dependencies": {
+    "@itentialopensource/adapter-utils": "^4.48.0",
+    "ajv": "^6.12.0",
+    "axios": "^0.21.0",
+    "commander": "^2.20.0",
+    "esprima": "^4.0.1",
+    "fs-extra": "^8.1.0",
+    "json-query": "^2.2.2",
+    "mocha": "^9.0.1",
+    "mocha-param": "^2.0.1",
+    "mongodb": "^4.1.0",
+    "network-diagnostics": "^0.5.3",
+    "nyc": "^15.1.0",
+    "readline-sync": "^1.4.10",
+    "semver": "^7.3.2",
+    "winston": "^3.3.3",
+    "prompts": "^2.4.2"
+  },
+  "devDependencies": {
+    "chai": "^4.3.4",
+    "eslint": "^7.29.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-json": "^3.0.0",
+    "package-json-validator": "^0.6.3",
+    "testdouble": "^3.16.1"
+  },
+  "resolutions": {
+    "minimist": "^1.2.5"
+  },
+  "private": false
+}