docs: retrieve user by ID

[datapumpernickel]

Description

Retrieving a user by ID works only when passing in an ID of class UUID. This has been updated in the docs, as well as in the function examples and one error message of the users.py functions.

Closes #5011

• Documentation update

How Has This Been Tested

Not tested yet.

Checklist

• I added relevant documentation
• I followed the style guidelines of this project
• I did a self-review of my code
• I made corresponding changes to the documentation
• My changes generate no new warnings
• I filled out the contributor form (see text above)
• I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

[sdiazlor]

Thanks @datapumpernickel, could you change the branch to main?

[davidberenstein1957]

@datapumpernickel, would you be able to change the code so we can obtain users either by str or UUID?

[datapumpernickel]

Woopsie, I was trying to change this to the main branch and did not see your reply @davidberenstein1957 in the meantime. Sorry about the mess.
I could look at it, probably not this week, as I will be off until Mid-July. But then I can give it a try!

[davidberenstein1957]

Hi @datapumpernickel, no problem. Your contribution is great. I think it might be nicer for users to be able to pass either an id or UUID. @frascuchon @burtenshaw WDYT? Either way, Enjoy the holidays :)

[datapumpernickel]

Definitely more convenient to be able to pass both -thanks for the hint. It actually seemed pretty straight forward, to I just put in a commit with a small change that checks if the ID is of instance uuid.UUID, if not, it tries to convert it to an instance of uuid.UUID. It returns an error if that fails for some reason.