Merge pull request #202 from eclipse-tractusx/chore/add-data-flow-dia…

…gram

docs(data-flow): improve diagram

developer/Technical Documentation/Architecture/Data-Flow.md

@@ -0,0 +1,121 @@
+# Data Flow Diagram
+
+```mermaid
+flowchart LR
+
+    RF("Registration")
+    PF("Portal")
+
+    RS(Registration service)
+    AS(Administration service)
+    MAS(Marketplace apps service)
+    MSS(Marketplace services service)
+    NS(Notification service)
+
+    CU-Own(Company user)
+
+    NC1("Potential new company (admin)")
+    CU-Shared1(Company user)
+
+    NC2("Potential new company (admin)")
+    CU-Shared2(Company user)
+
+    NC3("Potential new company (admin)")
+    CU-Shared3(Company user)
+
+    K("Keycloak (REST API)")
+
+    BPDM(Business Partner Data Management)
+    SDT(Semantic Hub)
+    SDF("SD Factory \n (Self Description)")
+    MIW(Managed Identity Wallets)
+
+    CH(Gaia-X Clearing House)
+    OSP("Onboarding Service Provider \n (Owns infrastructure \n e.g. IAM, portal and registration app, \n other core services) ")
+
+    subgraph Portal
+        subgraph Frontend
+        RF
+        PF
+        end
+        subgraph Backend
+        RS
+        AS
+        MAS
+        MSS
+        NS
+        end
+    PDB[(Portal DB \n Postgres \n EF Core for mapping \n objects to SQL)]
+    end
+    subgraph operator[Operator IdP]
+      subgraph centralidp[centralidp Keycloak]
+      K
+      end
+      subgraph sharedidp[sharedidp Keycloak]
+        subgraph companyrealm1[Company realm]
+        NC1
+        CU-Shared1
+        end
+        subgraph companyrealm2[Company realm]
+        NC2
+        CU-Shared2
+        end
+        subgraph companyrealm3[Company realm]
+        NC3
+        CU-Shared3
+        end
+      end
+    end
+    subgraph ownIdP
+    CU-Own
+    end
+    subgraph cross[Catena-X Cross functions]
+    BPDM
+    SDT
+    SDF
+    MIW
+    OSP
+    end
+    subgraph ext["External Services (3rd party)"]
+    CH
+    end
+
+    RS <-->|Company data \n user role data \n T&C / consent agreements| RF
+    RS <--> K
+    RS -->|Company data \n user role data \n T&C consent agreements| PDB
+
+    AS --> K
+    AS <--> PF
+    AS -->|"User data \n (real and technical company data)"| PDB
+    AS ---|Data related to \n self description| SDF
+    AS -->|"Create MIW-tenant \n update MIW-tenant (BPN-VC, Member-VC) \n update MIW-framework-VC \n update dismantler-VC \n data: BPN, Auth, Contract, Version"| MIW
+    AS <-->|Company data \n signed self description| CH
+    AS <-->|OSP registers its customer \n Company Data \n Admin User Record| OSP
+
+    NS --> PDB & PF & K
+
+    BPDM -->|"Company data (e.g. name, etc.)"| RF
+    BPDM -->|"Company data (e.g. BPN)"| AS
+
+    MAS -->|Company app subscription data \n app service data + user preferences| PDB
+    MAS <--> K & PF
+
+    MSS <--> PF & K
+    MSS -->|Company app subscription data \n app service data + user preferences| PDB
+
+    SDF <--> CH
+
+    SDT -->|Product meta data| PF
+
+    NC1 & CU-Shared1 & NC2 & CU-Shared2 & NC3 & CU-Shared3 & CU-Own --> |OIDC| K
+
+    K <--> |"Authentication/authorization data (using JWT)"| RF & PF
+```
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/portal-assets

docs/03. User Management/01. User Account/04. Create new user account (bulk).md

@@ -11,14 +11,15 @@ Please note that it is suggested to separate the bulk user create groups per rol
 <br>
 
 #### Preparation
+
 The bulk user creation overlay allows you to download the csv template.
 Download the template to get started and fill out the necessary details - each user account needs to get added in a own row.
 
 Depending on your IdP type, the mandatory fields might differ - generally following attributes are needed per user
 
-* first name
-* last name
-* email
+- first name
+- last name
+- email
 
 Make sure that you do not add duplicates. In case you do, they will run on an error while creating.
 
@@ -36,9 +37,9 @@ Make sure that you do not add duplicates. In case you do, they will run on an er
 As soon as you have added all necessary users successfully, upload the csv file via the provided drag&drop element.
 Details steps:
 
-* Locate and select the 'Upload CSV' or similar option
-* Choose your prepared CSV file from your local storage
-* Confirm the upload to proceed
+- Locate and select the 'Upload CSV' or similar option
+- Choose your prepared CSV file from your local storage
+- Confirm the upload to proceed
 
 ##### Validation and Error Handling:
 
@@ -48,7 +49,6 @@ Review error messages and make corrections in your CSV file as needed.
 <br>
 <br>
 
-
 #### Feedback
 
 As soon as all checks have been successful, the application process each user entry and create the respective user account. When the user creation process is finished, a summary of successful additions and any potential errors will get provided.

docs/09. Others/12. Offer Authentication Flow.md

@@ -6,12 +6,11 @@
 
 <br>
 
->> Key Concepts
->>
->> - Get an understanding of the app/service CX listing, subscription and running the service for an customer process
->> - Understand the concept of user authentication and client separation
->> - Review the troubleshooting tips (coming soon)
->>
+> > Key Concepts
+> >
+> > - Get an understanding of the app/service CX listing, subscription and running the service for an customer process
+> > - Understand the concept of user authentication and client separation
+> > - Review the troubleshooting tips (coming soon)
 
 <br>
 <br>
@@ -22,6 +21,7 @@ In the description below the high level process of app/service listing; subscrip
 The process is relevant for App Provider, Service Provider and the App/Service Customer.
 
 The integration to the operator keycloak enables:
+
 - app provider to register the application instance (per customer)
 - app provider separate app customer instances (each instance has a own client)
 - customer to assign app user roles to their company user members and get access to the app client
@@ -33,11 +33,9 @@ The integration to the operator keycloak enables:
 
 <img width="756" alt="image" src="/docs/static/high-level-app-process.png">
 
-
 <br>
 <br>
 
-
 ## Background Information
 
 ### Client Concept
@@ -47,14 +45,17 @@ This separation enhances security and manageability in the following ways:
 
 <br>
 
->> #### Isolation 
->> of Permissions: Each client application has its own set of permissions. This ensures that an application can only access the specific resources and data it needs, reducing the risk of unauthorized access.
->>
->> #### Security
->> Boundaries: Client separation establishes clear security boundaries between applications. If one client is compromised, it doesn't automatically jeopardize the security of other clients, as they operate independently.
->>
->> #### Auditing
->> and Monitoring: Separation makes it easier to monitor and audit the activities of individual clients. Suspicious behavior or security breaches can be detected more easily.
+> > #### Isolation
+> >
+> > of Permissions: Each client application has its own set of permissions. This ensures that an application can only access the specific resources and data it needs, reducing the risk of unauthorized access.
+> >
+> > #### Security
+> >
+> > Boundaries: Client separation establishes clear security boundaries between applications. If one client is compromised, it doesn't automatically jeopardize the security of other clients, as they operate independently.
+> >
+> > #### Auditing
+> >
+> > and Monitoring: Separation makes it easier to monitor and audit the activities of individual clients. Suspicious behavior or security breaches can be detected more easily.
 
 <br>
 
@@ -72,14 +73,14 @@ Overall, identity provider client separation is a best practice in identity and
 The catena-x marketplace is hosted/operated by an CX operator. As dataspace member (companies which have successfully registered for CX dataspace with one or several operators) app provider or service provider roles can get selected.
 The company role "App Provider" or "Service Provider" enables the participant to use the app/service release process to request app/service listing on the operator marketplace.
 
-To view the app registration process and the single steps - follow the link [App Registration Process](/docs/04.%20App(s)/02.%20App%20Release%20Process/index.md)
+To view the app registration process and the single steps - follow the link [App Registration Process](</docs/04.%20App(s)/02.%20App%20Release%20Process/index.md>)
 The app registration is relevant to list your offer inside the CX marketplace. Clients/Technical user accounts get created with subscription activation. (see details below)
 
 <br>
 
 ### #2 App Subscription and activation
 
-Customers are able to subscribe app/services offered inside the marketplace. [Create a subscription request](/docs/04.%20App(s)/05.%20App%20Subscription/01.%20Subscription%20Request%20(Customer).md)
+Customers are able to subscribe app/services offered inside the marketplace. [Create a subscription request](</docs/04.%20App(s)/05.%20App%20Subscription/01.%20Subscription%20Request%20(Customer).md>)
 The subscription triggers the request on the app/service provider side. The app/service provider gets informed via email and can look up the request inside the portal => app/service subscription management board. As soon as all data are reviewed, the app/service provider will ramp up the app/service in its domain and configure the app/service for the customer.  
 In most of the cases the app/service needs access to a certain core applications provided by the operator. Via the technical user the connection is supposed to get established. If the app/service provider is ready for app/service configuration, the app/service provider can generate the necessary technical user by using the app/service subscription board and select for the specific customer "configuration".  
 The configuration requests a app/service tenant url (depending on the offer type) - the endpoint url is the url with which the customer can access the app. The url is used to create the IdP app client and to configure allowed user roles (as per the defined roles by the app provider). At the end of the process, the technical user (as configured previously in the release process) is getting created and technical user client id as well as the secret is getting shared with the offer provider.
@@ -93,9 +94,9 @@ Special Note: apps have generally additional user roles defined. In this scenari
 
 ### Connected Topics
 
-* [>> Technical User Profiles]()  
-* [>> Technical Implementation Details]()  
-* [>> ...]()  
+- [>> Technical User Profiles]()
+- [>> Technical Implementation Details]()
+- [>> ...]()
 
 ## NOTICE