US English (US)
FR French
DE German
PL Polish
SE Swedish
FI Finnish

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

English (US)
US English (US)
FR French
DE German
PL Polish
SE Swedish
FI Finnish
  • Log in
  • Home
  • Identity Governance and Administration (IGA)
  • IGA solution library
  • Instructions & guidelines
  • Configure connectors

SCIM connector

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Service Management
    Matrix42 Professional Solution Matrix42 Core Solution Enterprise Service Management Matrix42 Intelligence
  • Identity Governance and Administration (IGA)
    IGA overview IGA solution library
  • Platform
    ESM ESS2 ESS Efecte Chat for Service Management Integrations Add-ons
  • Release Notes for M42 Professional, IGA, Conversational AI
    2026.1 2025.3 2025.2 2025.1 2024.2 2024.1 2023.4 2023.3 2023.2 2023.1 2022.4 2022.3 Release Information and Policies
  • Other Material
    Terms & Documentation Guidelines Accessibility Statements
  • Services
+ More
    • Service Management

    • Identity Governance and Administration (IGA)

    • Platform

    • Release Notes for M42 Professional, IGA, Conversational AI

    • Other Material

    • Services

SCIM connector

SCIM connector is part of Native Connectors and it is used for reading data from SCIM server. Connector is available only for Efecte IGA solution and needs separate agreement to be used in other Efecte solutions. SCIM connector is a SCIM client, so it can read data from SCIM server. But it can't connect to another SCIM client.

SCIM connector requires configuration according to customers use case, and in principle configuration has two (2) steps:

  1. Configure connector - enables connector to establish connection to the SCIM server
  2. Configure scheduled task - is used when data is read from the SCIM server
     

2024.1 and newer version instructions

Configure SCIM connector

In this chapter is described configuration instructions for SCIM connector to be able connect to customers SCIM. 

For accessing connector management, user needs to have permissions to Efecte Platform configuration.

1. Open the Efecte administration area (a gear symbol).
2. Open connectors view.
3. Choose new connector 

 

4. Select Data Source type to be SCIM

 

5. Fulfill information related to customers SCIM

  • Connector name - give your connector a friendly name (name can be changed afterwards)
  • SCIM host - host address which will be used connecting to customers SCIM
  • SCIM port - port number which will be used connecting to customer SCIM
  • SCIM username - service account name which is used for reading and writing data to/from customers SCIM
  • SCIM password - password for the service account

 

6. Fulfill WebAPI user information

  • WebAPI user - select correct WebAPI user which is used when writing data from customers SCIM to customers Efecte solution
  • WebAPI password - password for the WebAPI user

 

7. Save connector information

  • Press test connection to validate that port and host information is set correctly
  • Press test authentication to validate that SCIM user and password (service account) information is set correctly

 

8. Customers Efecte solution is now able to connect to customers SCIM.  Next step is to configure scheduled task for data read.

 
 

General guidance for scheduled tasks

General guidance for scheduled tasks

How to Create New Scheduled Task to import data

For configuring scheduled-based provisioning task, you will need access to Administration / Connectors tab.

1. Open the Administration area (a cogwheel symbol).

2. Open Connectors view.

3. Choose Connector for Scheduled-based task and select New Task
   Note! If connector is not created, you have to choose first New connector and after that New task.

 

4. Continue with connector specific instructions: Native Connectors

 
 

Should I use Incremental, Full or Both?

Scheduled task can be either Incremental or Full -type.

Do not import permissions with AD and LDAP incremental task

Incremental task has issue with permissions importing. At the moment it is recommended not to import group memberships with incremental scheduled task.

On Microsoft Active Directory and OpenLDAP connectors, remove this mapping on incremental task:
 

 

 

Setting on Scheduled tasks:

Incremental type is supported only for Microsoft Active Directory, LDAP and Microsoft Graph API (formerly known as Entra ID) Connectors.

Incremental type means, that Native Connectors (EPE) fetches data from source system, using changed timestamp information, so it fetches only data which is changed or added after previous incremental task run.

When Incremental type task is run for very first time, it does a full fetch (and it marks the current timestamp to EPE database),  thereafter, task uses that timestamp to ask the data source for data that changed since that timestamp (and then EPE updates the timestamp to EPE database for next task run). Clearing task cache doesn't affect this timestamp, so Incremental task is always incremental after first run.
 

Full type is supported for all Connectors.

Full type import fetches always all data (it's configured to fetch) from source system, on every run. 
 

Both Full and Incremental type tasks use also Task cache in EPE, which makes certain imports faster and lighter for M42 system.

By default that task cache is cleared ad midnight UTC time. When cache is cleared, next import after that is run without caching used to reason if data fetched should be pushed to ESM, all fetched data is pushed to ESM. But after that, next task runs until next time cache is cleared, are using EPE cache to determine if fetched data needs to be pushed to ESM or not.

You can configure at what time of day task cache is emptied, by changing global setting in EPE datapump configuration: 

/opt/epe/datapump-itsm/config/custom.properties

which is by default set to: clearCacheHours24HourFormat=0

You can also clear cache many times a day, but that needs to be thinked carefully, as it has impact on overall performance as EPE will push changes to ESM, that probably are already there, example(do not add spaces to attribute value): clearCacheHours24HourFormat=6,12

After changing this value, reboot EPE datapump container to take change into use.

Recommendations:

Have always by default Full type scheduled task.

If you want to fetch changes to data fetched already by full task, more frequently than you can run full task, add also incremental task. Usually incremental task is not needed.

 
 

Recommended Scheduling Sequence

Recommended scheduling sequence, depends how much data is read from Customers system/directory to the Matrix42 Core, Pro or IGA solution and is import Incremental or Full. 

Examples for scheduling, 

Total amount of users  Total amount of groups Full load sequence Incremental load sequence
< 500 < 1000 Every 30 minutes if partial load is not used
Four (4) times a day if partial load is used
Every 10 minutes
< 2000 < 2000 Every 60 minutes, if partial load is not used
Four (4) times a day if partial load is used
Every 15 minutes
< 5000 < 3000 Every four (4) hours, if partial load is not used
Twice a day if partial load is used
Every 15 minutes
< 10 000 < 5000 Maximum imports twice a day, no matter if partial load is or is not used Every 30 minutes
< 50 000 < 7000 Maximum import once a day, no matter if partial load is or is not used Every 60 minutes
Over 50 000 Over 7000 There might be a need for another EPE-worker, please contact Product Owner Separately evaluated


Please note that if there are several tasks running at the same time you may need more EPE-workers. The tasks should be scheduled at different times and can be completed according to the table above. However, if there are more than 6 tasks running at the same time, the number of epeworkers should be increased. It's best practice not to schedule tasks to run at same time, if possible.

Recommendations related to performance
If the amount fo data to be imported is over 10000 concider these things:
Adjust log level of ESM and DATAPUMP to ERROR-level, to lowe the amount of logging during task run
Have as few as possible automations starting immediately for imported datacards (listeners, handlers, workflows), as those make ESM to take longer time handling new datacards.

 
 

Set removed accounts and entitlements status removed/disabled

With this functionality, you can mark account and entitlement status to e.g. Deleted or Disabled, when account or entitlement is removed from source system. Starting from version 2025.3 you can also set status to generic objects (not only to accounts/identities and entitlements/groups). 

For version 2025.3 and newer

In version 2025.3 these settings are moved from properties files to Task UI. Also you can now set these settings for Generic objects, which have not been possible before this version.

There is separate configuration for each scheduled task, and for all mapping types. Here is example of this config on task:

For version 2025.2 and older

This functionality is available for “full” type scheduled tasks.

Settings are on datapump dockers configuration file. To change those parameter values, you need to set those in /opt/epe/datapump-itsm/config/custom.properties file.

Configuration

To enable disabling functionality, datapump config should have these parameters set to true:

disable.unknown.esm.users=true
disable.unknown.esm.groups=true

Those 2 parameters are false by default in 2024.2 and 2025.1 versions. In 2025.2 and newer version those are true by default.

 

Next are these parameters:

personTemplateStatusCodeAttributeKey=accountStatus
personTemplateStatusAttributeDisabledValueKey=Deleted
groupTemplateStatusCodeAttributeKey=status
groupTemplateStatusAttributeDisabledValueKey=5 - Removed

First two attributes should point to the DatacardHiddenState attribute in the User template, and tell which value should be send there when the user is deleted.

By default its accountStatus and Value 5 - Removed on IGA Account template.

All these needs to match with the attribute configuration:

 

1.PNG

Same thing applies for the next two paramaters, but its for Groups.'

If you need to change those parameters in properties file, do changes in Datapump container to file: /opt/epe/datapump-itsm/config/custom.properties and those changes will then survive over container reboot and will be copied on reboot to /opt/epe/datapump-itsm/config/application.properties.

Description

Tasks save their __taskid__ shown as Task Id mapping in the UI to the datacards, its then used to determine if the datacard was added by this task. In case there are multiple tasks with different sets of users.

This field was previously used as datasourceid, but since we moved to the model where connector can have multiple tasks its identifier cannot be used anymore, thats why the field was repurposed as taskid instead.

 

Taking users as an example, when task runs ESM is asked for the list of users that have its taskid in Task Id mapping field, and doesn't have a personTemplateStatusAttributeDisabledValueKey value in the personTemplateStatusCodeAttributeKey

This result is then compared to what the task fetched, and the datacards of users that were not fetched have their personTemplateStatusattribute set to value specified in the config - 5 - Removedby default.

Example log below shows described process and informs that one user was removed.

 

2.PNG

Same thing applies to groups but groupTemplateStatusattributes are used instead.

Notes

  • Feature works only with full fetch scheduled tasks..
  • No support for generic templates yet, only identity and access
  • When migrating from the previous versions where datasourceid was still used it needs to run at least once to set its taskid’s in the datacards first.
  • EPE identifies Disabled users or groups as the ones that were removed from the AD, at the present we do not support statuses related to the entity beign active or not.
  • EPE does not enable users back on its own.
  • If more than one tasks fetches the same users or groups it may overwrite the taskid in the datacard depending on which task ran last. It is suggested that many full type tasks are not fetching same user or group.
  • Always do configuration file changes to custom.properties, do not change only application.properties as those changes are lost on container reboot if you have not done same changes to custom.properties.
 
 

 

 
 

Configure scheduled task for reading data

For configuring scheduled-based task, you will need access to Efecte Platform configuration console. 

Note! If connector is not created, you have to create first “new connector” and after that you are able to create new tasks.

1. Open the Efecte administration area (a gear symbol).
2. Open connectors view.
3. Choose connector for which scheduled-based task is configured
4. Select new task under the correct connector

 

4. Define scheduling for the task (if and how scheduled task should be run periodically). Choose scheduling sequence, which depends how much data is read to customers Efecte solution.

 

5.  Fill in Task Details

  • Fill in unique task name for the scheduled-based task, notice that name cannot be changed afterwards. 
  • Task usage indicated that is the task used for reading data, writing data or to authentication. Note that If event type is changed afterwards it can break the workflows.
  • Mappings type depends what type of information is read from the directory
    • Identity and access rights - are used when user account and group information is read from the directory
    • Single (identity only) - are used when only user account information is read from the directory
    • Single (access right only) - are used when only group information is read from the directory
    • Generic (one template) - are used when a generic information is read from the directory, usually other than Users/Groups

6. Fill in optional filtering details

  • Set up filter for users if needed,
    Additional Graph API query filter applied when Users are being extracted
  • Set up filter for groups if needed, Additional SCIM API query filter applied when groups are being extracted

7. Fill in failure information

Optional settings for failure handling, if scheduled task fails it can create data card to Efecte ESM that displays the error. If failure settings are defined , the administrator does not need to manually check the status of scheduled tasks.

  • Failure template - Select a Template of datacard which will be created in case of any errors during provisioning (connection to data sources,timeouts,etc.)
  • Failure folder - Select folder where failure data card is stored. 
  • Failure attribute - Select an attribute where in the Failure Template should the error information be stored in.

 

8. Fill in Identity Mappings

Users are imported to IGA Account template and it is mandatory to set Target folder, datasourceid and unique values which are used for identifying users between customers SCIM and Efecte solution. For example.

  • Target template - Select a template to define attribute mappings
    Select a template to define attribute mappings
  • Target folder - Select a folder from a list of folders. The list is narrowed down to match compatibility with selected Template.
  • Attribute mappings
    1. External attribute - which attribute from the SCIM server is mapped
    2. Local attribute - to which attribute in datacard attribute is mapped to.
  • It is possible to set additional attributes, which are read from user accounts, by choosing New attribute

9. Fill in Access Rights Mappings

Groups are read to IGA Entitlement template and it is mandatory to set target folder, datasourceid and unique values which are used for identifying users between customers SCIM server and Matrix42 Core, Pro or IGA solution.

  • Target template - Select a template to define attribute mappings
    Select a template to define attribute mappings
  • Target folder - Select a folder from a list of folders. The list is narrowed down to match compatibility with selected Template.
  • Attribute mappings
    1. Efecte template attribute - to which attribute in Efecte directory attribute is mapped to.
    2. Directory attribute - which attribute from the directory is mapped to Efecte
  • It is possible to set additional attributes, which are read from user accounts in directory, by choosing New attribute

 

10. Save provisioning task from the Save button. If some required attributes are missing the save button is displayed as grey and it will display what is missing from the settings.

11. You have now configured scheduled-based connector task for SCIM data read. 

  • You can now wait until task is started based on scheduling or
  • Run task manually - by clicking the button task is configured to be scheduled to start immediately. Usually for test runs or if you don't want to change the schedule settings, but want to run the task now.   
 
 
 
 

2023.4 and older version instructions

For configuring scheduled-based provisioning task, you will need access to Efecte Platform configuration console.

1. Open the Efecte Administration area (a gear symbol).
2. Open IGA view
3. Choose Add a new task for Scheduled-based Provisioning
4. Choose SCIM from the Add a new task list


5. Fill in unique name for the provisioning task
6. Choose WebAPI user and type in password
7. Select a Failure Template of datacard which will be created in case of any errors during provisioning (connection to data sources,timeouts,etc.)

 

8. Choose scheduling sequence, which depends how much data is read to Customers Efecte solution

 

9. Fill in Properties section, where information for the connection is defined and filter's for reading user and group information from Customers SCIM

 

10. Fill in optional filtering details

  • Set up filter for users if needed,
    Additional Graph API query filter applied when Users are being extracted
  • Set up filter for groups if needed, Additional Graph API query filter applied when groups are being extracted

 

10. Users are imported to IGA Account template and it is mandatory to set Target folder, datasourceid and unique values which are used for identifying users between Customers SCIM and Efecte solution. It is possible to set additional attributes, which are read from user accounts in SCIM, by choosing Add property

 

11. Groups are read to IGA Entitlement template and it is mandatory to set Target folder, datasourceid and unique values which are used for identifying users between Customers SCIM and Efecte solution. It is possible to set additional attributes, which are read from user accounts in SCIM, by choosing Add property 

14. Save provisioning task from the top bar 

15. You have now configured scheduled-based provisioning task and you can

  • Test connection
  • Test Authentication
  • Run task manually

16. If task is executed manually (run task manually) or it is run according to scheduling, task status can be reviewed under Extract / Load Status tab.

 
 

Troubleshooting

In this chapter are described troubleshooting options,

  • In case failure template is used, check correct data card
  • Check scheduled task history from connector management
  • Check Provisioning Engine logs
     
 
 

 

identity integration user management

Was this article helpful?

Yes
No
Give feedback about this article

Table of Contents

Related Articles

  • Microsoft Active Directory (AD) Connector

Copyright 2026 – Matrix42 Professional.

Matrix42 homepage


Knowledge Base Software powered by Helpjuice

0
0
Expand