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 in KnowBe4 from ºÚÁϺ£½Ç91Èë¿Ú using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in ºÚÁϺ£½Ç91Èë¿Ú for KnowBe4. 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 KnowBe4 integration.
Prerequisites
- A ºÚÁϺ£½Ç91Èë¿Ú administrator account.
- ºÚÁϺ£½Ç91Èë¿Ú SSO Package or higher or SSO add-on feature.
- An KnowBe4 administrator account.
- Your KnowBe4 account ID and an active KnowBe4 subscription.
- Review KnowBe4’s support article.
Important Considerations
- SSO is not required to use the SCIM integration for provisioning and Identity Management, but it is strongly recommended.
- If you need to renew your SCIM token, you must deactivate the Identity Management integration, renew your token and then reactivate the integration.
- There can be a delay of a few minutes when syncing.
Attribute Considerations
- A default set of attributes are managed for users. See the Attribute Mappings section for more details.
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 obtain the KnowBe4 SAML ID
- Sign in to the KnowBe4.
- Go to Account Settings.
- In the SAML section, select Enable SAML.
- Copy the value in the SAML ID field.
- Leave open and go to ºÚÁϺ£½Ç91Èë¿Ú.
To configure ºÚÁϺ£½Ç91Èë¿Ú
- Create a new application or select it from the Configured Applications list.
- Select the SSO tab.
- Replace any instances of SAML_ACCOUNT_ID with your KnowBe4 account ID.
- In the ACS URL and Default Relay State fields, ensure you have the appropriate URL for your location. If you are not in the US, replace <training.knowbe4.com> with your location's value:
- United States: training.knowbe4.com
- European Union: eu.knowbe4.com
- Canada: ca.knowbe4.com
- Germany: de.knowbe4.com
- United Kingdom: uk.knowbe4.com
- Copy the IDP URL for the next section.
- Click save.
Download the certificate
- 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 IDP Certificate Valid > Download certificate.
The certificate.pem will download to your local Downloads folder.
To configure KnowBe4
- In the SAML section, paste the ºÚÁϺ£½Ç91Èë¿Ú IDP URL from the previous section into the IDP URL field. (e.g., https://sso.jumpcloud.com/saml2/knowbe4)
- Under IdP Cert Fingerprint, enter the fingerprint of the SAML certificate downloaded in the previous section. If you are unfamiliar with this process, see .
- Click Save SAML Settings.
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 KnowBe4
- From your KnowBe4 console, click your email address in the top right corner and select Account Settings.
- Navigate to the User Management > User Provisioning section of your settings.
- Select Enable User Provisioning (User Syncing) to display more provisioning settings.
- By default, the toggle will be set to ADI. Click the SCIM toggle to begin setting up.
- Expand your SCIM settings by clicking + SCIM Settings.
- Click Generate SCIM Token. This will open a new window with your token ID.
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.
- Once you’ve saved the information, click OK to close the window.
- Copy the Tenant URL and save it to a place that you can easily access later. You will need this information when configuring the integration in ºÚÁϺ£½Ç91Èë¿Ú.
- Make sure that the Test Mode option is selected
To configure ºÚÁϺ£½Ç91Èë¿Ú
- Create a new application or select it from the Configured Applications list.
- Select the Identity Management tab.
- Click the Enable management of User Groups and Group Membership in this application checkbox if you want to provision, manage, and sync groups in KnowBe4 from ºÚÁϺ£½Ç91Èë¿Ú.
- Click Configure.
- You’re presented with two fields:
- Base URL - paste the Tenant URL you copied when configuring KnowB4
- Token Key - paste the SCIM token you generated when configuring KnowBe4.
- Click save.
- You receive a confirmation that the Identity Management integration has been successfully verified.
To verify the integration and enable syncing in KnowBe4
If you enabled Test Mode when configuring the SCIM integration in KnowBe4, do the following:
- Associate one or more user groups to the KnowBe4 application in ºÚÁϺ£½Ç91Èë¿Ú.
- Login to your KnowBe4 console.
- Click Users from the top navigation bar.
- Select the Provisioning tab.
- Click Details for the received sync.
- Review the information.
- Once the results in the report meet your expectations, disable Test Mode from your Account Settings.
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 .
KnowBe4 User Attributes
ºÚÁϺ£½Ç91Èë¿Ú Property | ºÚÁϺ£½Ç91Èë¿Ú UI | SCIM v2 Mapping | KnowBe4 Value |
---|---|---|---|
Company Email | emails: value | ||
username | Username | userName | IdP Username |
firstname | First Name | name.givenName | First Name |
lastname | Last Name | name.familyName | Last Name |
- | - | userType | User Type |
phoneNumbers.value | Work Phone | phoneNumbers.value | Phone Number |
jobTitle | Job Title | title | Job Title |
employeeIdentifier | Employee ID | externalId | Employee Number |
company | Company | organization | Organization |
department | Department | department | Department |
Displayname | Display Name | displayName | firstname/lastname |
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.