mirror of
https://github.com/mattermost/mattermost.git
synced 2026-08-27 05:37:15 -05:00
Update api user endpoint docs to fix useAutomaticTimezone type and document more fields (#33901)
This commit is contained in:
@@ -2689,11 +2689,33 @@ components:
|
||||
type: string
|
||||
description: Set to "true" to enable mentions for first name. Defaults to "true"
|
||||
if a first name is set, "false" otherwise.
|
||||
auto_responder_message:
|
||||
type: string
|
||||
description: The message sent to users when they are auto-responded to.
|
||||
Defaults to "".
|
||||
push_threads:
|
||||
type: string
|
||||
description: Set to "all" to enable mobile push notifications for followed threads and "none" to disable.
|
||||
Defaults to "all".
|
||||
comments:
|
||||
type: string
|
||||
description: Set to "any" to enable notifications for comments to any post you have
|
||||
replied to, "root" for comments on your posts, and "never" to disable. Only
|
||||
affects users with collapsed reply threads disabled.
|
||||
Defaults to "never".
|
||||
desktop_threads:
|
||||
type: string
|
||||
description: Set to "all" to enable desktop notifications for followed threads and "none" to disable.
|
||||
Defaults to "all".
|
||||
email_threads:
|
||||
type: string
|
||||
description: Set to "all" to enable email notifications for followed threads and "none" to disable.
|
||||
Defaults to "all".
|
||||
Timezone:
|
||||
type: object
|
||||
properties:
|
||||
useAutomaticTimezone:
|
||||
type: boolean
|
||||
type: string
|
||||
description: Set to "true" to use the browser/system timezone, "false" to set
|
||||
manually. Defaults to "true".
|
||||
manualTimezone:
|
||||
|
||||
@@ -183,9 +183,10 @@
|
||||
Get a page of a list of users. Based on query string parameters, select
|
||||
users from a team, channel, or select users not in a specific channel.
|
||||
|
||||
|
||||
Since server version 4.0, some basic sorting is available using the `sort` query parameter. Sorting is currently only supported when selecting users on a team.
|
||||
|
||||
Some fields, like `email_verified` and `notify_props`, are only visible for the authorized user or if the authorized user has the `manage_system` permission.
|
||||
|
||||
##### Permissions
|
||||
|
||||
Requires an active session and (if specified) membership to the channel or team being selected from.
|
||||
|
||||
Reference in New Issue
Block a user