The Umbraco Backoffice supports external login providers (OAuth) for performing authentication of your users. This could be any OpenIDConnect provider such as Entra ID/Azure Active Directory, Identity Server, Google, or Facebook.
In this tutorial, we will take you through the steps of setting up a Google login for the Umbraco CMS backoffice.
What is a Google Login?
When you log in to the Umbraco Backoffice, you need to enter your username and password. Integrating your website with Google authentication adds a button that you can click to log in with your Google account.
Why?
We are sure a lot of content editors and implementors of your Umbraco sites would love to have one less password to remember. Click Sign in with Google and if you are already logged in with your Google account, it will log you in directly.
For more information on installing and using a package with the .Net CLI, see Microsoft Documentation.
3. Configuring the Solution to allow Google Logins
To use an external login provider such as Google on your Umbraco CMS project, you have to implement a couple of new classes:
A custom-named BackOfficeExternalLoginProviderOptions configuration class.
A custom-named GoogleOptions configuration class.
A Composer to tie it all together.
An Umbraco backoffice manifest declaration.
You can create these files in a location of your choice. In this tutorial, the files will be added to an ExternalUserLogin/GoogleAuthentication folder for the C# classes. You will also need an \App_Plugins\my-auth-providers folder location for the frontend registration.
Create a new class:GoogleBackOfficeExternalLoginProviderOptions.cs.
Add the following code to the file:
GoogleBackOfficeExternalLoginProviderOptions.cs
using Microsoft.Extensions.Options;
using Umbraco.Cms.Api.Management.Security;
using Umbraco.Cms.Core;
namespace MyCustomUmbracoProject.ExternalUserLogin.GoogleAuthentication;
public class GoogleBackOfficeExternalLoginProviderOptions : IConfigureNamedOptions<BackOfficeExternalLoginProviderOptions>
{
public const string SchemeName = "Google";
public void Configure(string? name, BackOfficeExternalLoginProviderOptions options)
{
if (name != Constants.Security.BackOfficeExternalAuthenticationTypePrefix + SchemeName)
{
return;
}
Configure(options);
}
public void Configure(BackOfficeExternalLoginProviderOptions options)
{
options.AutoLinkOptions = new ExternalSignInAutoLinkOptions(
// must be true for auto-linking to be enabled
autoLinkExternalAccount: true,
// Optionally specify default user group, else
// assign in the OnAutoLinking callback
// (default is editor)
defaultUserGroups: new[] { Constants.Security.EditorGroupAlias },
// Optionally specify the default culture to create
// the user as. If null it will use the default
// culture defined in the web.config, or it can
// be dynamically assigned in the OnAutoLinking
// callback.
defaultCulture: null,
// Optionally you can disable the ability to link/unlink
// manually from within the back office. Set this to false
// if you don't want the user to unlink from this external
// provider.
allowManualLinking: true
)
{
// Optional callback
OnAutoLinking = (autoLinkUser, loginInfo) =>
{
// You can customize the user before it's linked.
// i.e. Modify the user's groups based on the Claims returned
// in the externalLogin info
// see https://github.com/umbraco/Umbraco-CMS/issues/12487
autoLinkUser.IsApproved = true;
},
OnExternalLogin = (user, loginInfo) =>
{
// You can customize the user before it's saved whenever they have
// logged in with the external provider.
// That is to sync the user's name based on the Claims returned
// in the externalLogin info
return true; //returns a boolean indicating if sign-in should continue or not.
},
};
}
}
Set the autoLinkExternalAccount to false in order to disable auto-linking in your implementation.
Create a new class: GoogleBackOfficeAuthenticationOptions.
Add the following code to the file:
GoogleBackOfficeAuthenticationOptions.cs
using Microsoft.AspNetCore.Authentication.Google;
using Microsoft.Extensions.Options;
using Umbraco.Cms.Api.Management.Security;
using Umbraco.Cms.Web.Common.Helpers;
using Umbraco.Cms.Web.UI.Custom;
namespace MyCustomUmbracoProject.ExternalUserLogin.GoogleAuthentication;
public class GoogleBackOfficeAuthenticationOptions : IConfigureNamedOptions<GoogleOptions>
{
private readonly OAuthOptionsHelper _helper;
public GoogleBackOfficeAuthenticationOptions(OAuthOptionsHelper helper)
{
_helper = helper;
}
public void Configure(GoogleOptions options)
{
// since we have access to dependency injection, these values can be read from the app settings using the IOptions pattern
options.CallbackPath = "/umbraco-google-signin"; // can be anything as middleware will add this to the route table
options.ClientId = "your client id for the google login provider";
options.ClientSecret = "your client secret for the google login provider";
options.Scope.Add("https://www.googleapis.com/auth/userinfo.email"); // email is needed for auto linking purposes
// This will redirect error responses from the login provider towards the default umbraco oath login error page
// which will try to display the error state in a meaningful way.
// You can implement your own error handling by handling options.Events.OnAccessDenied & options.Events.OnRemoteFailure
_helper.SetDefaultErrorEventHandling(options, GoogleBackOfficeExternalLoginProviderOptions.SchemeName);
}
public void Configure(string? name, GoogleOptions options)
{
// only configure the options if it is for the backend
if (name == BackOfficeAuthenticationBuilder.SchemeForBackOffice(GoogleBackOfficeExternalLoginProviderOptions
.SchemeName))
{
Configure(options);
}
}
}
Replace YOURCLIENTID and YOURCLIENTSECRET with the values from the OAuth Client Ids Credentials window. Or use the IOptions pattern to read the values from app settings (or other sources).
Register both ConfigureNameOptions into a composer and add the provider to Umbraco
GoogleBackOfficeExternalLoginComposer.cs
using Umbraco.Cms.Api.Management.Security;
using Umbraco.Cms.Core.Composing;
using Umbraco.Cms.Web.UI.Custom;
namespace MyCustomUmbracoProject.ExternalUserLogin.GoogleAuthentication;
public class GoogleBackOfficeExternalLoginComposer : IComposer
{
public void Compose(IUmbracoBuilder builder)
{
builder.Services.ConfigureOptions<GoogleBackOfficeExternalLoginProviderOptions>();
builder.Services.ConfigureOptions<GoogleBackOfficeAuthenticationOptions>();
builder.AddBackOfficeExternalLogins(logins =>
{
logins.AddBackOfficeLogin(
backOfficeAuthenticationBuilder =>
{
// this Add... method will be part of the OathProvider nuget package you install
backOfficeAuthenticationBuilder.AddGoogle(
BackOfficeAuthenticationBuilder.SchemeForBackOffice(
GoogleBackOfficeExternalLoginProviderOptions
.SchemeName)!,
options =>
{
// need to give an empty action here for the options pattern configuration to work
// if you do not wish to use the umbraco default error handling and hardcode all your values instead of injecting them,
// you can set the configuration right here instead. You can then remove the `GoogleBackOfficeAuthenticationOptions` class
});
});
});
}
}
Register the provider with the backoffice client by adding the following file to the manifest file in /App_Plugins/my-auth-providers/umbraco-package.json:
The code used here, enables with the external login provider. This enables the option for users to login to the Umbraco backoffice prior to having a backoffice User.
