Skip to main content

Remove existing authentication

Removing existing users and groups from the catalog is easy, but make sure to follow these steps closely to prevent yourself from being locked out.

warning

It is important to follow all the steps in this guide to ensure a successful configuration of Entra ID authentication.

If you encounter any issues, please contact support.

Retain admin access to Portal​

To retain admin access to Portal, you need to ensure that you have a user entity in the catalog that is managed by your Entra ID location. To do this, follow these steps:

  1. In the Catalog, find yourself as a user (https://<YOUR_COMPANY>.spotifyportal.com/catalog?filters%5Bkind%5D=user)
  2. Select your user and then "inspect entity" by selecting the "..." button in the top right

inspect entity

  1. Look at the backstage.io/managed-by-location annotation, and check references msgraph. (If not, repeat step 2 for other users that related to you)
managed by location
  1. Copy the entityRef listed in the "Identity section"
entity ref

  1. Visit the Config manager, and select "Portal"

  2. Add the entityRef as a item in portal.authorizedUsers field

authorized users

  1. Save changes

Repeat these steps for every user or group that previously had admin access to Portal.

Remove existing users and groups from the catalog​

To remove existing users and groups from the catalog, follow these steps:

  1. In the Config Manager, go to the Catalog plugin
  2. Click the "modules" tab, and find the related module. A list can be found here
    • GitHub - @backstage/plugin-catalog-backend-module-github-org
    • Entra Id - @backstage/plugin-catalog-backend-module-msgraph
    • Okta - @spotify-portal/plugin-catalog-backend-module-okta
  3. Select "Manage module"
  4. Select "Stop module"

Remove existing Auth Provider​

  1. In the Config Manager, go to the Auth plugin
  2. Click the "modules" tab, and find the related module. A list can be found here
    • GitHub - @spotify-portal/plugin-auth-backend-module-github-provider
    • Entra Id - @backstage/plugin-auth-backend-module-microsoft-provider
    • Okta - @backstage/plugin-auth-backend-module-okta-provider
  3. Remove the config for this module (see screenshot below)

Remove auth config

  1. Save changes

Test your new auth provider​

To test your new auth provider, you can sign out of Portal and sign back in using your Entra ID credentials. If you are unable to sign in, please reach out to your organization's Portal admin for assistance. To sign out follow these steps:

  1. Click "Settings" in the sidebar
  2. Click "..." in your profile
  3. Select "Sign out"
  4. Sign back in using your Entra ID credentials