Skip to content

cleaned up Microsoft Entra ID SAML config doc #1001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
loujar merged 1 commit into from
Feb 27, 2025
Merged

cleaned up Microsoft Entra ID SAML config doc #1001

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/admin/auth/saml/azure_ad.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
## 1. Add an unlisted (non-gallery) application to your Microsoft Entra ID organization

1. In Microsoft Entra ID, create an unlisted (non-gallery) application [following the official documentation](https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/add-non-gallery-app).
1. Once the application is created, follow [these instructions to enable SAML SSO](https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/configure-single-sign-on-non-gallery-applications). Use these configuration values (replacing "sourcegraph.example.com" with your Sourcegraph instance URL):
* **Identifier (Entity ID):** `https://sourcegraph.example.com/.auth/saml/metadata`
* **Reply URL (Assertion Consumer Service URL):** `https://sourcegraph.example.com/.auth/saml/acs`
* **Sign-on URL, Relay State, and Logout URL** can be left empty.
* **User Attributes & Claims:** Add the following attributes.
- `emailaddress`: user.mail (required)
- `name`: user.userprincipalname (optional)
- `login`: user.userprincipalname (optional)
* **Name ID**: `email`
* You can leave the other configuration values set to their defaults.
1. Record the value of the "App Federation Metadata Url". You'll need this in the next section.
2. Once the application is created, follow [these instructions to enable SAML SSO](https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/configure-single-sign-on-non-gallery-applications). Use these configuration values (replacing "sourcegraph.example.com" with your Sourcegraph instance URL):
* **Identifier (Entity ID):** `https://sourcegraph.example.com/.auth/saml/metadata`
* **Reply URL (Assertion Consumer Service URL):** `https://sourcegraph.example.com/.auth/saml/acs`
* **Sign-on URL, Relay State, and Logout URL** can be left empty.
* **User Attributes & Claims:** Add the following attributes.
- `emailaddress`: user.mail (required)
- `name`: user.userprincipalname (optional)
- `login`: user.userprincipalname (optional)
* **Name ID**: `email`
* You can leave the other configuration values set to their defaults.
3. Record the value of the "App Federation Metadata Url". You'll need this in the next section.

## 2. Add the SAML auth provider to Sourcegraph site config

Expand All @@ -33,4 +33,4 @@
}
```

> NOTE: Optional, but recommended: [add automatic provisioning of users with SCIM](/admin/scim).
<Callout type="note">Recommended: [add automatic provisioning of users with SCIM](/admin/scim).</Callout>