@itentialopensource/adapter-utils 4.46.0 → 4.47.0

package/CHANGELOG.md

@@ -1,4 +1,14 @@
 
+## 4.47.0 [08-13-2022]
+
+* Add SSO capability into service instance config
+
+Closes ADAPT-2328
+
+See merge request itentialopensource/adapter-utils!235
+
+---
+
 ## 4.46.0 [07-27-2022]
 
 * Added code to skip split string on  dot for special cases

package/lib/connectorRest.js

@@ -62,6 +62,7 @@ let tokenTimeout = -1;
 let tokenError = 401;
 let tokenPath = null;
 let tokenCache = 'local';
+let sso = null;
 const tokenList = [];
 const tokenlock = 0;
 let stub = false;
@@ -1646,6 +1647,28 @@ function buildTokenRequest(reqPath, reqBody, callProperties, callback) {
       }
 
       // specific token properties override everything (Single Sign On System)
+      if (sso && sso.host) {
+        options.hostname = sso.host;
+      }
+      if (sso && sso.port) {
+        options.port = sso.port;
+      }
+      if (sso && sso.protocol) {
+        // need to put protocol in token schema
+        if (!tokenSchema) {
+          tokenSchema = {
+            sso: {
+              protocol: sso.protocol
+            }
+          };
+        } else if (tokenSchema && !tokenSchema.sso) {
+          tokenSchema.sso = {
+            protocol: sso.protocol
+          };
+        } else if (tokenSchema && tokenSchema.sso && !tokenSchema.sso.protocol) {
+          tokenSchema.sso.protocol = sso.protocol;
+        }
+      }
       if (tokenSchema && tokenSchema.sso && tokenSchema.sso.host) {
         options.hostname = tokenSchema.sso.host;
       }
@@ -3347,19 +3370,19 @@ class ConnectorRest {
         tokenTimeout = Number(props.authentication.token_timeout);
       }
 
-      // set the token cache (required - default is local)
+      // set the token cache (optional - default is local)
       if (typeof props.authentication.token_cache === 'string') {
         tokenCache = props.authentication.token_cache;
       }
 
-      // set the auth field (required - default is null)
+      // set the auth field (optional - default is null)
       if (typeof props.authentication.auth_field === 'string') {
         authField = [props.authentication.auth_field];
       } else if (Array.isArray(props.authentication.auth_field)) {
         authField = props.authentication.auth_field;
       }
 
-      // set the auth format (required - default is null)
+      // set the auth format (optional - default is null)
       if (typeof props.authentication.auth_field_format === 'string') {
         authFormat = [props.authentication.auth_field_format];
       } else if (Array.isArray(props.authentication.auth_field_format)) {
@@ -3371,20 +3394,25 @@ class ConnectorRest {
         authLogging = props.authentication.auth_logging;
       }
 
-      // set the client id (required - default is null)
+      // set the client id (optional - default is null)
       if (typeof props.authentication.client_id === 'string') {
         clientId = props.authentication.client_id;
       }
 
-      // set the client secret (required - default is null)
+      // set the client secret (optional - default is null)
       if (typeof props.authentication.client_secret === 'string') {
         clientSecret = props.authentication.client_secret;
       }
 
-      // set the grant type (required - default is null)
+      // set the grant type (optional - default is null)
       if (typeof props.authentication.grant_type === 'string') {
         grantType = props.authentication.grant_type;
       }
+
+      // set the sso (optional - default is null)
+      if (props.authentication.sso && typeof props.authentication.sso === 'object') {
+        sso = props.authentication.sso;
+      }
     }
 
     // set the stub mode (optional - default is false)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-utils",
-  "version": "4.46.0",
+  "version": "4.47.0",
   "description": "Itential Adapter Utility Libraries",
   "scripts": {
     "postinstall": "node utils/setup.js",

package/schemas/propertiesSchema.json

@@ -252,6 +252,34 @@
           "type": "string",
           "description": "The grant type for OAuth requests - can also provide in schema",
           "default": ""
+        },
+        "sso": {
+          "type": "object",
+          "properties": {
+            "protocol": {
+              "type": "string",
+              "description": "the protocol to request token from system",
+              "default": "",
+              "enum": [
+                "http", "https", ""
+              ]
+            },
+            "host": {
+              "type": "string",
+              "description": "hostname of the authentication system",
+              "default": "",
+              "examples": [
+                "systemx.customer.com"
+              ]
+            },
+            "port": {
+              "type": "integer",
+              "description": "port on which to connect to the authentication system",
+              "default": 0,
+              "minimum": 0,
+              "maximum": 65535
+            }
+          }
         }
       },
       "required": [