Repository navigation
docs: describe the SCIM API operations and parameters - #31517
Closed
nickvigilante wants to merge 2 commits into
Closed
nickvigilante wants to merge 2 commits into
nickvigilante wants to merge 2 commits into
Conversation
The REST API reference renders these routes from swagger.json, and they had no description. Part of DOCS-1439. Assisted-by: AI
Part of DOCS-1439. Assisted-by: AI
This was referenced Oct 29, 2026
Collaborator
Author
|
Combined into #31562, where this PR's changes are the commit Generated by Coder Agents on behalf of @nickvigilante. |
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR adds a
@Descriptionto the 6 SCIM routes taggedEnterprise, and improves the thin parameter text on them.The REST API reference renders these routes from
swagger.json, and they had no description.doc-check
Fact Checker, Continuity Editor, Copy Editor, and Skeptic ran on the branch diff (author self-check).
Findings fixed in the follow-up commit:
GET /scim/v2/UsersandGET /scim/v2/Users/{id}said "Always", but only the legacy handler behaves that way. The new handler returns real users (enterprise/coderd/scim/users.go:181,:192), so the text now namesCODER_SCIM_USE_LEGACY, which defaults to on (codersdk/deployment.go:3791).The Skeptic rejected 1 finding: "calls this" in the authentication sentence (the pronoun has one referent, the route). The text now says "authenticates with" anyway.
Deterministic checks after the follow-up commit:
check_routes.py, both swagger tests, andmake lint/emdashpass.Merge notes
This PR doesn't touch #31473's exemption lists.
If #31473 merges first,
TestEndpointsDocumentednames each route on this PR to remove from those lists.Verification
A JSON diff of
swagger.jsonagainstorigin/mainchanges onlydescriptionvalues (12 leaves, all underpaths, all on the 6 routes).Claims checked against the code
enterprise/coderd/scimroutes.go:46(RequireFeatureMW(codersdk.FeatureSCIM))CODER_SCIM_USE_LEGACYselects and which defaults to onscimroutes.go:33;codersdk/deployment.go:3787,:3791404when no SCIM API key is configuredscimroutes.go:17Authorizationheader (CODER_SCIM_AUTH_HEADER), not a session tokenscimroutes.go:47;legacyscim.go:77,:88;codersdk/deployment.go:3776GET /scim/v2/ServiceProviderConfigAuthMiddlewarewraps the whole handlerscimroutes.go:45,:47;enterprise/coderd/scim_test.go:380GET /scim/v2/UsersCODER_SCIM_USE_LEGACYselects and which defaults to onlegacyscim.go:170,:186;codersdk/deployment.go:3787,:3791; the new handler returns real users atscim/users.go:192GET /scim/v2/Users/{id}404with the legacy handlerlegacyscim.go:200,:223; the new handler returns the user atscim/users.go:181POST /scim/v2/Usersactiveand a primary email, matches an existing user by email or username, and creates users with the OIDC login typelegacyscim.go:295,:309,:314,:392PATCHandPUT /scim/v2/Users/{id}activeis required and only the status changeslegacyscim.go:466,:471,:538,:571, andscimUserStatusat:604PUT /scim/v2/Users/{id}400whenuserNameis set and differs from the current usernamelegacyscim.go:566Writing rules applied
@Descriptionline.api.Authorizecall andcoderd/rbac/roles.go.<,>,{, or}outside them.RequireFeatureMW.Part of DOCS-1439.
Generated by Coder Agents on behalf of @nickvigilante.