[LA-36992] Document role param on user-update API docs#55
Merged
Conversation
The Update a User parameter table omitted role, though the worked example and 200 response in the same section already show it. Both update endpoints (by id and by integrationExternalId) accept role. Also correct the Create a User role list, which was missing learning_designer. Co-Authored-By: Claude Fable 5 <[email protected]>
tejanium
approved these changes
Jun 11, 2026
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Jira
https://learnamp.atlassian.net/browse/LA-36992
What
Adds the
roleparameter to the Update a User "Data in Body" table, and corrects the role values listed on Create a User (was missinglearning_designer).Why
The update endpoints (
PUT /v1/users/{userId}andPUT /v1/users/by_integration_external_id/{integrationExternalId}) both acceptrole(User.admin_settable_roles), and the worked example plus the 200 response in the same docs section already show it, but the parameter table omitted it. The docs were internally inconsistent and hid a supported field from integrators.The
by_integration_external_idsection cross-references "the same body parameters as Update a User", so it inherits the new row automatically.Acceptance Criteria
roledocumented in the Update a User parameter tableowner/super_adminexcluded;hrpackage note)learning_designer🤖 Generated with Claude Code
Note
Low Risk
Markdown-only API documentation changes with no runtime or security impact.
Overview
Updates Users API reference in
_users.mdsoroleis documented consistently for create and update.Create a User — the
rolerow now lists allowed values asviewer,curator,reporter,learning_designer,hr,admin(addslearning_designerand aligns ordering with the API).Update a User — adds a
rolebody parameter (enum, exampleadmin) describing settable system roles, noting thatownerandsuper_admincannot be set via the API and thathrrequires the HR-role package (otherwise422). The by_integration_external_id update path already defers to this table, so it picks up the new row without further edits.Reviewed by Cursor Bugbot for commit f2e89bb. Bugbot is set up for automated code reviews on this repo. Configure here.