黑料海角91入口

Help Center Home > Apps and Integrations > Integrate with TeamRetro

Integrate with TeamRetro

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 TeamRetro from 黑料海角91入口 using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in 黑料海角91入口 for TeamRetro. Save time and avoid mistakes, as well as potential security risks, related to manually creating users and groups.

Read this article to learn how to setup the TeamRetro integration.

Prerequisites

  • A 黑料海角91入口 administrator account.
  • 黑料海角91入口 SSO Package or higher or SSO add-on feature.
  • The Organization Owner role in TeamRetro with a TeamRetro enterprise plan.
  • Your TeamRetro ID.

Important Considerations

  • TeamRetro 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.
  • Groups are provisioned in TeamRetro but they're not visible within TeamRetro's admin portal.

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入口

  1. Create a new application or select it from the Configured Applications list.
  2. Select the SSO tab.
  3. Replace any instances of YOUR_ID with your TeamRetro ID.
  4. Add or change any attributes.
  5. Click save.

Download the 黑料海角91入口 metadata file

  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 Export Metadata.
  3. The 黑料海角91入口-<applicationname>-metadata.xml will be exported to your local Downloads folder.

Tip:

Metadata can also be downloaded from the Configured Applications list. Search for and select the application in the list and then click Export Metadata in the top right corner of the window.

To configure TeamRetro

  1. Open .
  2. Browse to your ORGANIZATION > SETTINGS tab.
  3. Select SINGLE SIGN ON from the admin menu.
  4. Select ADD SAML IDENTITY.
  5. Under Identity provider settings (IdP), click Upload Metadata, and then browse to and upload the 黑料海角91入口 metadata file downloaded in the previous section.
  6. Click SAVE CHANGES.
  7. Toggle the IdP to ENABLED.
  8. Click SAVE CHANGES.
  9. Click TEST.
  10. In a new window, you will be redirected to your identity provider to sign in. If you are redirected back to TeamRetro your configuration has succeeded. If you encounter any errors or warnings; please contact TeamRetro.

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

  1. Log in to the .
  2. Go to USER AUTHENTICATION > SSO Applications, then select the application to which you want to authorize user access.
  3. Select the User Groups tab. If you need to create a new group of users, see Get Started: User Groups.
  4. Select the check box next to the group of users you want to give access.
  5. 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

Note:

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 TeamRetro

  1. In TeamRetro, browse to [ORGANIZATION] > SETTINGS > SINGLE SIGN ON
  2. Click CREATE API KEY.
  3. Toggle SCIM to enabled (you may wish to disable Read and Write API access also).
  4. Click CREATE.
  5. Copy the unique SCIM API key to use later in 黑料海角91入口. This value will be entered in the Token Key field in the 黑料海角91入口 Identity Management tab.
  6. Click SAVE CHANGES
  7. Copy one of the SCIM URLs to paste in the Base URL in the 黑料海角91入口 Identity Management tab:
    • If you are hosted in the default US environment: https://scim.teamretro.com
    • If you are hosted in the EU environment: https://scim.eu.teamretro.com 

To configure 黑料海角91入口

  1. Browse to and select TeamRetro 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 TeamRetro from 黑料海角91入口.
  4. Click Configure.
  5. You鈥檙e presented with two fields:
    • *Base URL: Paste the SCIM Endpoint you copied when configuring TeamRetro. (e.g.,聽https://scim.teamretro.com听辞谤听https://scim.eu.teamretro.com听)
    • Token Key: Paste the SCIM token you generated when configuring TeamRetro.
  6. Click save.
  7. You will receive a confirmation that the Identity Management integration has been successfully verified.
  8. You can now connect user groups to the application in 黑料海角91入口 to provision the members of that group in TeamRetro. 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 . 

TeamRetro User Attributes

黑料海角91入口 Property 黑料海角91入口 UI Field Name SCIM v2 Mapping TeamRetro Value
username Username Username userName
firstname First Name name.givenName firstname
lastname Last Name name.familyName lastname
firstname/lastname First Name/Last Name name.formatted Name
active Status active active
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
addresses.postalCode Work Postal Code addresses.postalCode addresses.postalCode
employeeIdentifier Employee ID externalID externalID
preferredLanguage preferredLanguage preferredLanguage preferredLanguage
displayname Display Name displayName displayName
locale Locale locale locale

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鈥檚 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鈥檇 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鈥檇 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鈥檇 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