Add collaborators from other institutions to your Flywheel site

  • Updated

Site admins can use Flywheel's CILogon integration to allow users from other institutions to sign in to your Flywheel site using their institution's credentials. There are two steps to this process:

  1. Contact Flywheel to add the institution to your dropdown list.

  2. Verify username format and add the collaborator to your Flywheel site.

This article includes additional troubleshooting steps for the following errors:

  • Login was successful, but <username> is not set up as a user within Flywheel. Contact an administrator to get registered to the platform. See troubleshooting steps.

  • IdP <address> is not whitelisted. Contact an administrator to add your login provider. See troubleshooting steps.

Step 1: Contact Flywheel to add the new identity provider

By default, not all 4000 Identity Providers (IdPs) supported by CILogon are enabled on your site. To add a new IdP:

  1. Verify that the institution is included in this list of supported identity providers. CILogon. In general the list includes all the identity providers registered with InCommon plus all the identity providers InCommon imports from eduGAIN.

  2. Contact Flywheel support to add the identity provider to your site.

Step 2: Verify username format and add the user to your site

Once added, verify the expected format for the username:

  1. Instruct a user from the institution you just added to go to login.flywheel.io, and click CILogon.

    The user is redirected to CILogon

  2. The user should select their institution from the dropdown menu, and click Log On.

    CILogonSignIn.png

  3. The user will be redirected to their institution's sign in page. Once they successfully sign in, they are redirected back to Flywheel. The following message appears "Login was successful, but <username> is not set up as a user within Flywheel. Contact an administrator to get registered to the platform"

    LoginSuccessfulUserNotRegisteredError.png

  4. Use the email noted in the message as the username when you add the user to Flywheel. The username is case sensitive.

    Tip

    This username may be different than the users email address. This is because Flywheel uses the ePPN (eduPersonPrincipalName) field. If the email in the error message did not work, see below the troubleshooting steps below for other ways to find the ePPN.

Troubleshooting CILogon Issues

Determine username format

If you see the error message, "Login was successful, but <username> is not set up as a user within Flywheel. Contact an administrator to get registered to the platform", you need to add the user to Flywheel. If you have already added the user to Flywheel using their email address, you should update the username to use username in the error. This is the users eduPersonPrincipalName (ePPN). This name can be different from the users email address.

If you still see the error after adding the username from the error, you find the ePPN for a user by following the steps below:

  1. Navigate to https://authtest.flywheel.io.

    AuthTestFlywheel.png

  2. Click University Credentials via CILogon.

  3. Select the institution from the dropdown list. You are redirected to the institution's sign in page.

    Note

    If the institution does not appear in the dropdown, contact Flywheel to enable it.

  4. After you successfully sign in, you are redirected to the Flywheel Token Debugger page.

    FlywheelTokenDebuggerExample

  5. Look for "https://flywheel.io/eppn". The value after is what you should enter for the username in Flywheel. All users you add from the institution will follow this same format.

IdP is not whitelisted. Contact an administrator to add your login provider.

The following error appears if you select an institution from the dropdown list that has not yet been enabled on your Flywheel site: "IdP <address> is not whitelisted. Contact an administrator to add your login provider"

IdPisNotWhitelistederror.png

Follow Step 1: Contact Flywheel to add the new identity provider.