Skip to Content
Last modified by Carlijn Kokkeler on 2024/09/03 12:28
From version 10.1
edited by Erik Bakker
on 2022/07/26 13:17
Change comment: There is no comment for this version
To version 11.1
edited by Erik Bakker
on 2022/07/26 13:40
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -expert-securing-data-traffic-api-gw-security-external-idp
1 +API Gateway Security - External IDP
Content
... ... @@ -9,50 +9,46 @@
9 9  
10 10  == 2. Key concepts ==
11 11  
12 -This microlearning focuses on performing image transformations in eMagiz.
12 +This microlearning focuses on using an external IDP to validate whether a user is authorized to execute a certain action on your API Gateway and what configuration is needed in eMagiz to make this work.
13 13  
14 -By image transformation, we mean transforming the raw data that represents an image into another image format.
14 +* The Token and Issuer URL of the external IDP need to be known
15 +* Users and Roles under User Management need to be manually configured and maintained to keep them in sync with the external IDP
15 15  
16 -* Read the help text of the component to understand which formats are supported
17 -* Ensure the input image is supplied in the correct format
18 -* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream
17 +== 3. External IDP ==
19 19  
20 -== 3. Image Transformation ==
19 +In the crash course on the API Gateway we discussed the various options available to [[secure>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-security.WebHome||target="blank"]] your API Gateway properly. In this microlearning, we will expand our knowledge on that topic by looking at a special case of securing your API Gateway. That case is special as you use an external identity provider (IDP) to govern the roles and users that have rights on your API Gateway.
21 21  
22 -In most cases, you will transform XML messages to other XML messages, or you will transform JSON or EDI messages in another of these formats. However, sometimes you want to perform an image transformation. With this image transformation, you can convert images in specific formats to another format (i.e., png). This can come in handy when you want to standardize the image format before using it further downstream in your business application(s).
21 +When selecting the option OAuth2.0 (or OpenID Connect) you have the option to use the IDP provided by eMagiz which makes the configuration easy or you could use an external IDP which you have control over and want to use for this purposes.
23 23  
24 -Before we dive into the specifics of how to configure this, let us first consider the following:
23 +In this microlearning we will highlight what you need to configure in Design and Deploy to make this work within the tooling of eMagiz.
25 25  
26 -* Read the help text of the component to understand which formats are supported
27 -* Ensure the input image is supplied in the correct format
28 -* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream
25 +=== 3.1 Design ===
29 29  
30 -{{warning}} This microlearning focuses on the image transformer component. Ensuring that the input is valid and the output fits the remainder of the process is highly dependent on the use case and will therefore not be discussed in this microlearning{{/warning}}
27 +On the security level of the API Gateway in Design you need to select the desired option, for example OAuth2.0. Instead of not filling in the token and issuer URL, indicating that you want to use the eMagiz IDP, you need to fill these in to reference the IDP of your choice. Below you see an example of how this could be configured.
31 31  
32 -When turning to the Create phase of eMagiz, we need to open the flow and enter "Start Editing" mode to add the necessary component. For example, in the left panel, you can search for "Image." This will yield the following result.
29 +[[image:Main.Images.Microlearning.WebHome@expert-securing-data-traffic-api-gw-security-external-idp-security-config-design.png]]
33 33  
34 -[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component.png]]
31 +Note that the environmentID in this example should be replaced with an actual environmentID that references your environment.
35 35  
36 -After dragging the component onto the canvas, you must define the channels first.
33 +=== 3.2 Deploy ===
37 37  
38 -[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component-help.png]]
35 +Normally, eMagiz will automatically update the User Management information based on the configuration in Design. However, because the identity check is not done by eMagiz but by an external party you need to manually enter the roles and users and configure the scope correctly on role level.
39 39  
40 -Secondly, we must select the desired image format we want to transform. Finally, the field indicates all valid values you can choose. Please note that 'PNG' is the default selection.
37 +To do so navigate to User Management in Deploy and add the users you want manually by pressing the New button and providing them with a name. Do subsequently the same for the roles. On role level do not forget to correctly enter the scope to make the call work. Note that the help text on the scope level gently reminds you what you need to do to make this work.
41 41  
42 -[[image:Main.Images.Microlearning.WebHome@expert-create-your-transformations-image-transformation-image-transformation-component-image-options.png]]
39 +[[image:Main.Images.Microlearning.WebHome@expert-securing-data-traffic-api-gw-security-external-idp-scope-configuration.png]]
43 43  
44 -Once you have done this, the component configuration is finished, and you can transform your input image to a desired output image format.
41 +{{warning}}When implementing this you would be the first to do so with this setup. This means there might be some unexpected behavior when configuring this.{{/warning}}
45 45  
46 46  == 4. Assignment ==
47 47  
48 -Check whether the solution we discussed today can be found within your project.
49 -This assignment can be completed within the (Academy) project you created/used in the previous assignment.
45 +No assignment
50 50  
51 51  == 5. Key takeaways ==
52 52  
53 -* Read the help text of the component to understand which formats are supported
54 -* Ensure the input image is supplied in the correct format
55 -* Ensure you wrap the output image in something if you want to do additional transformations on the data further downstream
49 +* The Token and Issuer URL of the external IDP need to be known
50 +* Users and Roles under User Management need to be manually configured and maintained to keep them in sync with the external IDP
51 +* When implementing this you would be the first to do so with this setup.
56 56  
57 57  == 6. Suggested Additional Readings ==
58 58