-
Notifications
You must be signed in to change notification settings - Fork 258
feat(iam): saml #5463
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.
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
Merged
feat(iam): saml #5463
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
8814598
feat(iam): saml
ldecarvalho-doc 21fc1ff
fix(iam): saml review
ldecarvalho-doc 15b164b
fix(iam): new log in docs
ldecarvalho-doc 878c1ad
feat(iam): add to menu
ldecarvalho-doc e2404c6
feat(iam): reviews
ldecarvalho-doc 43030ca
feat(iam): add sentence
ldecarvalho-doc 1b9cb8f
feat(iam): add sentece
ldecarvalho-doc File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| --- | ||
| title: How to set up identity federation | ||
| description: This page shows you how to set up identity federation on your Organization | ||
| dates: | ||
| validation: 2025-09-21 | ||
| posted: 2025-08-21 | ||
| --- | ||
| import Requirements from '@macros/iam/requirements.mdx' | ||
|
|
||
| Scaleway supports Identity Federation to provide your teams with secure access to their accounts via Single Sign-On (SSO). Depending on your organization’s requirements, you can use either built-in OAuth2 providers or configure SAML for centralized identity management. | ||
|
|
||
ldecarvalho-doc marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <Message type="important"> | ||
| SAML SSO login is in Early Access. This means that currenttly, only a few Organizations can access and test the feature. | ||
| </Message> | ||
|
|
||
| | Feature | **OAuth2** | **SAML** | | ||
| |--------|-------------------------------|--------| | ||
| | **Availability** | Enabled by default for all organizations | Available, but requires setup | | ||
| | **Supported Providers** | Google, GitHub | Any SAML-compatible Identity Provider | | ||
| | **Setup Required** | No | Yes — must be configured by an IAM admin | | ||
| | **User Access** | Any Scaleway member whose email is verified with Google or GitHub | Only users explicitly defined in the Identity Provider | | ||
| | **Centralized Management** | No | Yes — manage users from your Identity Provider | | ||
|
|
||
| <Message type="important"> | ||
| Keep in mind that: | ||
| - OAuth2 logins are automatically disabled when SAML is configured. If SAML is not set up, members can continue to use Google or GitHub for SSO. | ||
| - SSO with SAML does not apply to an Organization's Owner. Owners can log in with SSO with OAuth2. | ||
| </Message> | ||
|
|
||
| Follow the steps below to set up Identity Federation for your Organization through SAML at Scaleway. | ||
|
|
||
| <Requirements /> | ||
|
|
||
| - A Scaleway account logged into the [console](https://console.scaleway.com) | ||
ldecarvalho-doc marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization | ||
| - An Identity Provider (IdP) configured in your company, making sure it includes all users who need to access Scaleway. Some examples of IdPs: | ||
| - Okta | ||
| - OneLogin | ||
| - Microsoft Entra ID (prev. Azure AD) | ||
| - PingIdentity | ||
| - Google Workspace | ||
|
|
||
| ## How to set up a SAML connection | ||
|
|
||
| 1. Go to your security settings. | ||
| 2. Scroll to the **Identity Federation** section. | ||
| 3. Click **Set up SSO**. A pop-up appears. | ||
| 4. Copy the URLs displayed in the pop-up. | ||
|
|
||
| The information in the first step are the URLs referring to Scaleway that will be requested by your Identity Provider to create a link between platforms. They are: | ||
| - The assertion consumer service (ACS) URL, and | ||
| - Scaleway's entity ID | ||
|
|
||
| 5. Click **Next**. | ||
| 6. Enter the requested URLs in their respective boxes. | ||
|
|
||
| This is the information referring to your Identity Provider that Scaleway needs to confirm the connection. It can be found in your IdP's configuration page. They are: | ||
| - **Single Sign-On URL** - This is the URL your members will be redirected to when logging in with SAML | ||
| - **The Identity Provider's Entity ID** | ||
| 7. Click **Confirm**. | ||
| 8. Enter the signing certificate generated by your Identity Provider in the box. | ||
ldecarvalho-doc marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <Message type="important"> | ||
| Keep in mind that: | ||
| - Only base64-encoded certificates are supported. | ||
| - The certificate must have an expiration date. | ||
| - Your certificate entry must start with: | ||
| ``` | ||
| -----BEGIN CERTIFICATE----- | ||
| ``` | ||
| And end with: | ||
| ``` | ||
| -----END CERTIFICATE----- | ||
| ``` | ||
| </Message> | ||
|
|
||
| <Message type="note"> | ||
| You can close the Identity Provider pop-up without adding the certificate right away. The certificate can [be added at a later time](#how-to-add-a-certificate). However, while the certificate is not added, the connection between Scaleway and your Identity Provider will not be complete and the SSO feature will not work for your Organization members. | ||
| </Message> | ||
| 9. Click **Complete setup**. | ||
|
|
||
ldecarvalho-doc marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Once setup is complete, members can log in via SAML. | ||
|
|
||
| <Message type="tip"> | ||
| You can test the connection by creating a member and logging in with the new member account. | ||
| </Message> | ||
|
|
||
| <Message type="important"> | ||
| Keep in mind that: | ||
| - Members need to already have been [created manually](/iam/how-to/manage-members/#how-to-create-a-member) in Scaleway to log in. | ||
| - If you delete a user in the IdP, the corresponding Member is not automatically deleted in your Scaleway Organization. The [deletion must happen manually](/iam/how-to/manage-members/#how-to-delete-a-member). | ||
| </Message> | ||
|
|
||
| ## How to update the connection configuration | ||
|
|
||
| If you change your Identity Provider, you will need to re-configure your SAML connection. | ||
|
|
||
| 1. Go to your security settings. | ||
| 2. Scroll to the **Identity Federation** section. | ||
| 3. Click **Edit configuration**. A pop-up appears. | ||
| 4. (Optional) Replace the Identity Provider's Single Sign-On URL and Entity ID with the information of your new one. | ||
| 5. Click **Confirm**. | ||
|
|
||
ldecarvalho-doc marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## How to add a certificate | ||
|
|
||
| If you started the connection set up, but did not add a certificate right away, you can add it after. While the certificate is not added, the connection between Scaleway and your Identity Provider will not be complete and the SSO feature will not work for your Organization members. | ||
|
|
||
| 1. Go to your security settings. | ||
| 2. Scroll to the **Identity Federation** section. | ||
| 3. Click **+ Add certificate**. A pop-up appears. | ||
| 4. Enter the signing certificate generated by your Identity Provider in the box. | ||
| 5. Click **Confirm**. | ||
|
|
||
| ## How to renew a certificate | ||
|
|
||
| You must regularly update your signing certificate in the frequency set by your Identity Provider. To renew a certificate: | ||
|
|
||
| 1. Go to your security settings. | ||
| 2. Scroll to the **Identity Federation** section. | ||
| 3. Click **Renew certificate**. A pop-up appears. | ||
| 4. Enter the signing certificate generated by your Identity Provider in the box. | ||
| 5. Click **Confirm**. | ||
|
|
||
| ## How to delete a connection | ||
|
|
||
| 1. Go to your security settings. | ||
| 2. Scroll to the **Identity Federation** section. | ||
| 3. Click **Delete SSO**. | ||
| <Message type="important"> | ||
| A pop-up appears to warn you that: | ||
| - Deleting the connection will also delete your identity federation configuration and disable SAML-based SSO connections, preventing Members from logging in via this method. You can reconfigure identity federation at any time. | ||
| </Message> | ||
| 4. Type **DELETE** in the box to confirm. | ||
| 5. Click **Delete**. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.