Skip to Content

Changes for page Data Exchange

Last modified by Waria on 2026/07/23 10:11
From version 21.1
edited by Waria
on 2026/07/23 10:11
Change comment: There is no comment for this version
To version 11.1
edited by Erik Bakker
on 2023/01/23 13:10
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.waria
1 +XWiki.ebakker
Content
... ... @@ -1,7 +1,6 @@
1 -{{container}}
2 -{{container layoutStyle="columns"}}
3 -(((
4 -In this section, we’ll examine how eMagiz manages data exchange between applications and integrations, focusing on security considerations for each method. eMagiz supports three main integration patterns: Messaging, API Gateway, and Event Streaming. We'll explore the security measures associated with each pattern, including options like OpenID Connect, OAuth2.0, and access control lists. By understanding these patterns and their specific security configurations, you'll be better equipped to protect data and ensure secure interactions across your integrations.
1 +{{container}}{{container layoutStyle="columns"}}(((
2 +Because eMagiz provides the integration between two or more applications via the eMagiz platform, the point at which the data is interchanged between application and integration is a critical part of the integration in terms of security.
3 +Within eMagiz, there are three main integration patterns a user can configure to support their business case most optimally. First, this section will look at all three integration types and specify the security measures.
5 5  
6 6  Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
7 7  
... ... @@ -36,16 +36,27 @@
36 36  
37 37  === 3.2 API Gateway ===
38 38  
39 -The front-end of your API Gateway can be secured using a structure with users and permissions. The security of the backend of the API Gateway can be customized just as for messaging. Confer with your external party how the backend needs to be secured.
38 +A structure with roles and rights per role can be specified within the portal or via an external IDP to secure the front end of the API Gateway in eMagiz. Note that for the backend of the API Gateway, the same logic applies as stated above for messaging, which means that eMagiz supports the industry standard. Therefore, you as a user should confer with the external party about the correct method.
40 40  
41 -eMagiz offers multiple authentication methods for API Gateway users: OAuth 2.0, Basic Auth and API Key. These can be configured per user. This means that you can choose the strongest authentication method supported by the consuming application.
42 -
43 -For OAuth 2.0 eMagiz hosts an authorization server per customer environment which functions as the IDP (identity provider). By communicating with this IDP via the OAuth2.0 protocol, a check is done every time a client calls a specific operation to see whether that client can access the API Gateway and has sufficient rights to access the operation.
44 -
45 -Although users can authenticate using OAuth 2.0, Basic Auth, or an API Key, eMagiz validates all requests through the same authorization infrastructure. Basic Auth and API Key credentials are translated internally to OAuth-based authorization, ensuring that user permissions are evaluated consistently regardless of the chosen authentication method. This centralizes authorization logic and reduces the risk of differences in security behavior between authentication mechanisms.
46 -
47 -To learn more about configuring API security and user permissions check out the [[API Gateway Crash Course>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]].
40 +==== 3.2.1 Portal ====
48 48  
42 +As shown in the picture below, the roles are defined so that the Read role can only access two integrations available for this specific API Gateway. If a client has insufficient rights, they will receive a 401 Unauthorized
43 +
44 +[[image:Main.Images.Fundamental.WebHome@fundamental-emagiz-security-guide--api-gateway-portal-feedback.png]]
45 +
46 +==== 3.2.2 (External) IDP ====
47 +
48 +Apart from configuring the roles, users, and rights within the portal itself, it is also possible to hook the API Gateway up to an (external) IDP.
49 +By communicating with this IDP via the OAuth2.0 protocol, a check is done every time a client calls a specific operation to see whether that client has sufficient rights to access the operation.
50 +
51 +If the client has sufficient rights, the process continues. For example, if the client has insufficient rights, the client receives a 401 Unauthorized.
52 +
53 +==== 3.2.3 Error Handling ====
54 +
55 +To prevent the error message if it occurs is sent straight back to the client, you can configure the front end of the API Gateway so that correct HTTP Status codes are given back to the client, including a descriptive message.
56 +
57 +For more information on how this precisely can be configured via the eMagiz platform, please check the following [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-configure-roles-and-users||target="blank"]].
58 +
49 49  === 3.3 Event Streaming ===
50 50  
51 51  Within the Event Streaming solution, eMagiz provides Event Streaming users, and topics can be created.
... ... @@ -63,25 +63,20 @@
63 63  
64 64  Regardless of the selected pattern for your solution, it would be best if you always considered that you only exchange relevant information with the external party. This means you should consider both headers as the payload you need to exchange with the external party. This is particularly interesting for any communication via HTTP gateways as they hold functionality to send all message headers as HTTP headers and vice versa.
65 65  
66 -== 4. Key takeaways ==
76 +== 4. Assignment ==
67 67  
78 +Check whether you might be exchanging too much information with an external party within your project.
79 +This assignment can be completed within the (Academy) project you created/used in the previous assignment.
80 +
81 +== 5. Key takeaways ==
82 +
68 68  * Each pattern comes with generic and specific checks and balances to ensure security is taken care of when exchanging data.
69 69  * When you are not careful, you might share too much information with external parties.
70 70  
71 -== 5. Suggested Additional Readings ==
86 +== 6. Suggested Additional Readings ==
72 72  
73 -* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
74 -** [[eMagiz Security Guide (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-emagiz-security-guide||target="blank"]]
75 -* [[Crash Course (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
76 -** [[Crash Course API Gateway (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.WebHome||target="blank"]]
77 -*** [[API User Management (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-user-management||target="blank"]]
78 -** [[Crash Course Event Streaming (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.WebHome||target="blank"]]
79 -*** [[User Management - Event Streaming (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Event Streaming.crashcourse-eventstreaming-user-management||target="blank"]]
80 -* [[Data exchange (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=data+exchange||target="blank"]]
81 -)))
88 +If you are interested in this topic and want more information, please read the help text provided by eMagiz.
82 82  
83 -(((
84 -{{toc/}}
85 -)))
86 -{{/container}}
87 -{{/container}}
90 +== 7. Silent demonstration video ==
91 +
92 +As this is more of theoretical microlearning, there is no video accompanying the microlearning.)))((({{toc/}}))){{/container}}{{/container}}