How do I update my sign-in providers for a Custom Auth Domain?

When you set up a Custom Auth Domain, every sign-in provider you've connected with your own app needs to know about your new domain. This article shows you how to add your new redirect URL to each provider. If you skip this step, sign-in through those providers will stop working once your Custom Auth Domain goes live.

In short: Your new redirect URL is your auth subdomain with https://   in front and /callback   after, for example https://auth.yourdomain.com/callback  . Add it to every provider you've set up with your own app, alongside the existing https://api.breadbutter.io/callback  , so both work. Most providers accept more than one redirect URL, so you just add the new one. Microsoft, GitHub, Basecamp and all SAML connections don't, so for those you create a second app with the new URL and turn it on in Bread & Butter once your Custom Auth Domain is live.

Before you start

Set up your own provider apps first. This only applies to providers you've connected with your own app credentials. If you haven't done that yet, follow the setup article for each provider, such as Google or Microsoft. When you do, add both redirect URLs:

  • https://api.breadbutter.io/callback  
  • https://auth.yourdomain.com/callback  , using your own subdomain

Work out your new redirect URL. It's the subdomain you created the CNAME record for, with https://   in front and /callback   after. For example: https://auth.yourdomain.com/callback  

Providers that need a second app

Some providers only accept one redirect URL per app, or don't accept redirect URLs on different root domains. For these, don't edit your existing app:

  1. Create a second app in the provider's developer portal, the same way you set up the first, using your new redirect URL.
  2. Add it to Bread & Butter as a second connection for that provider, under Settings, then Global Conversion Methods, but leave it turned off.
  3. Once your Custom Auth Domain is live, turn on the new connection and turn off the old one.

This applies to:

  • Microsoft, for both social sign-in and SAML. Microsoft doesn't allow redirect URLs on different root domains in one app. See Microsoft.
  • GitHub. See GitHub.
  • Basecamp. See Basecamp.
  • Okta SAML, OneLogin SAML and Google SAML.

Social sign-in providers

Google

  1. Open the Google Cloud Console.
  2. Select the project your app was created in.
  3. In the left pane, or under Quick Access, click APIs & Services, then Credentials.
  4. Choose the OAuth 2.0 client you set up before.
  5. In Authorized redirect URIs, click Add URI.
  6. Enter your new redirect URL, then click Save.

Facebook

  1. Open the Facebook Developer site.
  2. Click My Apps at the top right, then click the app you created before.
  3. In the left menu, select Use Cases, then click Customize.
  4. In the menu, click Settings, go to Valid OAuth Redirect URIs and add your new redirect URL. Click Save Changes.

LinkedIn

  1. Open the LinkedIn Developer site with your LinkedIn account.
  2. Click My Apps at the top right, then click the app you created before.
  3. Click the Auth tab, then go to the OAuth 2.0 settings section.
  4. In Authorized redirect URLs for your app, add your new redirect URL and click Update.

Slack

  1. Open the Slack Developer site with your Slack account.
  2. Click Your Apps at the top right, then choose the app you set up before.
  3. In the left menu, go to OAuth & Permissions.
  4. In Redirect URLs, click Add New Redirect URI.
  5. Enter your new redirect URL, click Add, then click Save URLs.

QuickBooks

  1. Open the QuickBooks Developer site with your QuickBooks or Intuit account.
  2. Click My Hub, then App dashboard at the top right, and choose the app you set up before.
  3. Click Settings in the left menu, then open the Redirect URIs tab.
  4. Click Add URI, enter your new redirect URL and click Save.

Dropbox

  1. Open the Dropbox Developer site.
  2. Click App Console in the top menu, then choose the app you set up before.
  3. On the Settings tab, go to Redirect URIs.
  4. Enter your new redirect URL, then click Add.

Planning Center

  1. Open the Planning Center Developer site with your Planning Center account.
  2. Find the app you created before and click Edit.
  3. Under Authorization callback URLs, enter your new redirect URL and click Update.

Apple

  1. Open your Apple Developer account.
  2. Click Account in the top menu.
  3. Under Certificates, IDs & Profiles, click Identifiers.
  4. Use the dropdown on the right to switch to Services IDs, then select the app you created before.
  5. Click Configure next to Sign in with Apple.
  6. Next to Website URLs, click the + button.
  7. Under Domains and Subdomains, add the domain of your redirect URL, including the subdomain, for example auth.yourdomain.com  . Under Return URLs, add your new redirect URL.
  8. Click Next, then Done.

Twitch

  1. Open the Twitch Developer console.
  2. Find the app you created before and click Manage.
  3. Under OAuth Redirect URLs, click Add, then enter your new redirect URL.
  4. Click Save at the bottom of the page.

X (Twitter)

  1. Open the X Developer site. After you sign in, you may need to open this link again.
  2. Click Developer Portal at the top right.
  3. Click Apps in the left menu, then select the app you created before.
  4. Click Settings at the top right.
  5. Under App info, in Callback URI / Redirect URL, click Add another and enter your new redirect URL.
  6. Click Save Changes at the bottom of the page.

Salesforce

  1. Open the Salesforce Developer site.
  2. In the left menu, go to Apps, then App Manager, and find your app.
  3. Click the down arrow at the far right of your app, then click Edit.
  4. Under API (Enable OAuth Settings), add your new callback URL.
  5. Click Save at the bottom of the page.

Microsoft, GitHub and Basecamp

These need a second app. See Providers that need a second app, above.

Enterprise providers

Okta (OAuth)

  1. Open your Okta account as an administrator.
  2. In the left menu, open Applications, click Applications, then select the app you created before.
  3. On the General tab, click Edit in General Settings.
  4. Under Login, then Sign-in redirect URIs, click Add URI and enter your new redirect URL.
  5. Click Save.

OneLogin (OAuth)

  1. Open your OneLogin account.
  2. Go to the Administration panel, then the Applications tab, and select the app you created before.
  3. In the left menu, go to Configuration and enter your new redirect URL in Redirect URIs.
  4. Click Save at the top right.

Google (OAuth) and Microsoft (OAuth)

Follow the Google steps above. For Microsoft, create a second app, as described in Providers that need a second app, above.

Okta, OneLogin, Microsoft and Google (SAML)

SAML connections don't accept more than one redirect URL, so each one needs a second app. See Providers that need a second app, above.

When you're done

Once every provider has your new redirect URL, or a second app ready, let Bread & Butter know. We'll verify your routing, and your Custom Auth Domain should be live within one business day. Then turn on any second apps you created and turn off the old ones.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.