Synchronize Lucca users and groups with Okta

Background information

If you have purchased an Okta license, Lucca provides you with a connector allowing you to synchronize users and groups to your Okta directory. This documentation aims to describe the implementation of this integration by configuring Okta and Lucca.

 

[Okta] Integration setup

Go to the Applications menu and click on the "Browse App Catalog" and choose "Lucca" application.

mceclip0.png

 

Add the application and go to the Provisioning tab and then to the Integration menu.

Fill in the required data to configure the integration:

- Base URL: The base url of the application issued when configuring an Okta synchronization from Lucca 

- API Token: The authentication API key issued when configuring an Okta synchronization from Lucca 

- Import Groups: A checkbox that defines if you want to import groups or not (for group integration to work, this option must also be configured in Lucca)

oktaparam.png

To retrieve an API Token, you need to set up an Okta synchronization in Lucca by following the instructions below.

 

In the Provisioning tab, go the To okta menu and click on "Allow SCIM 2.0 Test App (Header Auth) to source Okta users.

mceclip1.png

 

[Lucca] Integration setup

In the Authentication, SSO, API menu, go to Okta synchronization and follow the instructions to create a synchronization between Lucca and Okta.

mceclip0.png

 

The purpose of activating a synchronization between Lucca and Okta is to deliver an API key allowing Okta to retrieve Lucca users to synchronize them in Okta. This key will be copied / pasted in Okta's synchronization settings. You have to follow the steps on the wizard.

mceclip1.png

First you have to fill the technical contact field :

mceclip2.png

The you have to choose the properties you want to synchronize with Okta :

mceclip3.png

And the groups you want to synchronize :

mceclip4.png

And finally, Lucca will give you the "Base URL" and "API Token" you have to copy and paste in the okta configuration page:

mceclip5.png

User property synchronisation détails

User group synchronisation détails

[Lucca/Okta] User properties setup

The Lucca users API shows the properties attached to a user (for example the contract start date, the contract end date, etc.)

These properties are specific to the Lucca ecosystem and they are not in the SCIM standard. However, it is possible to import them into Okta by setting them up in Lucca and Okta.

 

[Lucca] User properties setup

In the Authentication, SSO, API menu, go to Okta synchronization. The configuration page allows you to manage the user properties that you want to synchronize with Okta. You can add or remove all simple text properties of the HR directory of your instance. Some properties are mandatory in the SCIM standard. These properties cannot be removed. 

Capture_d_e_cran_2021-09-01_a__10.14.37.png

 

[Okta] Attribute / mapping mechanism

What is an attribute ?

There are 2 types of attributes:

  • The one present in Okta and which is displayed at the level of a user profile. It is this attribute that can be pushed by Okta towards third-party integration.
  • The one returned by the integration API (/ lucca-okta/api/users in our case) and which describes how Okta should retrieve property in the json.

What is mapping ?

The mapping is the connection between the attribute present in Okta and the attribute returned by the integration API.

 

[Okta] Create an Okta attribute

From the main menu, select Directory → Profile Editor. Then on the left, in the list of filters, select Okta. Then click on Profile.

mceclip4.png

 

This page represents all attributes of an Okta user. There are two types of attributes:

  • Native attributes: login, firstName, lastName, etc. found in the SCIM 2.0 standard. These attributes are not editable.

  • Custom attributes 

mceclip5.png

Click on Add Attribute. The following pop-up is displayed and allows you to configure the custom attribute. An attribute is defined by the following fields:

  • a type : string, integer, boolean, etc

  • a human readable name which will be displayed in the user profile

  • a variable name which ideally should match the name of the property present in the json returned by the /lucca-okta/api/users API. This will later make it easier to configure the mapping.

mceclip6.png

[Okta] Create an integration attribute

From the main menu, select Directory → Profile Editor. Then on the left, in the list of filters, select Apps. Then click on Profile at the "Lucca User" app.

LuccaUser.jpg

This page represents all attributes of a user on the Integration side. It contains the same types of attributes as in the Okta view, namely native attributes and custom attributes.

Capture_d_e_cran_2021-09-01_a__11.18.13.png

Click on Add Attribute. The following pop-up is displayed and allows you to configure the custom attribute. It contains the same information as in the Okta attributes view.

mceclip9.png

There is an additional field, the External namespace field. It allows you to inform Okta in which schema (at json level) our custom attribute is located.

Indeed, all attributes must be in a schema. There are two schemas in the SCIM standard:

  • urn:ietf:params:scim:schemas:core:2.0:User : associated schema for the attributes of the standard (firstName, lastName, etc.)

  • urn:ietf:params:scim:schemas:extension:enterprise:2.0:User : recommended schema by the SCIM standard for custom attributes (dtContractStart, dtContractEnd, etc.)

Here is an extract from the users json returned by the Lucca.Okta application:

scim.png

  • Framed in blue, we find the 2 diagrams mentioned above.
  • Framed in orange, we find the diagram that contains the custom attributes, so the one that we configured previously.

Once the creation is validated, you will find your attribute in the list.

Fill the external namespace field with the value:"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"

 

[Okta] Mapping configuration

The last step is to make the connection between the attribute configured on Okta and the attribute configured on the integration side.

From the main menu, select Directory → Profile Editor. Then on the left, in the list of filters, select Apps. Then click on Mappings at the Lucca integration level.

Capture_d_e_cran_2021-09-01_a__11.21.10.png

The following pop-up appears 

Capture_d_e_cran_2021-09-01_a__11.32.38.png

 

On the left column, you will find the attributes on the Lucca integration side which are mapped one-to-one to the attributes on the Okta side (right column). To configure a new mapping, all you have to do is fill in the missing link in the left column and click on Save Mappings.

You can then apply this new mapping to all users.

[Lucca] Groups setup

The Lucca. Okta API shows user groups that are loaded into the Okta directory. Four are defined: legal units, establishments, departments and countries. A group returned by the API (/api/groups) includes its member users and a user (/api/users) includes the groups he belongs to. For group integration to work, this option must also be configured in Okta.

You can activate or deactivate the synchronization of each type of group with the Lucca configuration interface:

mceclip4.png

Groups returned by the Lucca. Okta API are prefixed as follows:

  • “LUCCA_LU” for legal units
  • “LUCCA_ETS” for establishments
  • “LUCCA_DEPT” for departments
  • “LUCCA_COUNTRY” for countries

[Okta] Import users

Launch an import

Go to Import tab and then click on Import Now.

Capture_d_e_cran_2021-09-01_a__11.34.37.jpg

When the import is complete, and depending on the configuration chosen, you will need to validate the users to be imported definitively one by one (or by batch via the check boxes).

Capture_d_e_cran_2021-09-01_a__11.38.17.png

You can skip this step if the creation / update of users is configured as automatic at the end of the import (see page Provisioning to Okta).

 

Import result

After confirming the import, go to the Directory / People menu to see the imported users.

mceclip3.png

Then select a user to see details, including the groups he belongs to.

mceclip4.png

In the Directory/Groups menu, you can also consult all imported groups and attached people.

mceclip2.png

Contenu de la page

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 0 sur 0