freechat/docs/content/structures/users.md
shockrah a69ad24a45 + Badge structure docs
Also this is a new pattern but I'm going to start actually using those anchor tags
to self link to other places in the page.

+ /badge/new endpoint docs
+ /badge/delete endpoint docs
+ /badge/update/name endpoint docs
+ /badge/update/color endpoint docs
+ /badge/update/perms endpoint docs

! Small point but apparantly this layout is somewhat printer friendly
:^) Just thought that was kinda neat.
2021-07-01 21:09:26 -07:00

717 B

title anchor weight
Users users 50

Personal User

If you need to get your own user data, with /users/me then the data received on success has the following fields:

Name Type
id u64
secret String
status i32
permissions u64
badge_ids Array<u32>

JWT

This data is retrieved after a successful /login hit.

Name Type
jwt String

Full Public User

Name Type
id u64
name String
status i32
permissions u64
badge_ids Array<u32>

For users without the USER_FETCH permission the only two fields with actual data is id and name. The other fields will be set to 0.