Connectors
Last updated
Last updated
Connectors serve as integration points within the Skillmine Auth project, allowing the system to communicate with different identity providers and efficiently manage user data migration or synchronization. These connectors are designed to streamline the authentication process by interfacing with external systems.
Purpose
The primary purpose of connectors is to establish a connection between the authenticator project and various identity providers, enabling the smooth flow of user information. This functionality is essential for scenarios such as onboarding new users, updating existing user data, or migrating users from one identity provider to another.
Accessing the Connectors Tab
Open the Admin Console.
On the left-hand side, locate and click on Settings.
In the Settings section, click on the Connectors tab.
On the Connectors page, you'll find a card-based view that categorizes the Configured Connectors.
Create New App
Click Connect New App, this will display the available providers to configure in connectors.
On the New App page, you'll find the following details needed to configure new connectors.
Description: Enter a unique name for this configuration. This helps in identifying the specific setup among multiple configurations.
Required: Yes
Description: The URL used for logging into the Office365 admin panel. This is typically a specific URL provided by Office365 for administrative access.
Required: Yes
Description: Defines how user attributes in Skillmine Auth map to user attributes in Office365. This ensures that user information is correctly synchronized between the two systems.
Required: Yes
Description: Toggles the entire configuration on or off. When disabled, synchronization between the two systems is paused.
Required: Yes
Default Role & Group Mapping
Description: Specifies the default groups and roles in Office365 that should be assigned to users synced from Skillmine Auth. This is crucial for ensuring proper access control.
Required: Yes
Description: The unique identifier for the application registered in Office365. This is part of the OAuth credentials.
Required: Yes
Description: A secret key associated with the Client ID, used for authentication in the OAuth flow.
Required: Yes
Description: The unique identifier of the Office365 tenant. This specifies the instance of Office365 that the configuration applies to.
Required: Yes
Description: The domain associated with the Office365 tenant. This helps in filtering users belonging to a specific domain.
Required: Yes
Description: Enables synchronization of users from Office365 to Skillmine Auth. This keeps user data in Skillmine Auth up-to-date with Office365.
Description: Enables synchronization of users from Skillmine Auth to Office365. This ensures that any changes in Skillmine Auth are reflected in Office365.
Description: Determines how often the synchronization process is triggered. This can be set to specific intervals to manage the load on both systems.
Description: When enabled, users marked for deletion during synchronization will be deleted from Office365. This applies to two-way syncing: from Skillmine Auth to Office365 and vice versa. If the toggle is disabled, users marked for deletion will not be automatically deleted. Instead, they can be deleted manually in the report section if necessary.
Description: When enabled, creating a user in Skillmine Auth automatically creates a corresponding user in Office365.
Required: Optional
Description: When enabled, editing a user's profile in Skillmine Auth will update the corresponding user's profile in Office365.
Required: Optional
Description: When enabled, deleting a user in Skillmine Auth will remove the corresponding user from Office365.
Required: Optional
Description: Specifies email addresses that should not be deleted from Office365 even if the corresponding user is deleted in Skillmine Auth. This is useful for preserving accounts that should not be automatically removed.
Required: Optional
Description: Enables updating of groups and roles in Office365 based on changes in Skillmine Auth. This ensures that user permissions are consistent across both systems.
Required: Optional
Click Save to create new Connectors.
After successful creation, connectors will be displayed in a card-based view. You can click on the card to edit the connectors.
On the edit page, there are buttons for "View Documentation" and "View Report":
View Documentation: Redirects to the connectors documentation, helping with the creation and configuration of the app in Office365.
View Report: Redirects to the Sync Report page.
The "Connectors Report" table provides a comprehensive overview of the synchronization activities between two systems. Each column in the table offers specific insights into the sync process. Here's a detailed explanation of each column header:
Description: Indicates the direction of the synchronization process. It can show whether the sync was from the source system to the destination system SYNC_FROM_SOURCE or SYNC_FROM_DESTINATION . This helps in understanding the flow of data during the synchronization.
Description: Shows the current status of the sync operation. Common statuses include Started, Done. This column is crucial for monitoring the success or failure of each sync attempt.
Description: Displays the number of new users added to the system as a result of the sync operation. This metric is important for tracking how many new accounts have been created during the synchronization process.
Description: Indicates the number of user profiles that were updated during the sync. This could include changes to user details such as email, name, or roles. It's a key metric for understanding the extent of updates applied during synchronization.
Description: Shows the number of users removed from the system during the sync process. This column is important for tracking user deletions and ensuring that the system reflects the most current user information.
Description: Records the date and time when the sync operation began. This timestamp is essential for scheduling and auditing purposes, allowing administrators to track when each sync was initiated.
Description: Captures the date and time when the sync operation was completed. This helps in evaluating the duration of the sync process and ensuring that sync operations are completed as expected.
