Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Workflow Studio provides a .NET SCIM Microservice template that you can use to create your own microservices using the SCIM protocol. As a developer, all you need to do is add the appropriate logic needed required for your implementation. Once you have added your own logic, you then build and deploy the microservice to the appropriate environment (such as Azure or IIS) , and connect EmpowerID to that environment.

In this tutorial, you will learn how to do the following:

▪ Create an a microservice project in Workflow Studio

▪ Open the project in Visual Studio

▪ Add your implementation logic to the microservice

▪ Publish and deploy the microservice

▪ Create the SCIM account store used to connect EmpowerID to the application hosting the microservice

Info

In this article, the microservice is will be published to an app service in Azure. The details of setting this up is assumed on the part of the reader. It is also assumed that the reader has prior knowledge of setting up an app service in Azure and has a basic fundamental understanding of the SCIM protocol and microservices.

When developing To develop SCIM microservices, you will initially use Workflow Studio to create generate the template and then use utilize Visual Studio to write develop the code for your particular specific microservice implementation of the microservice.

Create a SCIM microservice in Workflow Studio

  1. In Workflow Studio, right-click on the source control folder

in which
  1. where you want to create the SCIM microservice and select New Extension or Library >

SCIM Microservice v2
  1. Azure Services (.NET

Core 2
  1. 6.

2).
Image Removed
  1. 0).

    Image Added


    Workflow Studio generates a stub for the new SCIM microservice.

    Image Added

  2. Click the Properties tab and select SCIM as the ServiceType.

    Image Added

  3. Click the Save button on the Workflow Studio toolbar

to save
  1. and name the

SCIM microservice, giving it an appropriate name as you do.
Workflow Studio generates a stub for the new SCIM microservice.
Image Removed
  1. microservice application as desired.

    Image Added


    If you expand the Code Tree for the project, you can see that the template generated

a number of
  1. several classes for the project. You use these classes to define your models, controllers, and repositories for the SCIM microservice.

    Image Added


    Insert excerpt
    IL:SCIM Class Table
    IL:SCIM Class Table
    nopaneltrue

  2. A health check API can be added for monitoring App Service instance health to increase application availability.

Open the project in Visual Studio.

  1. Close the Workflow Studio microservice project and

then
  1. locate it in your source control tree.

  2. From your source control tree, double-click the project.
    This opens the project in Visual Studio.

Image Removed
  1. Image Added

  2. Write code to implement the class stubs for your specific scenario, and when finished, build the solution.
    This publishes the solution as a zip file to the microservices folder in the source control folder on your local machine (e.g., .\empowerid\WFS\microservices).

Image Removed

  1. Next, deploy the microservice to the desired environment. If you are using Azure and have defined an app service for the microservice, you can do this in Workflow Studio as shown below.

Deploy the microservice to Azure

  1. In Workflow Studio, select Cloud Explorer.

  2. Right-click Azure App Services Deployment and select Publish App to App

Service…
  1. Service.

    Image Modified

  2. In the Publish to Azure App Service Credentials window

that opens
  1. , click the Browse from Publish Profile button.

  2. Locate and select the .PublishSettings file for the app service. The .PublishSettings file is the file downloaded for the app service from Azure.

    This populates the fields of the Azure App Service Credentials window with the needed deployment information.

    Image Modified

  3. Click OK to close the Publish to Azure App Service Credentials window.

  4. In the Open File dialog that appears, search for and select the zip file for the microservice you just published.

Image Removed

  1. Wait for Workflow Studio to deploy the microservice to the app service and

then
  1. click OK to close the Success

messagebox
  1. message box.

    Image Modified


    Next, create a SCIM account store in EmpowerID for the system

to which
  1. you are connecting EmpowerID and verify that the configuration parameters are correct for your system. For details on how to do so, please see SCIM Connector.

Create the SCIM account store

  1. From the navbar of the EmpowerID Web interface, expand Admin > Applications and Directories and select Account Stores and Systems.

  2. Select the Actions tab and then click Create Account Store.

Image Removed
  1. Image Added

    This opens the System Types look up.

  2. Search for SCIM Connector.

  3. Click the SCIM Connector record to select it, and then click Submit.

    Image Added

     
    This opens the SCIM connector form.

Image Removed
  1. Image Added

     

  2. Enter the following information in the SCIM connector form:

    • Name – Name of the connector

    • Base URL – URL for the site hosting the SCIM microservice. For example, enter the URL for the app service if the microservice is hosted in an Azure

app service, enter the URL for the
    • app service.

    • Client Secret – If using OAuth authentication, enter the Client Secret for the app.

    • Client ID – If using OAuth authentication, enter the Client ID for the app.

    • Certificate – If using certificate-based authentication, enter the thumbprint of the certificate.

  1. When ready, click Submit.

After EmpowerID creates the account store, it displays the Account Store Details

Verify resource system parameters

  1. Navigate to the Find Account Store page (Admin > Applications and Directories > Account Stores and Systems) and search for the SCIM account store you just created.

  2. Click the Account Store link to navigate to the details page for the account store.

    Image Added

     

Select
  1. Click the Resource System tab and then expand the Configuration Parameters accordion.

    The accordion contains the following parameters, some of which may not pertain to your specific implementation.

    Insert excerpt
    IL:SCIM Connector Resource System Config Parameters
    IL:SCIM Connector Resource System Config Parameters
    nopaneltrue

  2. Edit the parameters as needed. To do so, click the Edit button for the parameter to be updated, as shown below.

Image Removed
  1. Image Added

     

  2. Enter the appropriate value for the parameter in the Value field and click Save.


Image Removed
  1.  

  2. Repeat for each parameter that needs to be updated.

  3. As a final step, the account store needs to be configured by an administrator before inventory. This includes configuring attribute flow, account store settings, and enabling the Account Inbox Permanent Workflow. For an example of what needs to be done, see

Connecting
  1. Connect to

Zendesk
  1. SCIM applications in the Admin guide.

Div
stylefloat:left; position:fixed;
idarticleNav

IN THIS ARTICLE

Table of Contents
none
maxLevel4
minLevel2
maxLevel4
stylestylenone
printablefalse

Insert excerpt
IL:External Stylesheet
IL:External Stylesheet
nopaneltrue
Insert excerpt
IL:External Stylesheet
IL:External Stylesheet
nopaneltrue