Search Results :

×

SCIM User Provisioning using Umbraco SCIM Client with miniOrange

The Umbraco SCIM Client enables automated user provisioning and synchronization between miniOrange and your Umbraco application. SCIM (System for Cross-domain Identity Management) is an open standard used to securely manage user identities across systems. Using this integration, BackOffice users and Members can be created, updated, and deleted efficiently from Umbraco to the SCIM server. Follow the step-by-step guide below to configure SCIM user provisioning using the Umbraco SCIM Client.

NuGet Package
.NET CLI

PM> NuGet\Install-Package miniOrange.Umbraco.SCIM.Client.Trial -Version 18.0.1

> dotnet add package miniOrange.Umbraco.SCIM.Client.Trial --version 18.0.1

  • Download the Umbraco SCIM Client plugin.
  • For setting up the Umbraco SCIM Client, add the below namespaces, services and middleware in your program.cs file. Below here is a sample example.
    Include only the highlighted section below in the program.cs file of your application.

  using miniOrange.scim;
  using miniOrange.scim.DependentServices;

  WebApplicationBuilder builder = WebApplication.CreateBuilder(args);

  builder.CreateUmbracoBuilder()
    .AddBackOffice()
    .AddWebsite()
    .AddComposers()
    .Build();

  builder.Services.AddMiniOrangeScimServices();

  WebApplication app = builder.Build();

  await app.BootUmbracoAsync();

  app.UseHttpsRedirection();

  app.UseUmbraco()
    .WithMiddleware(u =>
    {
      u.UseBackOffice();
      u.UseWebsite();

      u.AppBuilder.MapWhen(
        context => !string.IsNullOrEmpty(context.Request.Query["scimaction"]),
        branch =>
        {
          branch.UseMiniOrangeScimClient();
        });
    })
    .WithEndpoints(u =>
    {
      u.UseBackOfficeEndpoints();
      u.UseWebsiteEndpoints();
    });

  await app.RunAsync();

  • Run the application when the configuration is done.

Step-by-step guide for Umbraco SCIM Client setup using miniOrange as the SCIM server.

  • After integration, open your browser and access the SCIM Client dashboard using the URL below:
 https://<umbraco-base-url>/?scimaction=config
  • If the registration page or login page pops up, you have successfully added the miniOrange Umbraco SCIM Client middleware in your application.
Umbraco SCIM Client - Register with miniOrange

  • Create your miniOrange account by entering your Email, Password and Confirm Password, then click the Register button to start the trial.
  • If you already have an account, click Already registered? Login to continue.
  • After successful registration, you will receive a trial license key on your registered email address.
  • To activate the plugin, you can either:

    • Select the Enter License Key tab, enter the license key received via email in the License Key field, and click Activate.
Umbraco SCIM Client - Enter License Key

OR

  • Select the Upload License File tab, click Download License Key to download the .lic file, then click Choose File to upload it and click Activate.
Umbraco SCIM Client - Upload License File

  • Once the license is successfully activated, the SCIM Configuration dashboard will open as shown below.
Umbraco SCIM Client Dashboard
  • Log in to your miniOrange Admin Console.
  • From the left sidebar, click on Apps, then click the + Add Application button.
miniOrange - Add Application

  • On the Choose Application page, search for Scim in the search box.
  • From the results, select SCIM Server (Destination).
miniOrange - Select SCIM Server

  • Under the Basic tab, enter a Display Application Name (for example, Umbraco SCIM Server) and click Save.
miniOrange SCIM Server - Display Application Name

  • Navigate to the Authorization tab. Copy the SCIM Base URL and Bearer Token and keep them handy, as you will need them in the next step.
  • Click Save & Next to save the configuration.
miniOrange SCIM Server - Bearer Token
  • Now, switch back to your Umbraco SCIM Client dashboard and stay on the SCIM Configuration tab.
  • Paste the copied SCIM Base URL into the SCIM Endpoint URL field and the Bearer Token into the Bearer Token field.
  • Click Save Configuration and then Test Connection to verify the setup.
Umbraco SCIM Client - SCIM Configuration from miniOrange
  • Navigate to the Attribute Mappings tab from the left sidebar.
  • Map Umbraco fields to SCIM attributes for Backoffice Users and Members. Username and Email are required. First Name and Last Name are optional.
Backoffice Users
  • Under the Backoffice Users section, map each Umbraco field to the corresponding SCIM attribute using the dropdown. For example, map Username to userName, Email to emails[type eq "work"].value, First Name to name.givenName, and Last Name to displayName.
  • Click Save User Mappings to save the Backoffice User mappings.
Umbraco SCIM Client - Attribute Mapping Backoffice Users

Members
  • Scroll down to the Members section and map each Umbraco member field to the corresponding SCIM attribute in the same way.
  • Click Save Member Mappings to save the Member mappings.
Umbraco SCIM Client - Attribute Mapping Members

Note: Custom attribute mapping for Backoffice Users and Members is available in the Premium plugin.

  • Navigate to the Sync Options tab from the left sidebar.
Enable Backoffice User Sync
  • Under User Sync Settings, turn on the Enable Backoffice User Sync toggle to include Backoffice Users in sync operations.
  • Click Save Configuration to apply the changes.
Umbraco SCIM Client - Enable Backoffice User Sync

Enable Member Sync
  • Turn on the Enable Member Sync toggle to include Members in sync operations.
  • You can enable Backoffice User Sync, Member Sync, or both based on your requirement.
  • Click Save Configuration to apply the changes.
Umbraco SCIM Client - Enable Member Sync

Real Time Sync and One Time Sync
  • Real Time Sync: Turn on the Enable Real Time Sync toggle to allow real-time synchronization of user and member create, update, and delete actions to the SCIM server as they occur. Click Save Configuration to apply the changes.
  • One Time Sync: To perform an immediate one-time synchronization of enabled Backoffice Users and/or Members to the SCIM server, click the Perform One Time Sync button.
Umbraco SCIM Client - Real Time and One Time Sync

Schedule Sync
  • Turn on the Enable Schedule Sync toggle to automatically synchronize users at the configured intervals.
  • Set the Start Date & Time to specify when the scheduled sync should begin.
  • Then select the sync Frequency as per your requirement — Daily (every 24 hours), Weekly (every 7 days), Monthly (every 30 days), or Custom.
  • If you select Custom, enter a Custom Value and select the Unit (Hours, Days, Weeks, or Months) to define your own sync interval.
  • Click Save Configuration to apply the changes.
Umbraco SCIM Client - Enable Schedule Sync
  • If you face any issues during configuration or user sync, navigate to the Troubleshoot tab from the left sidebar.
  • Turn on the Enable debug logs toggle to capture plugin logs, then reproduce the issue in your application.
  • Click Download Log File to download the logs. You can also click Clear logs to reset the log file.
  • Note: If miniOrangeScimLog.txt is not writable, give write permission on the file.
  • Send the downloaded log file to us at umbracosupport@xecurify.com and our team will reach out to you to resolve your issue.
Umbraco SCIM Client - Troubleshoot


 Thank you for your response. We will get back to you soon.

Something went wrong. Please submit your query again

We'll Reach Out to You at the Earliest!


ADFS_sso ×
Hello there!

Need Help? We are right here!

support