Files
discoursejs/docs/sdk/models/operations/user.md

86 lines
32 KiB
Markdown

# User
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `admin` | *boolean* | :heavy_check_mark: | N/A |
| `allowedPmUsernames` | *any*[] | :heavy_check_mark: | N/A |
| `avatarTemplate` | *string* | :heavy_check_mark: | N/A |
| `badgeCount` | *number* | :heavy_check_mark: | N/A |
| `canBeDeleted` | *boolean* | :heavy_check_mark: | N/A |
| `canChangeBio` | *boolean* | :heavy_check_mark: | N/A |
| `canChangeLocation` | *boolean* | :heavy_check_mark: | N/A |
| `canChangeTrackingPreferences` | *boolean* | :heavy_check_mark: | N/A |
| `canChangeWebsite` | *boolean* | :heavy_check_mark: | N/A |
| `canDeleteAllPosts` | *boolean* | :heavy_check_mark: | N/A |
| `canEdit` | *boolean* | :heavy_check_mark: | N/A |
| `canEditEmail` | *boolean* | :heavy_check_mark: | N/A |
| `canEditName` | *boolean* | :heavy_check_mark: | N/A |
| `canEditUsername` | *boolean* | :heavy_check_mark: | N/A |
| `canIgnoreUser` | *boolean* | :heavy_check_mark: | N/A |
| `canMuteUser` | *boolean* | :heavy_check_mark: | N/A |
| `canSendPrivateMessageToUser` | *boolean* | :heavy_check_mark: | N/A |
| `canSendPrivateMessages` | *boolean* | :heavy_check_mark: | N/A |
| `canUploadProfileHeader` | *boolean* | :heavy_check_mark: | N/A |
| `canUploadUserCardBackground` | *boolean* | :heavy_check_mark: | N/A |
| `createdAt` | *string* | :heavy_check_mark: | N/A |
| `customFields` | [operations.GetUserCustomFields](../../../sdk/models/operations/getusercustomfields.md) | :heavy_check_mark: | N/A |
| `displaySidebarTags` | *boolean* | :heavy_minus_sign: | N/A |
| `featuredTopic` | *string* | :heavy_check_mark: | N/A |
| `featuredUserBadgeIds` | *any*[] | :heavy_check_mark: | N/A |
| `flairBgColor` | *string* | :heavy_check_mark: | N/A |
| `flairColor` | *string* | :heavy_check_mark: | N/A |
| `flairGroupId` | *string* | :heavy_check_mark: | N/A |
| `flairName` | *string* | :heavy_check_mark: | N/A |
| `flairUrl` | *string* | :heavy_check_mark: | N/A |
| `groupUsers` | [operations.GroupUsers](../../../sdk/models/operations/groupusers.md)[] | :heavy_check_mark: | N/A |
| `groups` | [operations.GetUserGroups](../../../sdk/models/operations/getusergroups.md)[] | :heavy_check_mark: | N/A |
| `hasTitleBadges` | *boolean* | :heavy_check_mark: | N/A |
| `id` | *number* | :heavy_check_mark: | N/A |
| `ignored` | *boolean* | :heavy_check_mark: | N/A |
| `ignoredUsernames` | *any*[] | :heavy_check_mark: | N/A |
| `invitedBy` | *string* | :heavy_check_mark: | N/A |
| `lastPostedAt` | *string* | :heavy_check_mark: | N/A |
| `lastSeenAt` | *string* | :heavy_check_mark: | N/A |
| `locale` | *string* | :heavy_check_mark: | N/A |
| `mailingListPostsPerDay` | *number* | :heavy_check_mark: | N/A |
| `moderator` | *boolean* | :heavy_check_mark: | N/A |
| `muted` | *boolean* | :heavy_check_mark: | N/A |
| `mutedCategoryIds` | *any*[] | :heavy_check_mark: | N/A |
| `mutedTags` | *any*[] | :heavy_check_mark: | N/A |
| `mutedUsernames` | *any*[] | :heavy_check_mark: | N/A |
| `name` | *string* | :heavy_check_mark: | N/A |
| `pendingCount` | *number* | :heavy_check_mark: | N/A |
| `pendingPostsCount` | *number* | :heavy_minus_sign: | N/A |
| `postCount` | *number* | :heavy_check_mark: | N/A |
| `primaryGroupId` | *string* | :heavy_check_mark: | N/A |
| `primaryGroupName` | *string* | :heavy_check_mark: | N/A |
| `profileViewCount` | *number* | :heavy_check_mark: | N/A |
| `recentTimeRead` | *number* | :heavy_check_mark: | N/A |
| `regularCategoryIds` | *any*[] | :heavy_check_mark: | N/A |
| `secondFactorBackupEnabled` | *boolean* | :heavy_minus_sign: | N/A |
| `secondFactorEnabled` | *boolean* | :heavy_check_mark: | N/A |
| `sidebarCategoryIds` | *any*[] | :heavy_minus_sign: | N/A |
| `sidebarTags` | *any*[] | :heavy_minus_sign: | N/A |
| `staged` | *boolean* | :heavy_check_mark: | N/A |
| `systemAvatarTemplate` | *string* | :heavy_check_mark: | N/A |
| `systemAvatarUploadId` | *string* | :heavy_check_mark: | N/A |
| `timeRead` | *number* | :heavy_check_mark: | N/A |
| `title` | *string* | :heavy_check_mark: | N/A |
| `trackedCategoryIds` | *any*[] | :heavy_check_mark: | N/A |
| `trackedTags` | *any*[] | :heavy_check_mark: | N/A |
| `trustLevel` | *number* | :heavy_check_mark: | N/A |
| `uploadedAvatarId` | *string* | :heavy_check_mark: | N/A |
| `useLogoSmallAsAvatar` | *boolean* | :heavy_check_mark: | N/A |
| `userApiKeys` | *string* | :heavy_check_mark: | N/A |
| `userAuthTokens` | [operations.UserAuthTokens](../../../sdk/models/operations/userauthtokens.md)[] | :heavy_check_mark: | N/A |
| `userFields` | [operations.UserFields](../../../sdk/models/operations/userfields.md) | :heavy_minus_sign: | N/A |
| `userNotificationSchedule` | [operations.UserNotificationSchedule](../../../sdk/models/operations/usernotificationschedule.md) | :heavy_check_mark: | N/A |
| `userOption` | [operations.UserOption](../../../sdk/models/operations/useroption.md) | :heavy_check_mark: | N/A |
| `username` | *string* | :heavy_check_mark: | N/A |
| `watchedCategoryIds` | *any*[] | :heavy_check_mark: | N/A |
| `watchedFirstPostCategoryIds` | *any*[] | :heavy_check_mark: | N/A |
| `watchedTags` | *any*[] | :heavy_check_mark: | N/A |
| `watchingFirstPostTags` | *any*[] | :heavy_check_mark: | N/A |