This repository has been archived by the owner on Mar 17, 2021. It is now read-only.
Refactor User Type, Add Additional User Endpoints #61
Conversation
This file contains 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
API endpoints that return a collection of users do not structure user objects the same as those that return a single user. Collections of users intentionally have reduced fields. They are different structs in the Grafana codebase: UserProfileDTO & UserSearchHitDTO. They should be treated as differnt structs here as well.
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.
These changes are part of an effort to implement users in the Terraform Grafana provider - https://github.com/terraform-providers/terraform-provider-grafana/issues/51.
Refactor User Type
Additional fields were added to
Userto capture all available information from the API.The
UserSearchtype was added. This is structured after user objects returned from the search users API.UserandUserSearchare modeled afterUserProfileDTOandUserSearchHitDTOin the Grafana codebase. Attempting to reuse a single type is going to lead to problems and workarounds like what's being removed from theUserByEmailfunction (where a temporary/alternate struct is created and then cast to aUser).Added Enpoints
Userimplements the user by ID API.UserUpdateimplements the user update API.UpdateUserPasswordimplements the password for user admin API for updating user passwords. This field cannot be updated withUserUpdate.UpdateUserPermissionsimplements the user permissions admin API for updating a user's IsAdmin property. This field also cannot be updated withUserUpdate.