Use ºÚÁϺ£½Ç91Èë¿Ú SAML Single Sign On (SSO) to give your users convenient but secure access to all their web applications with a single set of credentials. Automatically provision, update and deprovision users and groups in Interact Software from ºÚÁϺ£½Ç91Èë¿Ú using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in ºÚÁϺ£½Ç91Èë¿Ú for Interact Software. Save time and avoid mistakes, as well as potential security risks, related to manually creating users.
Read this article to learn how to setup the Interact Software integration.
Prerequisites
- A ºÚÁϺ£½Ç91Èë¿Ú administrator account.
- ºÚÁϺ£½Ç91Èë¿Ú SSO Package or higher or SSO add-on feature.
- A Interact Software user account with administrator permissions.
- Your Interact Software subdomain name.
- SSO is recommended but not required.
- SSO users must already be set up in the People Directory.
- Interact Software SCIM API is based on version 2.0 of the SCIM standard.
- If you need to update the SCIM token, you must deactivate the IdM integration, update the token, and then reactivate the integration.
- Groups are supported.
Attribute Considerations
- A default set of attributes are managed for users. See the Attribute Mappings section for more details.
- The following attributes are not supported by ºÚÁϺ£½Ç91Èë¿Ú:
- timezone
- manager
- profileUrl
- jobEndDate
- bio
- jobStartDate
- DOB
- initials
- facebookID
- linkedInId
- twitterTag
- instagramTag
- passwordReset
- ims(type="skype").value
Creating a new ºÚÁϺ£½Ç91Èë¿Ú Application Integration
- Log in to the .
- Go to USER AUTHENTICATION &²µ³Ù;ÌýSSO Applications.
- Click + Add New Application.
- Type the name of the application in the Search field and select it.
- Click Next.
- In the Display Label, type your name for the application. Optionally, you can enter a Description, adjust the User Portal Image and choose to hide or Show in User Portal.
If this is a Bookmark Application, enter your sign-in URL in the Bookmark URL field.
- Optionally, expand Advanced Settings to specify a value for the SSO IdP URL. If no value is entered, it will default to https://sso.jumpcloud.com/saml2/<applicationname>.
The SSO IdP URL is not editable after the application is created. You will have to delete and recreate the connector if you need to edit this field at a later time.
- Click Save Application.
- If successful, click:
- Configure Application and go to the next section
- Close to configure your new application at a later time
Configuring the SSO Integration
To configure ºÚÁϺ£½Ç91Èë¿Ú
- Create a new application or select it from the Configured Applications list.
- Select the SSO tab.
- Replace any instances of YOUR_SUBDOMAIN with your Interact subdomain name.
- Add or change any attributes.
- Click save.
Copy the metadata URL
- Find your application in the Configured Applications list and click anywhere in the row to reopen its configuration window.
- Select the SSO tab and click Copy Metadata URL.
- The URL will be copied to your clipboard.
To configure Interact Software
- Navigate to Application Settings > Control Panel > Manage Security > Manage SAML Authentication.
- Click Setup Domain next to your relevant URL.
- Under Service Provider Details, copy the EntityID and ensure it matches the SP Entity ID in ºÚÁϺ£½Ç91Èë¿Ú.
- Click Save.
- Click Identity Providers after you are directed back to Manage SAML Authentication.
- In the Metadata URL textbox, paste the ºÚÁϺ£½Ç91Èë¿Ú Metadata URL copied in the previous section.
- Click Import.
- Click Edit for the new IdP.
- Enter a name for the IdP and select whether or not you would like it to appear as a button on the Log-In screen for your Intranet. The name your enter here will be the name displayed on button.
- Click Save.
- Optionally, to set up Auto Log in, select Make Default Provider for your domain and click Back.
- Then select Enable Auto Login.
Authorizing User SSO Access
Users are implicitly denied access to applications. After you connect an application to ºÚÁϺ£½Ç91Èë¿Ú, you need to authorize user access to that application. You can authorize user access from the Application Configuration panel or from the Groups Configuration panel.
To authorize user access from the Application Configuration panel
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications, then select the application to which you want to authorize user access.
- Select the User Groups tab. If you need to create a new group of users, see Get Started: User Groups.
- Select the check box next to the group of users you want to give access.
- Click save.
To learn how to authorize user access from the Groups Configuration panel, see Authorize Users to an SSO Application.
Validating SSO user authentication workflow(s)
IdP-initiated user workflow
- Access the
- Go to Applications and click an application tile to launch it
- ºÚÁϺ£½Ç91Èë¿Ú asserts the user's identity to the SP and is authenticated without the user having to log in to the application
SP-initiated user workflow
- Go to the SP application login - generally, there is either a special link or an adaptive username field that detects the user is authenticated through SSO
This varies by SP.
- Login redirects the user to ºÚÁϺ£½Ç91Èë¿Ú where the user enters their ºÚÁϺ£½Ç91Èë¿Ú credentials
- After the user is logged in successfully, they are redirected back to the SP and automatically logged in
Configuring the Identity Management Integration
To configure Interact Software
- As a Power User, go to Application Settings > Manage People > Manage Profile Sources.
- Click SCIM.
- Enter a user-friendly name (ºÚÁϺ£½Ç91Èë¿Ú), click Generate Key, and make sure the Active checkbox is checked.
It is highly recommended that you also enable Log Request Body in SCIM Service as this will provide more verbose logging.
- Copy the Authentication Token for the next section.
The Client ID and Secret (token) may only be shown once. Copy them to a secure location, like the ºÚÁϺ£½Ç91Èë¿Ú Password Manager, for future reference.
To configure ºÚÁϺ£½Ç91Èë¿Ú
- Create a new application or select it from the Configured Applications list.
- Select the Identity Management tab.
- Select the Enable management of User Groups and Group Membership in this application checkbox if you want to provision, manage, and sync groups in Interact Software from ºÚÁϺ£½Ç91Èë¿Ú.
- Click Configure.
- You’re presented with two fields:
- Base URL: Enter the SCIM URL for Interact Software: https://{YOUR_SUBDOMAIN}/api/v2/scim/v2
- Token Key: Paste the Authentication Token you created in Interact Software.
- Click Activate.
- You will receive a confirmation that the Identity Management integration has been successfully verified.
- Click save.
- You can now connect user groups to the application in ºÚÁϺ£½Ç91Èë¿Ú to provision the members of that group in Interact Software. Learn how to Authorize Users to an Application.
Attribute Mappings
The following table lists attributes that ºÚÁϺ£½Ç91Èë¿Ú sends to the application. See Attribute Considerations for more information regarding attribute mapping considerations.
Learn about ºÚÁϺ£½Ç91Èë¿Ú Properties and how they work with system users in our .
Interact User Attributes
ºÚÁϺ£½Ç91Èë¿Ú Property | ºÚÁϺ£½Ç91Èë¿Ú UI Field Name | SCIM v2 Mapping | Interact Software Value |
---|---|---|---|
username | Username | userName | userName |
active | Status | active | active |
employeeType | employeeType | userType | userType |
Company Email | emails:value | emails | |
employeeIdentifier | Employee ID | externalId | externalId |
firstname | First Name | name.givenName | name.givenName |
lastname | Last Name | name.familyName | name.familyName |
jobTitle | Job Title | jobTitle | title |
preferredLanguage | preferredLanguage | preferredLanguage | preferredLanguage |
locale | Locale | locale | Locale |
phoneNumbers.value   | Work Phone | phoneNumbers.value   | phoneNumbers.value   |
department | Department | department | department |
company | Company | organization | organization |
location | location | location | location |
password | password | password | password |
addresses.streetAddress   | Work Street Address | addresses.streetAddress   | addresses.streetAddress   |
addresses.locality   | Work City | addresses.locality   | addresses.formatted |
addresses.region   | Work State | addresses.region   | ²¹»å»å°ù±ð²õ²õ±ð²õ.°ù±ð²µ¾±´Ç²ÔÌýÌýÌý |
Group Attributes
ºÚÁϺ£½Ç91Èë¿Ú Property | ºÚÁϺ£½Ç91Èë¿Ú UI Field Name | SCIM v2 Mapping | Application Value |
---|---|---|---|
name | Name | displayName | Name |
Group Management Considerations
Enabling Group Management
You must select the Enable management of User Groups and Group Membership in this application option to manage groups and group membership in the application from ºÚÁϺ£½Ç91Èë¿Ú.
Group Provisioning and Syncing
- Empty groups are not created
- ºÚÁϺ£½Ç91Èë¿Ú takes over management of existing groups in the application when the user group name in ºÚÁϺ£½Ç91Èë¿Ú matches the name of the group in the application
- All user groups associated with the application in ºÚÁϺ£½Ç91Èë¿Ú are synced. Syncing occurs whenever there is a membership or group change event
- Group renaming is supported
- If a user group is disassociated from the application in ºÚÁϺ£½Ç91Èë¿Ú, syncing immediately stops and the group is left as-is in the application. All members of that user group are deactivated in the application unless they are associated with another active application group that is managed from ºÚÁϺ£½Ç91Èë¿Ú
Group Deletion
- Managed groups deleted in ºÚÁϺ£½Ç91Èë¿Ú are deleted in the application
- All members of the deleted group are deactivated in the application, unless they are associated with another active application group that is managed from ºÚÁϺ£½Ç91Èë¿Ú
Disabling Group Management
- You can disable group and group membership management by unchecking the Enable management of User Groups and Group Membership in this applicationÌý´Ç±è³Ù¾±´Ç²Ô
- The managed groups and group membership are left as-is in the application
- ºÚÁϺ£½Ç91Èë¿Ú stops sending group membership information for the user, but the user’s identity will continue to be managed from ºÚÁϺ£½Ç91Èë¿Ú
Importing Users
This functionality is helpful if users have already been created in the application but have not been created in ºÚÁϺ£½Ç91Èë¿Ú.
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application and click to open its configuration panel.
- Select the Identity Management tab.
- Click manual import.
- Select the users you want to create in ºÚÁϺ£½Ç91Èë¿Ú from the application from the list of users that appear. Users in the list have two import statuses:
- ±·±ð·ÉÌý- user has not been imported
- ±õ³¾±è´Ç°ù³Ù±ð»åÌý- user has been imported and has an account in ºÚÁϺ£½Ç91Èë¿Ú
Tip: Try using the New Users-only filter when selecting users to import. This will move all of your new users to the top of the list, making them easier to identify and select.
- Click import.
- If you are importing less than 100 users, your import results will display in real time and you can continue onboarding your usersÂ
- If you have more than 100 users being imported, ºÚÁϺ£½Ç91Èë¿Ú will send you an email when your import is complete
- You can now connect and grant users access to all their ºÚÁϺ£½Ç91Èë¿Ú resources. Learn more in the Authorize Users to an Application and Connecting Users to Resources articles.
Warning: Imported users must be members of a user group bound to an application for ºÚÁϺ£½Ç91Èë¿Ú to manage their identity in, and access to, the application.
SCIM Directory Insights Events
The following Directory Insights (DI) events provide visibility into failures and detailed information about the user and group data being added or updated from HR or other external solutions to ºÚÁϺ£½Ç91Èë¿Ú.
Customers with no package or the Device Management Package will need to add the Directory Insights à la carte option. Directory Insights is included in all other .
SCIM DI Integration Events
Event Name | Event Description |
---|---|
idm_integration_activate | Logged when an IT admin attempts to activated new SCIM Identity Management integration. |
idm_integration_update | Logged when an IT admin attempts to update a configured and activated SCIM Identity Management integration. |
idm_integration_reauth | Logged when an IT admin attempts to change the credentials for an activated SCIM Identity Management integration. |
idm_integration_delete | Logged when an IT admin attempts to deactivate an activated SCIM Identity Management integration. |
SCIM DI User Events
Event Name | Event Description |
---|---|
user_create_provision | Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to create a new user in service provider application. |
user_update_provision | Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to update an existing user in service provider application. |
user_deprovision | Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to change an existing user to inactive in the service provider application. |
user_delete_provision | Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to delete an existing user in service provider application. |
user_lookup_provision | Logged when ºÚÁϺ£½Ç91Èë¿Ú encounters an issue when trying to lookup a user to determine if the user needs to be created or updated. |
SCIM DI Group Events
These DI events will only be present if SCIM Groups are supported.
Event Name | Event Description |
---|---|
group_create_provision | Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to create a new group in service provider application. |
group_update_provision | Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to update an existing group in service provider application. |
group_delete_provision | Logged when ºÚÁϺ£½Ç91Èë¿Ú tries to delete an existing group in service provider application. |
Removing the Integration
These are steps for removing the integration in ºÚÁϺ£½Ç91Èë¿Ú. Consult your SP's documentation for any additional steps needed to remove the integration in the SP. Failure to remove the integration successfully for both the SP and ºÚÁϺ£½Ç91Èë¿Ú may result in users losing access to the application.
To deactivate the IdM Integration
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you’d like to deactivate and click to open its details panel.
- Under the company name and logo on the left hand panel, click the Deactivate IdM connection link.
- Click confirm.
- If successful, you will receive a confirmation message.
To deactivate the SSO Integration or Bookmark
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you’d like to deactivate and click to open its details panel.
- Select the SSO or Bookmark tab.
- Scroll to the bottom of the configuration.
- Click Deactivate SSO or Deactivate Bookmark.
- Click save.
- If successful, you will receive a confirmation message.
To delete the application
- Log in to the .
- Go to USER AUTHENTICATION > SSO Applications.
- Search for the application that you’d like to delete.
- Check the box next to the application to select it.
- Click Delete.
- Enter the number of the applications you are deleting
- Click Delete Application.
- If successful, you will see an application deletion confirmation notification.