## Summary Roll out [the feature](https://gitlab.com/gitlab-org/gitlab/-/work_items/452118) currently behind the `scim_discovery_endpoints` feature flag. - DRI: @ricardoamarilla - Team Slack channel: `#g_seat_management` - Introduced by: !257947 (stacked with !258175 and !258176) > [!note] > Process and guidance live in the docs — this issue is just the commands and a place to track the rollout. > "Rolling out" means incrementally enabling the flag on GitLab.com to validate stability — it is not the same as releasing the feature, which happens when the flag is removed. > [Feature flag controls](https://docs.gitlab.com/development/feature_flags/controls/) · [Feature flag lifecycle](https://handbook.gitlab.com/handbook/product-development/how-we-work/product-development-flow/feature-flag-lifecycle/#feature-flag-lifecycle) ## What could go wrong? The flag gates three new **read-only** SCIM discovery endpoints (RFC 7644 §4) on the group SCIM API (`/api/scim/v2/groups/:group_path`) and the instance SCIM API (`/api/scim/v2/application`): - `GET /ServiceProviderConfig` - `GET /ResourceTypes` and `GET /ResourceTypes/:id` - `GET /Schemas` and `GET /Schemas/:id` They don't write data and don't change the existing `/Users` or `/Groups` endpoints. Authentication is the existing SCIM token. Main risk: an identity provider that previously ignored the missing endpoints starts reading them and adjusts its attribute mappings based on what GitLab now advertises (only the attributes GitLab processes, with `userName`, `name`, `displayName` and `emails` as `immutable`). If an IdP reacts badly, disable the flag for that group. Watch 4xx/5xx rates for the `/api/scim/v2/` routes and the exceptions linked below. **Actor:** for group SCIM the actor is the **group**, so the endpoints can be enabled for specific customer groups first. For instance SCIM the actor is `:instance`. Self-Managed and Dedicated only get the endpoints when the flag is removed, because `gitlab_com_derisk` flags are disabled by default. ## Events - [Exceptions with scim_discovery_endpoints:1](https://log.gprd.gitlab.net/app/discover#/?_g=(time:(from:now-1d,to:now))&_a=(index:'7092c4e2-4eb5-46f2-8305-a7da2edad090',query:(language:kuery,query:'json.exception.feature_flag_states.keyword:%22scim_discovery_endpoints:1%22'),columns:!(json.exception.class,json.exception.message,json.extra.workflow_id,json.meta.caller_id),sort:!(!(json.time,desc)))) - [Events with scim_discovery_endpoints:1](https://log.gprd.gitlab.net/app/discover#/?_g=(time:(from:now-1d,to:now))&_a=(index:'7092c4e2-4eb5-46f2-8305-a7da2edad090',query:(language:kuery,query:'json.feature_flag_states:%22scim_discovery_endpoints:1%22'),columns:!(json.meta.caller_id,json.feature_flag_states),sort:!(!(json.time,desc)))) - [Error rate and other graphs by modifying the examples in the Visualization Library](https://log.gprd.gitlab.net/app/visualize#/?_g=h@358d019&s=FF%20Observability) Feature Flag events are only logged by default for feature flags marked for the current or future milestones. To enable while the feature flag is active, see https://docs.gitlab.com/development/feature_flags/#logging ## Rollout Run all production `/chatops` in [`#production`](https://gitlab.slack.com/archives/C101F3796) and cross-post the results to `#g_seat_management`. Background: [incremental rollout process](https://docs.gitlab.com/development/feature_flags/controls/#process), [feature actors](https://docs.gitlab.com/development/feature_flags/#feature-actors). **Non-production** ``` /chatops gitlab run feature set scim_discovery_endpoints 50 --actors --dev --pre --staging --staging-ref /chatops gitlab run feature set scim_discovery_endpoints true --dev --pre --staging --staging-ref ``` **Production** — percentage rollout (wait ≥15 min between steps, watch dashboards): ``` /chatops gitlab run feature set scim_discovery_endpoints <percentage> --actors ``` Or target specific actors instead. The flag actor is the **group**, so enable it first for the SAML groups of the customers validating the rollout (the IdPs requested in #373996 and #452118: CyberArk, ForgeRock, SailPoint): ``` /chatops gitlab run feature set --group=<customer-group-path> scim_discovery_endpoints true ``` ## Before global rollout Confirm the relevant gotchas before going to 100% — see [enabling a feature for GitLab.com](https://docs.gitlab.com/development/feature_flags/controls/#enabling-a-feature-for-gitlabcom): - [Docs + version history](https://docs.gitlab.com/development/documentation/feature_flags/) updated - [Breaking changes](https://docs.gitlab.com/development/documentation/release_notes/#deprecations-removals-and-breaking-changes) announced, if any - [Change management issue](https://handbook.gitlab.com/handbook/engineering/infrastructure-platforms/change-management/#feature-flags-and-the-change-management-process) opened, if required - [External API consumers](https://docs.gitlab.com/development/feature_flags/#do-not-use-feature-flags-in-external-api-consumers) handled with a fail-open mechanism, if applicable ## Cleanup Remove the flag once [deemed stable](https://handbook.gitlab.com/handbook/product-development/how-we-work/product-development-flow/feature-flag-lifecycle/#feature-flag-lifecycle) — see [cleaning up](https://docs.gitlab.com/development/feature_flags/controls/#cleaning-up). Track it here, or open a follow-up [Feature Flag Cleanup issue](https://gitlab.com/gitlab-org/gitlab/-/work_items/new?description_template=Feature%20Flag%20Cleanup). Remove the flag and its YAML definition from the codebase, then: ``` /chatops gitlab run release check <merge-request-url> <milestone> /chatops gitlab run feature delete scim_discovery_endpoints --dev --pre --staging --staging-ref --production ``` ## Rollback ``` /chatops gitlab run feature set scim_discovery_endpoints false # production /chatops gitlab run feature set scim_discovery_endpoints false --dev --pre --staging --staging-ref # non-production /chatops gitlab run feature delete scim_discovery_endpoints --dev --pre --staging --staging-ref --production # remove entirely ```