Skip to content

Commit

Permalink
Additional note on release and upgrade guides about partial update on…
Browse files Browse the repository at this point in the history
… user attributes

Closes keycloak#28220

Signed-off-by: Pedro Igor <[email protected]>
  • Loading branch information
pedroigor committed May 7, 2024
1 parent 9d69239 commit d85ff7b
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/documentation/release_notes/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ include::topics/templates/document-attributes.adoc[]
:release_header_latest_link: {releasenotes_link_latest}
include::topics/templates/release-header.adoc[]

== {project_name_full} 24.0.4
include::topics/24_0_4.adoc[leveloffset=2]

== {project_name_full} 24.0.1
include::topics/24_0_1.adoc[leveloffset=2]

Expand Down
6 changes: 6 additions & 0 deletions docs/documentation/release_notes/topics/24_0_4.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
= Partial update to user attributes when updating users through the Admin User API is no longer supported

When updating user attributes through the Admin User API, you cannot execute partial updates when updating the
user attributes, including the root attributes like `username`, `email`, `firstName`, and `lastName`.

For more details, see the link:{upgradingguide_link}[{upgradingguide_name}].
10 changes: 10 additions & 0 deletions docs/documentation/upgrading/topics/changes/changes-24_0_4.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
= Partial update to user attributes when updating users through the Admin User API is no longer supported

When updating user attributes through the Admin User API, you cannot execute partial updates when updating the
user attributes, including the root attributes like `username`, `email`, `firstName`, and `lastName`.

If you are updating user attributes through the Admin User API without passing all the attributes that the administrator
has write permissions, the missing attributes will be removed. On the other hand, if an attribute is marked as read-only for
administrators, not sending the attribute won't remove it.

See the link:{adminguide_link}#user-profile[User Profile Documentation] for the details about the user profile settings.
4 changes: 4 additions & 0 deletions docs/documentation/upgrading/topics/changes/changes.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
[[migration-changes]]
== Migration Changes

=== Migrating to 24.0.4

include::changes-24_0_4.adoc[leveloffset=3]

=== Migrating to 24.0.3

include::changes-24_0_3.adoc[leveloffset=3]
Expand Down

0 comments on commit d85ff7b

Please sign in to comment.