feat(scim-for-entra): BEE-866 / Add documentation for SCIM with Microsoft Entra ID

.gitignore

@@ -24,6 +24,7 @@ pnpm-debug.log*
 .DS_Store
 .kiro
 .vscode
+.idea
 
 # Python
 .venv/

astro.config.mjs

@@ -724,7 +724,16 @@ export default defineConfig({
                 {
                   label: 'Single Sign-On',
                   items: [
-                    { autogenerate: { directory: '/aws/enterprise/sso' } },
+                    { slug: 'aws/enterprise/sso' },
+                    { slug: 'aws/enterprise/sso/azure-ad' },
+                    {
+                      label: 'SCIM',
+                      items: [
+                        { slug: 'aws/enterprise/sso/scim' },
+                        { slug: 'aws/enterprise/sso/scim/okta' },
+                        { slug: 'aws/enterprise/sso/scim/entra' },
+                      ],
+                    },
                   ],
                 },
                 {

src/content/docs/aws/enterprise/sso/scim/entra.md

@@ -0,0 +1,137 @@
+---
+title: SCIM with Entra ID
+description: Configuring Microsoft Entra ID as the SCIM client for LocalStack user provisioning.
+template: doc
+tags: ['Enterprise']
+sidebar:
+  order: 3
+---
+
+This page covers configuring **Microsoft Entra ID** as your SCIM client to provision users and groups into LocalStack. Before starting, make sure you've completed the steps in the [SCIM overview](/aws/enterprise/sso/scim/) to enable SCIM and obtain the **SCIM Base Connector URL** and **Bearer Auth Token** from the LocalStack web app.
+
+## Configuring SCIM with Microsoft Entra ID
+
+Use the following steps to configure SCIM provisioning from a Microsoft Entra ID Enterprise Application.
+
+1. **Select or create your Enterprise Application** — In the [Microsoft Entra admin center](https://entra.microsoft.com), go to **Identity → Applications → Enterprise applications** and select the application you want to enable SCIM provisioning for. If you don't have one yet, create a new non-gallery application.
+2. **Navigate to Provisioning** — In the application's side menu, open **Manage → Provisioning**. On first setup, click **Get started** and set the **Provisioning Mode** to **Automatic**.
+3. **Enter the SCIM connection details** under the **Connectivity** section (or **Admin Credentials** in the legacy view):
+   - **Authentication method:** Select **Bearer authentication**.
+   - **Tenant URL:** Paste the SCIM Base Connector URL from the LocalStack SCIM configuration panel.
+   - **Secret Token:** Paste the SCIM bearer token from the LocalStack SCIM configuration panel.
+
+   ![Entra ID SCIM connectivity configuration](/images/aws/SCIM_entra_connectivity.png)
+
+4. **Test the connection and save** — Click **Test connection** to confirm Entra can reach LocalStack, then save the settings.
+5. **(Recommended) Set scope** — Under **Provisioning → Settings → Scope**, select **Sync only assigned users and groups** to limit provisioning to users and groups you explicitly assign to the application.
+6. **Start provisioning** — Return to the Provisioning overview and click **Start provisioning**. Entra will sync user and group changes to LocalStack every ~40 minutes; for an immediate sync of a specific user, use **Provision on Demand** from the Provisioning blade.
+
+:::caution
+Do **NOT** enable the `aadOptscim062020` feature flag on the Entra provisioning configuration. This flag changes Entra's outbound `PATCH /Groups` semantics in a way that can cause destructive single-user member replacements. The default behavior (flag off) is what LocalStack expects.
+:::
+
+### User Management
+
+#### Provisioning Individual Users
+
+LocalStack supports full provisioning and deprovisioning of individual user accounts via SCIM.
+
+:::note
+For security reasons, SCIM can only provision user accounts for users who do not already exist in the LocalStack web app. If a user was originally created via SCIM and later removed from your workspace, you must invite them again through the LocalStack [**Users & Licenses**](https://app.localstack.cloud/settings/members). The user will receive an email invitation and must explicitly accept it to rejoin the workspace.
+:::
+
+1. **Create the user in Entra** (if not already present) — In **Microsoft Entra ID → Users**, click **+ New user → Create new user** and fill in the basic details (User principal name, Display name, etc).
+   ![Creating a new user in Entra ID](/images/aws/SCIM_entra_create_new_user.png)
+
+2. **Assign the user to the LocalStack application** — Open your Enterprise Application and go to **Manage → Users and groups**. Click **+ Add user/group**, search for the user, select them, and click **Select**.
+   ![Selecting users to assign to the application](/images/aws/SCIM_entra_add_members_search.jpg)
+
+3. **Wait for sync** — On the next provisioning cycle (or via **Provision on Demand**), Entra will send a SCIM request to LocalStack to create the user account.
+
+:::tip
+Legacy users (existing LocalStack accounts) can also be assigned to the Entra application, provided their email address matches the one they used to register with the LocalStack web app.
+:::
+
+#### Updating User Accounts
+
+Changes to user attributes (first name, last name, email) in Entra are automatically pushed to LocalStack via SCIM while the integration is active.
+
+#### Deprovisioning Users
+
+1. In Entra, open the LocalStack Enterprise Application and go to **Manage → Users and groups**.
+2. Find the user you want to remove and click **Remove**.
+3. Confirm the action.
+
+Entra will send a SCIM deprovisioning request and the user will be removed from LocalStack on the next sync cycle. Disabling the user in the Entra directory itself (`accountEnabled = false`) has the same effect.
+
+#### Provisioning Groups of Users
+
+Groups in Microsoft Entra ID can be used to provision multiple users to LocalStack at once. To enable group provisioning, ensure the **Provision Microsoft Entra ID Groups** mapping is enabled in **Provisioning → Mappings**.
+
+##### Assigning a Group
+
+1. **Create a security group** — In **Microsoft Entra ID → Groups → All groups**, click **+ New group**. Choose **Security** as the group type, set the **Membership type** to **Assigned**, give the group a name, and (optionally) a description.
+   ![Creating a new security group in Entra ID](/images/aws/SCIM_entra_new_group.png)
+2. **Add members to the group** — In the same form (or after creation, via the group's **Members** tab), select the users you want to provision.
+   ![Adding members to a group in Entra ID](/images/aws/SCIM_entra_create_group_member_popup.png)
+3. **Assign the group to the application** — Open your Enterprise Application, go to **Manage → Users and groups**, click **+ Add user/group**, select the group, and confirm.
+4. **Wait for sync** — Entra will send SCIM requests to LocalStack to provision each member on the next sync cycle.
+
+Changes to a group's membership in Entra are automatically pushed to LocalStack via SCIM on subsequent sync cycles.
+
+##### Deprovisioning a Group
+
+1. In Entra, open the LocalStack Enterprise Application and go to **Manage → Users and groups**.
+2. Find the group and click **Remove**.
+3. Confirm the action.
+
+Entra will send SCIM requests to remove the group's users from LocalStack. Users who were provisioned solely through this group assignment will also be deprovisioned.
+
+:::tip
+Any changes in Entra (user/group attribute changes, group memberships, etc.) are automatically synchronized with LocalStack on subsequent sync cycles as long as the SCIM integration is active.
+:::
+
+### Role Management
+
+LocalStack workspace roles (**admin** and **member**) are assigned to users by syncing SCIM groups whose name identifies the target role. The role groups themselves do not need to exist in LocalStack before the sync — they are synthetic SCIM groups keyed off the `displayName`.
+
+:::caution
+Each user can only be in **one** role group at a time. Attempting to add a user who is already in the admin role group to the member role group (or vice versa) returns a `409` conflict. Remove the user from the previous role group first, then add to the new one.
+:::
+
+#### Group Name Convention
+
+Role groups are matched by `displayName` using a case-insensitive substring check:
+
+- Any group whose name contains `admin` → admin role group
+- Any group whose name contains `member` → member role group
+
+All of the following are valid names for the admin role group:
+
+- `LocalStack-Admin`
+- `LocalStack-Admins-Prod`
+- `XD5-XD5-LA1000_AuthLocalstackAdmin`
+
+The first time you sync a role group from Entra, LocalStack persists that `displayName` so subsequent GET responses to your IdP reflect the name you sent. You can also rename the group later via SCIM and LocalStack will track the rename.
+
+#### Creating a Role Group in Microsoft Entra ID
+
+1. In **Microsoft Entra ID → Groups → All groups**, click **+ New group**. Create a **Security** group with **Membership type: Assigned** whose name contains either `Admin` (for the admin role) or `Member` (for the member role).
+   ![Creating a role group in Entra ID](/images/aws/SCIM_entra_role_group.png)
+2. Add users to the group (users must already be assigned to the LocalStack Enterprise Application).
+3. Assign the group to the LocalStack Enterprise Application via **Manage → Users and groups**.
+4. Confirm that **Provision Microsoft Entra ID Groups** is enabled under **Provisioning → Mappings**.
+5. On the next provisioning cycle (or via **Provision on Demand**), Entra will sync the group to LocalStack and assign the corresponding role to all members.
+
+#### Moving a User Between Roles
+
+To change a user's role from member to admin (or vice versa):
+
+1. Remove the user from their current role group in Entra.
+2. Add them to the target role group.
+
+Perform these operations as a single atomic action where possible. Adding a user to the new role group while they are still in the old one will return a `409` conflict.
+
+#### Last-Admin Protection
+
+LocalStack will reject any SCIM request that would leave the workspace without an admin. If you attempt to remove the only admin from the admin role group, the request fails with `409 Cannot remove the last workspace admin`. Assign another admin in LocalStack first, then retry the removal.

src/content/docs/aws/enterprise/sso/scim/index.md

@@ -0,0 +1,99 @@
+---
+title: SCIM
+description: Automating user and license provisioning in LocalStack using SCIM (System for Cross-domain Identity Management).
+template: doc
+tags: ['Enterprise']
+sidebar:
+  label: Overview
+---
+
+SCIM (System for Cross-domain Identity Management) allows you to automate user provisioning, deprovisioning, and license assignment in LocalStack through your identity provider (IdP). LocalStack's SCIM implementation follows the SCIM v2.0 specification and has been developed and tested with both the **Okta** and **Microsoft Entra ID** SCIM clients.
+
+SCIM is a sub-feature of SSO and requires an active SSO configuration with at least one Identity Provider already set up. See the [Single Sign-On](/aws/enterprise/sso/) documentation before proceeding.
+
+All integration details — including the SCIM Base Connector URL, Bearer Auth Token, and group names per subscription — are available in the LocalStack web app under **Settings → [Single Sign-On](https://app.localstack.cloud/settings/sso)**.
+
+For IdP-specific setup instructions, see:
+
+- [SCIM with Okta](/aws/enterprise/sso/scim/okta/)
+- [SCIM with Microsoft Entra ID](/aws/enterprise/sso/scim/entra/)
+
+## Prerequisites
+
+- An active Enterprise subscription with the SCIM feature enabled
+- A configured SSO Identity Provider (OIDC or SAML)
+- Admin access to your organization in the LocalStack web app
+
+## Enabling SCIM
+
+In the LocalStack web app, navigate to **Settings → Single Sign-On**. For each configured Identity Provider, you will see a **SCIM User Provisioning** toggle. Enable it for the IdP you want to use for SCIM provisioning.
+
+:::note
+Only one Identity Provider can have SCIM active at a time.
+:::
+
+Once enabled, click **View SCIM Configuration** to access the SCIM Base Connector URL and Bearer Auth Token needed to configure your IdP.
+
+## Setup and Configuration
+
+The settings contain the **SCIM API Base Connector URL** and the **Bearer Auth Token** as shown in the image below. You can copy these values to configure your SCIM client.
+
+![SCIM connection details](/images/aws/SCIM-configuration.jpg)
+
+SCIM clients authenticate using a long-lived bearer token. The token starts with `scim-` and is displayed (masked) in the SCIM configuration panel. Use the copy icon to copy it to your clipboard.
+
+You can regenerate the token at any time using the refresh icon. Regenerating the token immediately invalidates the previous one — update your IdP configuration with the new token to avoid interruptions.
+
+Once you have the Base Connector URL and Bearer Token, continue with the IdP-specific setup:
+
+- [SCIM with Okta](/aws/enterprise/sso/scim/okta/)
+- [SCIM with Microsoft Entra ID](/aws/enterprise/sso/scim/entra/)
+
+## Web App Roles and Permissions
+
+LocalStack supports configuring default roles and permissions that are applied when a user is provisioned via SCIM. These can for example be used to grant users access CI credentials or to make them workspace admins.
+
+Granting users permissions or assigning them to groups (e.g. 'Member', 'Admin') is not supported via SCIM but the settings in the LocalStack web app allow you to set presets that are applied when a user is provisioned via SCIM. These settings are inherited from the SSO settings.
+
+![SCIM user role and permission settings](/images/aws/SCIM-permissions.jpg)
+
+## Limitations
+
+- **One license group per user:** Each user can be assigned to only one license group (subscription) per organization.
+- **One SCIM provider at a time:** Only one Identity Provider can have SCIM enabled at a time.
+- **Provisioning is one-way:** SCIM sync goes from your IdP to LocalStack only. There is no synchronization from LocalStack back to your IdP.
+- **LocalStack UI does not block manual edits:** The LocalStack web app does not prevent you from manually editing SCIM-provisioned users or their license assignments. It is strongly recommended to manage SCIM-provisioned users exclusively through your IdP to avoid inconsistencies.
+- **Re-provisioning removed users requires re-invitation:** If a user was provisioned via SCIM and later removed, they cannot be re-provisioned via SCIM directly. They must be re-invited through the LocalStack **Users & Licenses** page and accept the invitation before being reassigned.
+
+## API Reference
+
+LocalStack's SCIM API is available at `/scim/v2` and implements the SCIM v2.0 specification (RFC 7644).
+
+### User Endpoints (`/scim/v2/Users`)
+
+| Method  | Endpoint              | Description                                                                                                                                                                                |
+| ------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `POST`  | `/scim/v2/Users`      | Create a SCIM user, or idempotently return an existing member when the email matches. Enforces global email uniqueness and `userName` uniqueness per org and IdP.                          |
+| `GET`   | `/scim/v2/Users`      | List active SCIM-provisioned users. Supports `filter=userName eq "..."`, `startIndex`, and `count` for pagination.                                                                         |
+| `GET`   | `/scim/v2/Users/{id}` | Retrieve a SCIM user only if they are SCIM-provisioned and active in the org; returns `404` otherwise.                                                                                     |
+| `PATCH` | `/scim/v2/Users/{id}` | RFC 7644 PatchOp for selected fields (`name`, `emails`) and deactivation via `active:false`. Reactivation via SCIM is not supported. Patching `userName` or `externalId` is not supported. |
+| `PUT`   | `/scim/v2/Users/{id}` | Full replace of mutable fields (name, email) with support for deactivation via `active:false`. Reactivation via SCIM is ignored.                                                           |
+
+### Group Endpoints (`/scim/v2/Groups`)
+
+| Method   | Endpoint               | Description                                                                                                                                                                                                                                                                    |
+| -------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `POST`   | `/scim/v2/Groups`      | Bind an existing subscription as a SCIM group via `displayName` (format: `{PLAN}-{EMULATOR}-{subscription_id}`). Optionally assign members. Validates membership and enforces one-group-per-user per org. Returns `201` on success; `409` for insufficient seats or conflicts. |
+| `GET`    | `/scim/v2/Groups`      | List groups (subscriptions) with their SCIM members. Supports `filter=displayName eq "..."`, `startIndex`, and `count` (max 1000).                                                                                                                                             |
+| `GET`    | `/scim/v2/Groups/{id}` | Retrieve a group by its subscription ID with SCIM members. Returns `404` if not found.                                                                                                                                                                                         |
+| `PATCH`  | `/scim/v2/Groups/{id}` | RFC 7644 PatchOp (`add`, `remove`, `replace`) for members. Supports capacity checks and rollback on partial failures.                                                                                                                                                          |
+| `PUT`    | `/scim/v2/Groups/{id}` | Full replace of group membership. Omitting or passing an empty `members` array clears all members. Supports rollback on errors.                                                                                                                                                |
+| `DELETE` | `/scim/v2/Groups/{id}` | Delete the group binding and unassign SCIM members. Non-SCIM assignments are unaffected. Returns `204` on success.                                                                                                                                                             |
+
+### Metadata Endpoints
+
+| Method | Endpoint                         | Description                                                       |
+| ------ | -------------------------------- | ----------------------------------------------------------------- |
+| `GET`  | `/scim/v2/ResourceTypes`         | List all supported SCIM resource types (`User`, `Group`).         |
+| `GET`  | `/scim/v2/Schemas`               | List supported SCIM schemas for user and group resources.         |
+| `GET`  | `/scim/v2/ServiceProviderConfig` | Return service provider configuration and supported capabilities. |