ºÚÁϺ£½Ç91Èë¿Ú

Integrate with Templafy

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 Templafy from ºÚÁϺ£½Ç91Èë¿Ú using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in ºÚÁϺ£½Ç91Èë¿Ú for Templafy. 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 Templafy integration.

Prerequisites

  • A ºÚÁϺ£½Ç91Èë¿Ú administrator account.
  • ºÚÁϺ£½Ç91Èë¿Ú SSO Package or higher or SSO add-on feature.
  • A Templafy user account with administrator permissions.
  • Your Templafy tenant.

Important Considerations

  • SAML SSO is recommended, but not required.
  • Templafy 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 IdM integration.
  • The following provisioning features are supported for users:
    • Create users.
    • Update user attributes.
    • Deactivate users.
  • Groups are supported. 

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

  1. Log in to the .
  2. Go to USER AUTHENTICATION &²µ³Ù;ÌýSSO Applications.
  3. Click + Add New Application.
  4. Type the name of the application in the Search field and select it.
  5. Click Next.
  6. 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.

Note:

If this is a Bookmark Application, enter your sign-in URL in the Bookmark URL field.

  1. 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>.

Warning:

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.

  1. Click Save Application.
  2. 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Èë¿Ú

Important:

If you are a new customer onboarding on HIVE or an existing customer upgrading to HIVE, please note that Templafy has introduced regional data clusters for hosting the Templafy solution. These will be reflected in the SAML endpoints based on the geographical location. To use the ACS URL in ºÚÁϺ£½Ç91Èë¿Ú based on your region, go to the Sign On tab of the application, check Upgrade to Templafy HIVE, and enter the respective Assertion Consumer Service value:

https://app.templafy.com/AuthServices/Acs

  1. Create a new application or select it from the Configured Applications list.
  2. Select the SSO tab.
  3. Add or change any attributes.
  4. °ä±ô¾±³¦°ìÌýsave.

Copy the metadata URL

  1. Find your application in the Configured Applications list and click anywhere in the row to reopen its configuration window.
  2. Select the SSO tab and click Copy Metadata URL.
  3. The URL will be copied to your clipboard.

To configure Templafy

  1. Contact the Templafy Support team and request that they enable SAML 2.0 for your organization.
  2. Provide the Metadata URL downloaded in the previous section.

Configuring the Identity Management Integration

To configure Templafy

  1. Go to <yourtenant>.templafy.com in a browser and click Administration
  2. Navigate to Authentication Method section in the admin interface 
  3. Scroll further down where you will see a field called The SCIM API Key.
  4. Generate a key, copy it, and store it in a secure place, like a Passwor Manager.

To configure ºÚÁϺ£½Ç91Èë¿Ú

  1. Create a new application or select it from the Configured Applications list.
  2. Select the Identity Management tab.
  3. Select the Enable management of User Groups and Group Membership in this application checkbox if you want to provision, manage, and sync groups in Templafy from ºÚÁϺ£½Ç91Èë¿Ú.
  4. Click Configure.
  5. In the Token Key field, paste the token generated in the previous section.
  6. Click Activate
  7. You will receive a confirmation that the Identity Management integration has been successfully verified.
  8. Click save.
  9. You can now connect user groups to the application in ºÚÁϺ£½Ç91Èë¿Ú to provision the members of that group in Templafy. Learn how to .

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 . 

Templafy User Attributes

ºÚÁϺ£½Ç91Èë¿Ú Property ºÚÁϺ£½Ç91Èë¿Ú UI Field Name SCIM v2 Mapping °Õ±ð³¾±è±ô²¹´Ú²âÌý³Õ²¹±ô³Ü±ð
username Username userName userName
active Status active active
firstname First Name name.givenName First Name
lastname Last Name name.familyName Last Name
preferredLanguage preferredLanguage preferredLanguage preferredLanguage
department Department department department
displayname Display Name displayname displayname
jobTitle Job Title jobTitle title
preferredLanguage preferredLanguage preferredLanguage preferredLanguage
phoneNumbers.value     Work Phone phoneNumbers.value     phoneNumbers.value    
addresses.locality     Work City addresses.locality     addresses.locality    
addresses.region     Work State addresses.region     addresses.region    
addresses.country     Work Country addresses.country     addresses.country    
²¹»å»å°ù±ð²õ²õ±ð²õ.±è´Ç²õ³Ù²¹±ô°ä´Ç»å±ðÌýÌý Work Postal Code ²¹»å»å°ù±ð²õ²õ±ð²õ.±è´Ç²õ³Ù²¹±ô°ä´Ç»å±ðÌýÌý ²¹»å»å°ù±ð²õ²õ±ð²õ.±è´Ç²õ³Ù²¹±ô°ä´Ç»å±ðÌýÌý
addresses.streetAddress     Work Street Address addresses.streetAddress     addresses.streetAddress    
company Company organization organization
employeeIdentifier Employee ID externalId externalId

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Èë¿Ú.

  1. Log in to the .
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application and click to open its configuration panel. 
  4. Select the Identity Management tab.
  5. Click manual import.
  6. 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.

  1. 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
  1. 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Èë¿Ú.

Note:

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

Important:

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

Important:

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

  1. Log in to the .
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application that you’d like to deactivate and click to open its details panel. 
  4. Under the company name and logo on the left hand panel, click the Deactivate IdM connection link.
  5. Click confirm
  6. If successful, you will receive a confirmation message.

To deactivate the SSO Integration or Bookmark

  1. Log in to the .
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application that you’d like to deactivate and click to open its details panel. 
  4. Select the SSO or Bookmark tab.
  5. Scroll to the bottom of the configuration.
  6. Click Deactivate SSO or Deactivate Bookmark
  7. Click save
  8. If successful, you will receive a confirmation message.

To delete the application

  1. Log in to the .
  2. Go to USER AUTHENTICATION > SSO Applications.
  3. Search for the application that you’d like to delete.
  4. Check the box next to the application to select it.
  5. Click Delete.
  6. Enter the number of the applications you are deleting
  7. Click Delete Application.
  8. If successful, you will see an application deletion confirmation notification.
Back to Top

List IconIn this Article

Still Have Questions?

If you cannot find an answer to your question in our FAQ, you can always contact us.

Submit a Case