@manyos/smileconnect-api 1.46.4 → 1.48.0

package/app.js

@@ -50,6 +50,7 @@ const https = require('https');
 const maxHTTPSockets = process.env.MAX_HTTP_SOCKETS || 10;
 
 const SSO_CLIENTNAME_ATTRIBUTE = process.env.SSO_CLIENTNAME_ATTRIBUTE || 'azp';
+const SSO_USERNAME_ATTRIBUTE = process.env.SSO_USERNAME_ATTRIBUTE || 'preferred_username';
 
 http.globalAgent.maxSockets = maxHTTPSockets;
 https.globalAgent.maxSockets = maxHTTPSockets;
@@ -157,7 +158,7 @@ passport.use(
             'scope': jwt_payload.scope,
             'exp': jwt_payload.exp,
             'config': clientConfig,
-            'username': jwt_payload.preferred_username
+            'username': jwt_payload[SSO_USERNAME_ATTRIBUTE]
         }
         log.debug('Passport User', jwt_payload);
         const resource_access = jwt_payload.resource_access;

package/controller/scriptController.js

@@ -7,6 +7,7 @@ const basePath = 'conf';
 const basePathGlobalScripts = basePath + '/scripts';
 
 const fetch = require('node-fetch');
+const xmlParser = require('fast-xml-parser')
 
 const {getClients} = require('../util/config');
 
@@ -79,6 +80,7 @@ async function executeCode(code, requestData, params, logStream, executedByScrip
         adapter,
         log,
         clientId,
+        xmlParser,
         script:executeScriptByScript,
         globalScriptParams,
         env: process.env,

package/docs/configuration/config.md

@@ -86,6 +86,16 @@ Sample:
 
 *SSO_CLIENTNAME_ATTRIBUTE = "preferred_username"*
 
+### SSO_USERNAME_ATTRIBUTE
+
+The attribute that contains the user name in the token. User name is used to identify admins. It is only needed for configuration.
+
+Default: *preferred_username*
+
+Sample:
+
+*SSO_CLIENTNAME_ATTRIBUTE = "email"*
+
 ### ADMIN_USERS
 
 List of users who are allowed to access /v1/appconfig endpoints.
@@ -267,6 +277,34 @@ Sample:
 
 *SSO_ISSUER=https://sso.mydomain.io/auth/realms/itsmproxy*
 
+### SSO_CLIENTNAME_ATTRIBUTE
+
+The attribute that contains the client name in the token.
+
+Default: *azp*
+
+Set this value if you only want to use a single client in the SSO and service accounts as clients in SMILEconnect. This can be used to manage your SMILEconnect clients via a directory service like LDAP/AD. [More Info](https://datatracker.ietf.org/doc/html/rfc6749#section-1.3.3)
+
+Sample:
+
+*SSO_CLIENTNAME_ATTRIBUTE = "preferred_username"*
+
+### SSO_USERNAME_ATTRIBUTE
+
+The attribute that contains the user name in the token. User name is used to identify admins. It is only needed for configuration.
+
+Default: *preferred_username*
+
+Sample:
+
+*SSO_CLIENTNAME_ATTRIBUTE = "email"*
+
+### ADMIN_USERS
+
+List of users who are allowed to access /v1/appconfig endpoints.
+
+Sample:
+ADMIN_USERS=username1, username2
 
 ## Logging
 
@@ -306,6 +344,22 @@ The URL of the OIDC Provider for user authentication
 Sample:
 *REACT_APP_SSO_URL=https://sso.mydomain.io/auth/realms/itsmproxy*
 
+since version 1.5.2:
+For manual OICD endpoint configuration you must provide all of the following parameters:
+*REACT_APP_OIDC_AUTHORIZATION_ENDPOINT=https://sso.mydomain.io/auth/realms/itsmproxy/protocol/openid-connect/auth*
+*REACT_APP_OIDC_USERINFO_ENDPOINT=https://sso.mydomain.io/auth/realms/itsmproxy/protocol/openid-connect/userinfo*
+*REACT_APP_OIDC_END_SESSION_ENDPOINT=https://sso.mydomain.io/auth/realms/itsmproxy/protocol/openid-connect/logout*
+*REACT_APP_OIDC_JWKS_URI=https://sso.mydomain.io/auth/realms/itsmproxy/protocol/openid-connect/certs*
+*REACT_APP_OIDC_TOKEN_ENDPOINT=https://sso.mydomain.io/auth/realms/itsmproxy/protocol/openid-connect/token*
+
+To allow Authorization Flow with PKCE set 
+REACT_APP_OIDC_RESPONSE_TYPE=code 
+Default value is "token id_token", which uses Implicit Flow.
+
+Use REACT_APP_OIDC_TOKEN to choose the token to use. Default is access_token
+
+Use REACT_APP_OIDC_SCOPE to choose the oidc scope
+
 ## GUI
 
 ### REACT_APP_GUI_URL

package/docs/openapi.json

@@ -2,7 +2,7 @@
     "openapi": "3.0.2",
     "info": {
         "title": "SMILEconnect",
-        "version": "1.41.4",
+        "version": "1.47.0",
         "contact": {
             "name": "manyos technology GmbH",
             "url": "https://manyos.it",
@@ -4330,6 +4330,212 @@
                     "required": false
                 }
             ]
+        },
+        "/customForms/{formAlias}": {
+            "get": {
+                "tags": [
+                    "CustomForms"
+                ],
+                "parameters": [
+                    {
+                        "name": "limit",
+                        "description": "limit the number of results returned",
+                        "schema": {
+                            "type": "integer"
+                        },
+                        "in": "query",
+                        "required": false
+                    },
+                    {
+                        "name": "offset",
+                        "description": "offset used for pagination together with limit",
+                        "schema": {
+                            "type": "integer"
+                        },
+                        "in": "query",
+                        "required": false
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "$ref": "#/components/responses/CustomFormResponseArray"
+                    }
+                },
+                "security": [
+                    {
+                        "OIDC": [
+                        ]
+                    }
+                ],
+                "summary": "Receive all records of the custom from",
+                "description": "Will return all records that are found based on the defined base query and the set limits"
+            },
+            "post": {
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/CustomFormRequest"
+                            }
+                        }
+                    },
+                    "required": true
+                },
+                "tags": [
+                    "CustomForms"
+                ],
+                "responses": {
+                    "200": {
+                        "$ref": "#/components/responses/CustomFormResponseSingle"
+                    }
+                },
+                "security": [
+                    {
+                        "OIDC": [
+                        ]
+                    }
+                ],
+                "summary": "Create a new record",
+                "description": "Create a new record in the custom form"
+            },
+            "parameters": [
+                {
+                    "name": "formAlias",
+                    "description": "The configured alias name of the custom form.",
+                    "schema": {
+                        "type": "string"
+                    },
+                    "in": "path",
+                    "required": true
+                }
+            ]
+        },
+        "/customForms/{formAlias}/search": {
+            "post": {
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/SearchRequest"
+                            }
+                        }
+                    },
+                    "required": true
+                },
+                "tags": [
+                    "CustomForms"
+                ],
+                "responses": {
+                    "200": {
+                        "$ref": "#/components/responses/CustomFormResponseArray"
+                    }
+                },
+                "security": [
+                    {
+                        "OIDC": [
+                        ]
+                    }
+                ],
+                "summary": "Execute a search in a custom form"
+            },
+            "parameters": [
+                {
+                    "examples": {
+                        "sample": {
+                            "value": "abc123"
+                        }
+                    },
+                    "name": "impersonateUser",
+                    "description": "If the clientConfig has the option allowDynamicImpersonate set to *true* then the URL Parameter *impersonateUser* can be used to determine the used Remedy User.",
+                    "schema": {
+                        "type": "string"
+                    },
+                    "in": "query",
+                    "required": false
+                },
+                {
+                    "name": "formAlias",
+                    "description": "The configured alias name of the custom form.",
+                    "schema": {
+                        "type": "string"
+                    },
+                    "in": "path",
+                    "required": true
+                }
+            ]
+        },
+        "/customForms/{formAlias}/{id}": {
+            "get": {
+                "tags": [
+                    "CustomForms"
+                ],
+                "responses": {
+                    "200": {
+                        "$ref": "#/components/responses/CustomFormResponseSingle"
+                    }
+                },
+                "security": [
+                    {
+                        "OIDC": [
+                        ]
+                    }
+                ],
+                "summary": "Get a single record",
+                "description": "Receive a single record from a custom form, identified by its id."
+            },
+            "put": {
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/CustomFormRequest"
+                            }
+                        }
+                    },
+                    "required": true
+                },
+                "tags": [
+                    "CustomForms"
+                ],
+                "responses": {
+                    "200": {
+                        "$ref": "#/components/responses/CustomFormResponseSingle"
+                    }
+                },
+                "security": [
+                    {
+                        "OIDC": [
+                        ]
+                    }
+                ],
+                "summary": "Update a record",
+                "description": "Update a single record on a custom form, identified by its id."
+            },
+            "parameters": [
+                {
+                    "name": "formAlias",
+                    "description": "The configured alias name of the custom form.",
+                    "schema": {
+                        "type": "string"
+                    },
+                    "in": "path",
+                    "required": true
+                },
+                {
+                    "examples": {
+                        "id": {
+                            "value": "ENV12345"
+                        }
+                    },
+                    "name": "id",
+                    "description": "The id record",
+                    "schema": {
+                        "type": "string"
+                    },
+                    "in": "path",
+                    "required": true
+                }
+            ]
         }
     },
     "components": {
@@ -16078,6 +16284,61 @@
                     "text": "Status Marked: Resolved by Allen",
                     "isPublic": true
                 }
+            },
+            "CustomFormRecord": {
+                "title": "Root Type for customFormRecord",
+                "description": "A record stored in a custom form. The fields (besides id) are samples and will depend on the config.",
+                "type": "object",
+                "properties": {
+                    "id": {
+                        "type": "string"
+                    },
+                    "userId": {
+                        "type": "string"
+                    },
+                    "classId": {
+                        "type": "string"
+                    },
+                    "classTitle": {
+                        "type": "string"
+                    },
+                    "location": {
+                        "type": "string"
+                    },
+                    "startDate": {
+                        "type": "string"
+                    },
+                    "cost": {
+                        "format": "int32",
+                        "type": "integer"
+                    },
+                    "department": {
+                        "type": "string"
+                    }
+                },
+                "example": {
+                    "id": "00001",
+                    "userId": "Demo",
+                    "classId": "00001",
+                    "classTitle": "Managing Within the Law",
+                    "location": "Munich, Germany",
+                    "startDate": "Mon Nov 07 16:00:00 GMT 2005",
+                    "cost": 100,
+                    "department": "Sales"
+                }
+            },
+            "CustomFormRequest": {
+                "description": "Creates a new Record in a custum form",
+                "required": [
+                    "data"
+                ],
+                "type": "object",
+                "properties": {
+                    "data": {
+                        "$ref": "#/components/schemas/CustomFormRecord",
+                        "description": ""
+                    }
+                }
             }
         },
         "responses": {
@@ -16169,6 +16430,39 @@
                     }
                 },
                 "description": "Returns deletion confirmation for the requested item"
+            },
+            "CustomFormResponseSingle": {
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "data": {
+                                    "$ref": "#/components/schemas/CustomFormRecord"
+                                }
+                            }
+                        }
+                    }
+                },
+                "description": "Returns a single custom form record"
+            },
+            "CustomFormResponseArray": {
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "data": {
+                                    "type": "array",
+                                    "items": {
+                                        "$ref": "#/components/schemas/CustomFormRecord"
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "description": "Returns an array of Custom Form Records"
             }
         },
         "securitySchemes": {
@@ -16214,6 +16508,10 @@
             "name": "CMDBObjects",
             "description": ""
         },
+        {
+            "name": "CustomForms",
+            "description": "All custom form requests"
+        },
         {
             "name": "AppConfig",
             "description": "Application Configuration"

package/docs/releases.md

@@ -2,11 +2,22 @@
 
 ## API 
 
+### 1.48.0 - 03.11.21
+Add parameter SSO_USERNAME_ATTRIBUTE to config.
+
+### 1.47.0 - 22.10.21
+Add xmlParser to scripts.
+
+See https://www.npmjs.com/package/fast-xml-parser
+
+Add customForms
+
 ### 1.46.4 - 20.10.21
 Fix known issue: Check for activation Task Phase and activate if reached
 
 ### 1.46.3 - 18.10.21
 Fix issue: Task not activated when phase already active
+
 Known issues: Tasks might get activated early
 
 ### 1.46.2 - 14.10.21
@@ -41,7 +52,9 @@ Allow also "isPublic": "true" instead of "isPublic": true for Ticket Worklogs
 
 ### 1.43.0 - 20.09.21
 Allow bypassCache option in Remedy Adapter
+
 Add support for Task Phasing
+
 Regenrate Task Flow on Task Update
 
 ### 1.42.1 - 09.09.21
@@ -53,7 +66,9 @@ Add IDs to POST Actions for After Execution Scripts
 ### 1.41.4 - 10.08.21
 
 Fix mapping for Ticket Worklogs
+
 Fix mapping for Task Worklogs
+
 Fix issue with sort in Remedy Adapter
 
 ### 1.41.0 - 03.08.21
@@ -72,6 +87,9 @@ e.g.
 
 ## Event Manager
 
+### 1.18.0 - 03.11.21
+Add parameter SSO_USERNAME_ATTRIBUTE to config.
+
 ### 1.17.1 - 01.10.21
 Fix issue: TicketNumber3 added to Event Data
 
@@ -88,6 +106,22 @@ Update Record added to [Remedy Adapter](adapter#remedy).
 The eventmanager will check all outbound webhooks for an event. If one fails, the whole Event will be set to error and the details will be added to the error message.
 
 ## GUI
+### 1.5.5 - 03.11.21
+Add Parameter REACT_APP_OIDC_SCOPE to choose the oicd scope
+
+### 1.5.4 - 03.11.21
+Add Parameter REACT_APP_OIDC_TOKEN to choose the token to use (access_token/id_token)
+
+### 1.5.3 - 03.11.21
+Allow Authorization Flow with PKCE. Added Parameter: REACT_APP_OIDC_RESPONSE_TYPE. 
+Default value is "token id_token". To use Authorization Flow with PKCE you need to set "REACT_APP_OIDC_RESPONSE_TYPE=code"
+
+### 1.5.2 - 03.11.21
+Fix: OIDC Endpoints URL are wrong for some OIDC Providers. Also added parameters for manual endpoint configuration
+
+### 1.5.1 - 22.10.21
+Custom Forms added
+
 
 ### 1.4.18 - 11.08.21
 hovering on fields in mappingtable, destroys values in "new" mapping, in some situations

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manyos/smileconnect-api",
-  "version": "1.46.4",
+  "version": "1.48.0",
   "description": "A proxy and abstraction layer for BMCs IT Service Management Suite",
   "main": "app.js",
   "scripts": {
@@ -23,6 +23,7 @@
     "express-rate-limit": "^5.2.6",
     "express-request-id": "^1.4.1",
     "express-validator": "^6.10.1",
+    "fast-xml-parser": "^3.20.3",
     "moment": "^2.29.1",
     "mongoose": "^5.12.5",
     "node-cache": "^4.2.1",