AzureOAuthSMTP Plugin - Revision history

Denischenu: FeatureStarting + Category

2024-06-28T06:51:13Z

FeatureStarting + Category

← Older revision		Revision as of 08:51, 28 June 2024
Line 1:		Line 1:
			{{FeatureStarting\|6.3.0}}

	== Tutorial: How to use the AzureOAuthSMTP plugin for LimeSurvey ==		== Tutorial: How to use the AzureOAuthSMTP plugin for LimeSurvey ==

Line 75:		Line 77:
	* Environment Setup		* Environment Setup
	https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app		https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app

			[[Category:Plugins]][[Category:Core Plugins]]

C schmitz: /* Activate the AzureOAuthSMTP plugin in LimeSurvey. */

2024-03-08T14:58:53Z

Activate the AzureOAuthSMTP plugin in LimeSurvey.

← Older revision		Revision as of 16:58, 8 March 2024
Line 28:		Line 28:
	==== Activate the AzureOAuthSMTP plugin in LimeSurvey. ====		==== Activate the AzureOAuthSMTP plugin in LimeSurvey. ====

	# Go to the ''Plugins'' page in LimeSurvey.		# Go to the ''Plugins'' page in LimeSurvey and look for the AzureOAuthSMTP plugin.
	# ~~Find~~ the AzureOAuthSMTP plugin and ~~click~~ ''Activate''.		# If you can't find the AzureOAuthSMTP plugin in the list of available plugins, click the 'Scan files' button, and install the plugin first.
			# Click ''Activate'' to activate the plugin.

	==== Configure the AzureOAuthSMTP plugin in LimeSurvey. ====		==== Configure the AzureOAuthSMTP plugin in LimeSurvey. ====

Gabrieljenik at 14:06, 23 November 2023

2023-11-23T14:06:26Z

← Older revision		Revision as of 16:06, 23 November 2023
Line 7:		Line 7:
	=== Instructions ===		=== Instructions ===

	==== Set up the OAuth 2.0 Web Application in Azure Portal. ====		==== Set up the OAuth 2.0 Web Application in Azure Portal ====

	# Go to the Azure Portal and sign in.		# Go to the Azure Portal and sign in.
Line 17:		Line 17:
	[[File:AzureOAuthSMTP_Plugin_(5).jpeg\|600px\|thumb\|left]]		[[File:AzureOAuthSMTP_Plugin_(5).jpeg\|600px\|thumb\|left]]

	==== Once your web app is created, you will land on the ''Overview'' tab. ~~====~~		==== Configure the OAuth 2.0 Web Application ====

			Once your web app is created, you will land on the ''Overview'' tab.

	# Focus on the ''Essentials'' section.		# Focus on the ''Essentials'' section.

Gabrieljenik at 14:00, 23 November 2023

2023-11-23T14:00:14Z

← Older revision		Revision as of 16:00, 23 November 2023
Line 62:		Line 62:
	* If you are using a self-hosted version of LimeSurvey, you will need to configure your web server to allow HTTPS traffic.		* If you are using a self-hosted version of LimeSurvey, you will need to configure your web server to allow HTTPS traffic.
	* If you are using a cloud-hosted version of LimeSurvey, such as Limesurvey Cloud, you will not need to configure HTTPS traffic.		* If you are using a cloud-hosted version of LimeSurvey, such as Limesurvey Cloud, you will not need to configure HTTPS traffic.

			=== References ===

			Please find below some additional documentation which could be usefull:

			* General OAuth Azure Process
			https://learn.microsoft.com/en-us/exchange/client-developer/legacy-protocols/how-to-authenticate-an-imap-pop-smtp-application-by-using-oauth

			* Environment Setup
			https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app

Gabrieljenik at 13:56, 23 November 2023

2023-11-23T13:56:42Z

← Older revision		Revision as of 15:56, 23 November 2023
Line 22:		Line 22:
	# Under the section ''Client Credentials'', click ''Add a certificate or a secret'' and add a ''secret''.		# Under the section ''Client Credentials'', click ''Add a certificate or a secret'' and add a ''secret''.
	# Under the section ''Redirect URIs'', click ''Add the Redirect URI'', which you can copy it if from the plugin ''settings'' page.		# Under the section ''Redirect URIs'', click ''Add the Redirect URI'', which you can copy it if from the plugin ''settings'' page.
	# ~~Once~~ you have created the application, copy ~~the~~ ''Client ID'' ~~and~~ ''Client Secret'' values.		# Now you have created the application and you can copy ''Client ID'', ''Client Secret'' and ''Tenant Id'' values to carry over to the plugin settings.

	==== Activate the AzureOAuthSMTP plugin in LimeSurvey. ====		==== Activate the AzureOAuthSMTP plugin in LimeSurvey. ====
Line 45:		Line 45:
	# Follow the steps in the consent screen and check the requested permissions.		# Follow the steps in the consent screen and check the requested permissions.
	# Once you have granted permission, you will be redirected back to LimeSurvey.		# Once you have granted permission, you will be redirected back to LimeSurvey.

			[[File:AzureOAuthSMTP_Plugin_(4).jpeg\|600px\|thumb\|left]]

	==== Test the AzureOAuthSMTP plugin. ====		==== Test the AzureOAuthSMTP plugin. ====

Gabrieljenik: /* Once your web app is created, go to the Authentication tab. */

2023-11-23T13:53:41Z

Once your web app is created, go to the Authentication tab.

← Older revision		Revision as of 15:53, 23 November 2023
Line 17:		Line 17:
	[[File:AzureOAuthSMTP_Plugin_(5).jpeg\|600px\|thumb\|left]]		[[File:AzureOAuthSMTP_Plugin_(5).jpeg\|600px\|thumb\|left]]

	==== Once your web app is created, ~~go to~~ the ''~~Authentication~~'' tab. ====		==== Once your web app is created, you will land on the ''Overview'' tab. ====

	# ~~Click~~ ''Add a ~~provider~~'' and ~~select~~ ''~~Azure Active Directory~~''.		# Focus on the ''Essentials'' section.
	# ~~Click~~ ''~~Create~~'' ~~and then~~ ''~~Create a new tenant~~''.		# Under the section ''Client Credentials'', click ''Add a certificate or a secret'' and add a ''secret''.
	~~# Follow~~ the ~~instructions to create a new tenant and Azure Active Directory application~~.		# Under the section ''Redirect URIs'', click ''Add the Redirect URI'', which you can copy it if from the plugin ''settings'' page.
	# Once you have created the application, copy the ''Client ID'' and ''Client Secret'' values.		# Once you have created the application, copy the ''Client ID'' and ''Client Secret'' values.

Gabrieljenik: /* Set up the OAuth 2.0 Web Application in Azure Portal. */

2023-11-23T13:50:07Z

Set up the OAuth 2.0 Web Application in Azure Portal.

← Older revision		Revision as of 15:50, 23 November 2023
Line 10:		Line 10:

	# Go to the Azure Portal and sign in.		# Go to the Azure Portal and sign in.
	# ~~Click~~ ''~~New~~'' ~~>~~ ''App ~~Services~~'' ~~>~~ ''~~Web App~~''.		# Under ''Azure Services'', click on ''App Registrations''
	# ~~In the ''Basics'' tab, enter~~ a name for your web app and select ~~a region~~.		# Click ''New Registration''.
	# Click ''~~Next'' and then ''Create~~''.		# Enter a name for your web app and select ''Who will have access to the Application''.
			# Click ''Register''.

			[[File:AzureOAuthSMTP_Plugin_(5).jpeg\|600px\|thumb\|left]]

	==== Once your web app is created, go to the ''Authentication'' tab. ====		==== Once your web app is created, go to the ''Authentication'' tab. ====

Gabrieljenik at 13:40, 23 November 2023

2023-11-23T13:40:54Z

← Older revision		Revision as of 15:40, 23 November 2023
Line 28:		Line 28:
	==== Configure the AzureOAuthSMTP plugin in LimeSurvey. ====		==== Configure the AzureOAuthSMTP plugin in LimeSurvey. ====

	# Go to the ''~~Configuration~~'' page for the AzureOAuthSMTP plugin.		# Go to the ''Settings'' page for the AzureOAuthSMTP plugin.
			# Please notice the ''Help'' section on the top.
	# Enter the ''Client ID'', ''Client Secret'', and ''Tenant ID'' values that you copied from Azure Portal.		# Enter the ''Client ID'', ''Client Secret'', and ''Tenant ID'' values that you copied from Azure Portal.
			# Notice the ''Tenant ID'' usually shall be set to ''consumers'', still that depends on the Azure Application.
	# Click ''Save''.		# Click ''Save''.

Line 45:		Line 47:
	# Go to Global Settings		# Go to Global Settings
	# In the ''Email'' settings, select ''Plugin'' as the ''Email Method''.		# In the ''Email'' settings, select ''Plugin'' as the ''Email Method''.
			# Scroll down and select the the ''Plugin'' that will be used for sending emails.
	# Save		# Save
	# Click ''Test'' to send a test email.		# Click ''Test'' to send a test email.

Gabrieljenik at 20:39, 22 November 2023

2023-11-22T20:39:54Z

← Older revision		Revision as of 22:39, 22 November 2023
Line 12:		Line 12:
	# Click ''New'' > ''App Services'' > ''Web App''.		# Click ''New'' > ''App Services'' > ''Web App''.
	# In the ''Basics'' tab, enter a name for your web app and select a region.		# In the ''Basics'' tab, enter a name for your web app and select a region.
	~~# Under ''Runtime stack'', if required, select ''Windows'' and ''PHP'' > ''7.4''.~~
	# Click ''Next'' and then ''Create''.		# Click ''Next'' and then ''Create''.

Gabrieljenik: /* Test the AzureOAuthSMTP plugin. */

2023-11-22T20:33:01Z

Test the AzureOAuthSMTP plugin.

← Older revision		Revision as of 22:33, 22 November 2023
Line 49:		Line 49:
	# Click ''Test'' to send a test email.		# Click ''Test'' to send a test email.

	[[File:AzureOAuthSMTP_Plugin_(1).jpeg\|600px\|thumb\|left~~\|alt text~~]]		[[File:AzureOAuthSMTP_Plugin_(1).jpeg\|600px\|thumb\|left]]

	=== Additional notes ===		=== Additional notes ===