users
Documentation for discourse JSON objects
License: MIT
- users
- .UserBadge :
object
- .Badge :
object
- .BadgeType :
object
- .UserBadge :
users.UserBadge : object
User Badge Data
Kind: static typedef of users
Param | Type | Description |
---|---|---|
id | number |
Badge instance Id |
granted_at | string |
ISO formate badge grant datetime |
badge_id | number |
Badge type Id |
user_id | number |
User Id badge was granted to |
granted_by_id | number |
User Id that granted the badge |
users.Badge : object
Badge Data
Kind: static typedef of users
Param | Type | Description |
---|---|---|
id | number |
Badge Id |
name | string |
Badge Name |
description | string |
Badge Description |
grant_count | number |
Number of times this badge has been awarded to all users |
allow_title | boolean |
Can badge be used as user title? |
multiple_grant | boolean |
Can badge be granted multiple times to one user? |
icon | string |
Badge Icon (FontAwesome character name?) |
image | string |
Badge Image (FontAwesome character name?) |
listable | boolean |
Unknown |
enabled | boolean |
Is badge enabled? |
badge_grouping_id | number |
Group the badge belongs to |
system | boolean |
Is this a builtin badge? |
badge_type_id | number |
Defines the type of the badge |
users.BadgeType : object
Badge Types
Kind: static typedef of users
Param | Type | Description |
---|---|---|
id | number |
Badge Type Id |
name | string |
Badge Type Name |
sort_order | number |
Badge Type Sort Order |