Certificates - eMagiz

(((

In this microlearning, we will focus on the action to configure a certificate and link it to a route. As a best practice, we secure hosted web services within the messaging engine with a certificate. In the previous microlearning, we learned about routes. Now we will focus on the certificate part.

6

7

Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].

8

9

== 1. Prerequisites ==

10

11

* Basic knowledge of the eMagiz platform

12

* Basic knowledge of cloud management

13

14

== 2. Key concepts ==

15

16

This microlearning centers around certificates

17

With certificates, we mean: A trustworthy document that is interchanged between parties to verify that both parties are who they claim to be

18

19

It is a best practice to either secure your web service with the help of OAuth2.0 (note this only works for REST) or with a combination of API-Key and certificate (works for both SOAP as REST).

20

In this microlearning, we will focus on the latter of the two options and focus specifically on the configuration that is needed on the eMagiz Cloud level to ensure that only clients that can provide a valid certificate are given access to the web service.

21

22

* Configuration on eMagiz Cloud level is done via Deploy -> Architecture

23

* Certificate is generated via the support department (with or without CSR)

24

* No actions are needed on flow level, only on Cloud level

25

* All you need for the configuration is the common name of the certificate

26

27

== 3. Certificates ==

28

29

In this microlearning, we will focus on the action to configure a certificate and link it to a route. As a best practice, we secure hosted web services within the messaging engine with a certificate. In the previous microlearning, we learned about routes. Now we will focus on the certificate part.

30

31

It is a best practice to either secure your web service with the help of OAuth2.0 (note this only works for REST) or with a combination of API-Key and certificate (works for both SOAP as REST).

32

In this microlearning, we will focus on the latter of the two options and focus specifically on the configuration that is needed on the eMagiz Cloud level to ensure that only clients that can provide a valid certificate are given access to the web service.

33

34

Important things to remember are:

35

36

* Configuration on eMagiz Cloud level is done via Deploy -> Architecture

37

* Certificate is generated via the support department (with or without CSR)

38

* No actions are needed on flow level, only on Cloud level

39

* All you need for the configuration is the common name of the certificate

40

41

Now that we have introduced the topic let us see how to configure the certificate within Deploy -> Architecture. The first step is to open the Deploy phase of the project for which you want to configure the certificate. After that, you need to select the correct environment (TAP). In this environment open the Architecture page. On this page, you can manage everything related to the eMagiz Cloud.

42

43

Among others, you can also configure your certificates. To do so open the context menu via a right-mouse click on the whitespace alongside your landscape overview. Note that you need to be in "Start Editing" mode to configure certificates.

44

45

[[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-cloud-management-certificates--certificates-context-menu.png]]

46

47

In the pop-up that follows press New or Edit (in case you want to change an existing certificate configuration). In this microlearning, we use the option New. The following pop-up will be shown:

48

49

[[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-cloud-management-certificates--pop-up-certificate-details-empty.png]]

50

51

In this pop-up, you enter the Common Name (as received from Support) and a Client Name (can be anything you like). The result should be something as follows:

52

53

[[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-cloud-management-certificates--pop-up-certificate-details-filled-in.png]]

54

55

The moment you are satisfied with your result press Save. Close the other pop-up and open the context menu again. This time select the option Routes. For this example, we assume the route already exists.

56

57

[[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-cloud-management-certificates--routes-context-menu.png]]

58

59

Select the route that belongs to the runtime in which you are hosting the web service and press Edit.

60

61

[[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-cloud-management-certificates--route-edit-screen.png]]

62

63

In here click on the icon on the right of the certificate entry and select the correct Certificate in the pop-up that is presented. After you have selected it eMagiz will automatically link the certificate to the route as shown below.

64

65

[[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-cloud-management-certificates--route-edit-screen-filled-in.png]]

66

67

When you are content press Save. The only thing left to do after this is to actualize the changes in the eMagiz Cloud. You can do so by pressing the Apply to environment button (more on that in the following microlearning). Note that this button will apply all changes so in case of others have also made changes these will also be automatically changed in the eMagiz Cloud. So always think before you act.

== 4. Assignment ==

There is no assignment for this microlearning.

72

73

== 5. Key takeaways ==

74

75

* By restarting the runtime, you restart all flows (including infra) of the runtime you have selected

76

* Flows return in original state

77

78

== 6. Suggested Additional Readings ==

79

80

There are no suggested additional readings on this topic

81

82

== 7. Silent demonstration video ==

83

84

There is no demonstration video of this functionality.)))

85

86

((({{toc/}}))){{/container}}

87

author	version	line-number	content
		1	{{container}}
		2	{{container layoutStyle="columns"}}
		3	(((
		4
		5	In this microlearning, we will focus on the action to configure a certificate and link it to a route. As a best practice, we secure hosted web services within the messaging engine with a certificate. In the previous microlearning, we learned about routes. Now we will focus on the certificate part.
		6
		7	Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
		8
		9	== 1. Prerequisites ==
		10
		11	* Basic knowledge of the eMagiz platform
		12	* Basic knowledge of cloud management
		13
		14	== 2. Key concepts ==
		15
		16	This microlearning centers around certificates
		17	With certificates, we mean: A trustworthy document that is interchanged between parties to verify that both parties are who they claim to be
		18
		19	It is a best practice to either secure your web service with the help of OAuth2.0 (note this only works for REST) or with a combination of API-Key and certificate (works for both SOAP as REST).
		20	In this microlearning, we will focus on the latter of the two options and focus specifically on the configuration that is needed on the eMagiz Cloud level to ensure that only clients that can provide a valid certificate are given access to the web service.
		21
		22	* Configuration on eMagiz Cloud level is done via Deploy -> Architecture
		23	* Certificate is generated via the support department (with or without CSR)
		24	* No actions are needed on flow level, only on Cloud level
		25	* All you need for the configuration is the common name of the certificate
		26
		27	== 3. Certificates ==
		28
		29	In this microlearning, we will focus on the action to configure a certificate and link it to a route. As a best practice, we secure hosted web services within the messaging engine with a certificate. In the previous microlearning, we learned about routes. Now we will focus on the certificate part.
		30
		31	It is a best practice to either secure your web service with the help of OAuth2.0 (note this only works for REST) or with a combination of API-Key and certificate (works for both SOAP as REST).
		32	In this microlearning, we will focus on the latter of the two options and focus specifically on the configuration that is needed on the eMagiz Cloud level to ensure that only clients that can provide a valid certificate are given access to the web service.
		33
		34	Important things to remember are:
		35
		36	* Configuration on eMagiz Cloud level is done via Deploy -> Architecture
		37	* Certificate is generated via the support department (with or without CSR)
		38	* No actions are needed on flow level, only on Cloud level
		39	* All you need for the configuration is the common name of the certificate
		40
		41	Now that we have introduced the topic let us see how to configure the certificate within Deploy -> Architecture. The first step is to open the Deploy phase of the project for which you want to configure the certificate. After that, you need to select the correct environment (TAP). In this environment open the Architecture page. On this page, you can manage everything related to the eMagiz Cloud.
		42
		43	Among others, you can also configure your certificates. To do so open the context menu via a right-mouse click on the whitespace alongside your landscape overview. Note that you need to be in "Start Editing" mode to configure certificates.
		44
		45	[[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-cloud-management-certificates--certificates-context-menu.png]]
		46
		47	In the pop-up that follows press New or Edit (in case you want to change an existing certificate configuration). In this microlearning, we use the option New. The following pop-up will be shown:
		48
		49	[[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-cloud-management-certificates--pop-up-certificate-details-empty.png]]
		50
		51	In this pop-up, you enter the Common Name (as received from Support) and a Client Name (can be anything you like). The result should be something as follows:
		52
		53	[[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-cloud-management-certificates--pop-up-certificate-details-filled-in.png]]
		54
		55	The moment you are satisfied with your result press Save. Close the other pop-up and open the context menu again. This time select the option Routes. For this example, we assume the route already exists.
		56
		57	[[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-cloud-management-certificates--routes-context-menu.png]]
		58
		59	Select the route that belongs to the runtime in which you are hosting the web service and press Edit.
		60
		61	[[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-cloud-management-certificates--route-edit-screen.png]]
		62
		63	In here click on the icon on the right of the certificate entry and select the correct Certificate in the pop-up that is presented. After you have selected it eMagiz will automatically link the certificate to the route as shown below.
		64
		65	[[image:Main.Images.Microlearning.WebHome@intermediate-emagiz-cloud-management-certificates--route-edit-screen-filled-in.png]]
		66
		67	When you are content press Save. The only thing left to do after this is to actualize the changes in the eMagiz Cloud. You can do so by pressing the Apply to environment button (more on that in the following microlearning). Note that this button will apply all changes so in case of others have also made changes these will also be automatically changed in the eMagiz Cloud. So always think before you act.
		68
		69	== 4. Assignment ==
		70
		71	There is no assignment for this microlearning.
		72
		73	== 5. Key takeaways ==
		74
		75	* By restarting the runtime, you restart all flows (including infra) of the runtime you have selected
		76	* Flows return in original state
		77
		78	== 6. Suggested Additional Readings ==
		79
		80	There are no suggested additional readings on this topic
		81
		82	== 7. Silent demonstration video ==
		83
		84	There is no demonstration video of this functionality.)))
		85
		86	((({{toc/}}))){{/container}}
		87	{{/container}}

Wiki source code of Certificates