mirror of
https://github.com/supabase/supabase.git
synced 2026-06-20 02:27:21 +08:00
9c03ad6b02
## What kind of change does this PR introduce? Docs update. Related to DEPR-551. ## What is the current behavior? Docs MDX still uses the legacy `label` prop for Admonitions, even though #45618 added `title` and kept `label` only as a backwards-compatible alias after #45302 was reverted in #45535. ## What is the new behavior? Migrates Docs-owned Admonitions from `label=` to `title=` without changing rendered copy, component APIs, Studio callsites, design-system examples, or the legacy `label` alias. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Standardized admonition headings across the docs by switching how admonition headings are provided (preserving all visible guidance and examples). Content and instructions remain unchanged; this ensures consistent rendering of callouts and improves uniformity across guides and reference pages. <!-- review_stack_entry_start --> [](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/46053?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack) <!-- review_stack_entry_end --> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Chris Chinchilla <chris.ward@supabase.io>
172 lines
7.9 KiB
Plaintext
172 lines
7.9 KiB
Plaintext
---
|
|
title: 'Set Up SSO with Azure AD'
|
|
description: 'Configure single sign-on with Azure AD (Microsoft Entra).'
|
|
---
|
|
|
|
<Admonition type="note">
|
|
|
|
This feature is only available on the [Team and Enterprise Plans](/pricing). If you are an existing Team or Enterprise Plan customer, continue with the setup below.
|
|
|
|
</Admonition>
|
|
|
|
<Admonition type="tip">
|
|
|
|
Looking for docs on how to add Single Sign-On support in your Supabase project? Head on over to [Single Sign-On with SAML 2.0 for Projects](/docs/guides/auth/enterprise-sso/auth-sso-saml).
|
|
|
|
</Admonition>
|
|
|
|
Supabase supports single sign-on (SSO) using Microsoft Azure AD.
|
|
|
|
## Step 1: Add and register an Enterprise application [#add-and-register-enterprise-application]
|
|
|
|
Open up the [Azure Active Directory](https://portal.azure.com/#view/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/~/Overview) dashboard for your Azure account.
|
|
|
|
Click the _Add_ button then _Enterprise application_.
|
|
|
|
|
|
|
|
## Step 2: Choose to create your own application [#create-application]
|
|
|
|
You'll be using the custom enterprise application setup for Supabase.
|
|
|
|
|
|
|
|
## Step 3: Fill in application details [#add-application-details]
|
|
|
|
In the modal titled _Create your own application_, enter a display name for Supabase. This is the name your Azure AD users will see when signing in to Supabase from Azure. `Supabase` works in most cases.
|
|
|
|
Make sure to choose the third option: _Integrate any other application you
|
|
don't find in the gallery (Non-gallery)_.
|
|
|
|
|
|
|
|
## Step 4: Set up single sign-on [#set-up-single-sign-on]
|
|
|
|
Before you get to assigning users and groups, which would allow accounts in Azure AD to access Supabase, you need to configure the SAML details that allows Supabase to accept sign in requests from Azure AD.
|
|
|
|
|
|
|
|
## Step 5: Select SAML single sign-on method [#saml-sso]
|
|
|
|
Supabase only supports the SAML 2.0 protocol for Single Sign-On, which is an industry standard.
|
|
|
|
|
|
|
|
## Step 6: Upload SAML-based sign-on metadata file [#upload-saml-metadata]
|
|
|
|
First you need to download Supabase's SAML metadata file. Click the button below to initiate a download of the file.
|
|
|
|
<a href="https://alt.supabase.io/auth/v1/sso/saml/metadata?download=true">
|
|
<Button size="large" icon={<IconArrowDown />}>
|
|
Download Supabase SAML Metadata File
|
|
</Button>
|
|
</a>
|
|
|
|
Alternatively, visit this page to initiate a download: `https://alt.supabase.io/auth/v1/sso/saml/metadata?download=true`
|
|
|
|
Click on the _Upload metadata file_ option in the toolbar and select the file you just downloaded.
|
|
|
|
|
|
|
|
All of the correct information should automatically populate the _Basic SAML Configuration_ screen as shown.
|
|
|
|
|
|
|
|
**Make sure you input these additional settings.**
|
|
|
|
| Setting | Value |
|
|
| ----------- | -------------------------------------------- |
|
|
| Sign on URL | `https://supabase.com/dashboard/sign-in-sso` |
|
|
| Relay State | `https://supabase.com/dashboard` |
|
|
|
|
Finally, click the _Save_ button to save the configuration.
|
|
|
|
## Step 7: Obtain metadata URL [#idp-metadata-url]
|
|
|
|
Save the link under **App Federation Metadata URL** in \*section 3 **SAML Certificates\***. You will need to enter this URL later in [Step 10](#dashboard-configure-metadata).
|
|
|
|
|
|
|
|
## Step 8: Enable SSO in the Dashboard [#dashboard-enable-sso]
|
|
|
|
1. Visit the [SSO tab](/dashboard/org/_/sso) under the Organization Settings page. 
|
|
|
|
2. Toggle **Enable Single Sign-On** to begin configuration. Once enabled, the configuration form appears. 
|
|
|
|
## Step 9: Configure domains [#dashboard-configure-domain]
|
|
|
|
Enter one or more domains associated with your users email addresses (e.g., `supabase.com`).
|
|
These domains determine which users are eligible to sign in via SSO.
|
|
|
|
|
|
|
|
If your organization uses more than one email domain - for example, `supabase.com` for staff and `supabase.io` for contractors - you can add multiple domains here. All listed domains will be authorized for SSO sign-in.
|
|
|
|
|
|
|
|
<Admonition type="note">
|
|
|
|
We do not permit use of public domains like `gmail.com`, `yahoo.com`.
|
|
|
|
</Admonition>
|
|
|
|
<Admonition type="note">
|
|
|
|
You can configure each SSO provider with different email domains. For multi-environment setups (Dev/Staging/Prod), we recommend using IdP-initiated flow with multiple SAML apps under the same domain rather than domain-based routing. For more details, see the [Multiple SSO Providers guide](/docs/guides/platform/sso/multiple-providers).
|
|
|
|
</Admonition>
|
|
|
|
## Step 10: Configure metadata [#dashboard-configure-metadata]
|
|
|
|
Enter the metadata URL you obtained from [Step 7](#idp-metadata-url) into the Metadata URL field:
|
|
|
|
|
|
|
|
## Step 11: Configure attribute mapping [#dashboard-configure-attributes]
|
|
|
|
Fill out the Attribute Mapping section using the **Azure** preset.
|
|
|
|
|
|
|
|
## Step 12: Join organization on signup (optional) [#dashboard-configure-autojoin]
|
|
|
|
By default this setting is disabled, users logging in via SSO will not be added to your organization automatically.
|
|
|
|
|
|
|
|
Toggle this on if you want SSO-authenticated users to be **automatically added to your organization** when they log in via SSO. Auto-join applies on **every login**, not just first signup - this makes it safe to test SSO before enabling this feature.
|
|
|
|
|
|
|
|
When auto-join is enabled, you can choose the **default role** for new users:
|
|
|
|
|
|
|
|
We recommend choosing **Developer** as the default role (principle of least privilege) and promoting users individually as needed.
|
|
|
|
<Admonition type="note">
|
|
|
|
Read [the Access Control documentation](/docs/guides/platform/access-control) for details about each role.
|
|
|
|
</Admonition>
|
|
|
|
## Step 13: Save changes [#dashboard-configure-save]
|
|
|
|
When you click **Save changes**, your new SSO configuration is applied immediately. From that moment, any user with an email address matching one of your configured domains who visits your organization's sign-in URL will be routed through the SSO flow.
|
|
|
|
## Step 14: Test your SSO configuration
|
|
|
|
Before rolling out SSO to your organization, we strongly recommend thorough testing. Read [the SSO Testing and Best Practices guide](/docs/guides/platform/sso/testing-best-practices) for:
|
|
|
|
- Step-by-step testing instructions
|
|
- How to verify auto-join works correctly
|
|
- Common issues and troubleshooting
|
|
- Security best practices
|
|
- Pre-launch checklist
|
|
|
|
<Admonition type="note" title="Testing in Azure sandbox">
|
|
|
|
If your organization has an Azure sandbox or test tenant, consider testing your SSO configuration there first before applying to production.
|
|
|
|
</Admonition>
|