Omitted fields will not be updated.
This can have a temporary negative effect on performance while the caches are re-populated.The number of logs per page. When left blank, sorting is done by username. Direct and group message channels cannot be deleted.Invalid or missing parameters in URL or request bodyPartially update a channel by providing only the fields you want to update. Use query parameters for paging.Invalid or missing parameters in URL or request bodyRevoke a user access token and delete any sessions using the token.Invalid or missing parameters in URL or request bodyGet a user access token. The fields that can be updated are listed as parameters. '{"login_id":"someone@nowhere.com","password":"thisisabadpassword"}'"{\"login_id\":\"someone@nowhere.com\",\"password\":\"thisisabadpassword\"}"// Deleting user's profile image consists on resetting it to default one/teams/name/{team_name}/channels/name/{channel_name}/channels/{channel_id}/members/{user_id}/schemeRoles/channels/{channel_id}/members/{user_id}/notify_props'http://your-mattermost-url.com/api/v4/channels/3wyp678obid8pggjmhmhwpah1r/members_minus_group_members?group_ids=eoezijg8zffgjmch8icy5bjd1e,ugaw6wjc3tfxpcr1eq5u5k8dhe&page=0&per_page=100''http://your-mattermost-url.com/api/v4/channels/3wyp678obid8pggjmhmhwpah1r/member_counts_by_group?include_timezones=true'/users/{user_id}/teams/{team_id}/channels/categories/users/{user_id}/teams/{team_id}/channels/categories/users/{user_id}/teams/{team_id}/channels/categories/users/{user_id}/teams/{team_id}/channels/categories/order/users/{user_id}/teams/{team_id}/channels/categories/order/users/{user_id}/teams/{team_id}/channels/categories/{category_id}/users/{user_id}/teams/{team_id}/channels/categories/{category_id}/users/{user_id}/teams/{team_id}/channels/categories/{category_id}/users/{user_id}/channels/{channel_id}/posts/unread/users/{user_id}/preferences/{category}/name/{preference_name}/users/{user_id}/posts/{post_id}/reactions/{emoji_name}// The second parameter is to set if you want only custom commands (true) or defaults commands (false) that haven't been set through environment variables will be missing from the object.Invalid or missing parameters in URL or request bodySubmit configuration to patch. The fields that can be updated are defined in the request body, all other provided fields will be ignored.Invalid or missing parameters in URL or request bodySoft deletes a team, by marking the team as deleted in the database.
If no valid configuration is present in the request body the current server configuration will be tested.Sends a Ping request to the mattermost server using the specified Site URL.Invalid or missing parameters in URL or request bodySend a test to validate if can connect to AWS S3. Omitted fields will not be updated. Deletes all Bleve indexes and their contents.
the channel.Configured 'default' channels (ex Town Square and Off-Topic) can be excluded from the results The provided Scheme ID should be for a Team-scoped Scheme. (not yet implemented)Invalid or missing parameters in URL or request bodyEndpoints for creating, getting and updating roles.Requires an active session but no other permissions.Requires an active session but no other permissions.Partially update a role by providing only the fields you want to update. Import users, channels, posts, hooks.String that defines from which application the team was exported to be imported into Mattermost.JSON object containing a base64 encoded text file of the import logs in its Invalid or missing parameters in URL or request bodyInvalid or missing parameters in URL or request bodySet a team's scheme, more specifically sets the scheme_id value of a team record.Invalid or missing parameters in URL or request bodyGet the set of users who are members of the team minus the set of users who are members of the given groups. The server will pick a hard-coded filename for the PublicCertificateFile setting in your Invalid or missing parameters in URL or request bodyDelete the current public certificate being used with your SAML configuration. This will also disable encryption for SAML on your system as this certificate is required for that.Upload the private key to be used for encryption with your SAML configuration.
Does not include the actual authentication tokens. See the Restful API docs here. The link will contain a one-use, timed recovery code tied to the user's account. Valid user roles are "system_user", "system_admin" or both of them. The provided Scheme ID should be for a Channel-scoped Scheme. Users can sign-in to Mattermost with their SAML credentials. The application's client secret will be blanked out.Invalid or missing parameters in URL or request bodyGet a page of OAuth 2.0 client applications authorized to access a user's account.Invalid or missing parameters in URL or request bodyEndpoints for configuring and interacting with SAML.Get SAML metadata from the server.
Use the query parameters to modify the behaviour of this endpoint.Invalid or missing parameters in URL or request bodyEndpoints for interactive actions for use by integrations.Open an interactive dialog using a trigger ID provided by a slash command, or some other action payload. Set this key and add YouTube Data API v3 as a service to your key to enable the display of titles for embedded YouTube video previews. The fields that can be updated are defined in the request body, all other provided fields will be ignored.Invalid or missing parameters in URL or request bodyPartially update a GroupSyncable by providing only the fields you want to update. (Note that the non-paginated responseâreturned if the request body does not contain both Invalid or missing parameters in URL or request bodyGet a list of group channels for a user which members' usernames match the search term.The search term to match against the members' usernames of the group channelsInvalid or missing parameters in URL or request bodyInvalid or missing parameters in URL or request bodyGet a list of timezones for the users who are in this channel.Invalid or missing parameters in URL or request bodyUpdate a channel.
This can have a temporary negative effect on performance while the caches are re-populated.The number of logs per page. When left blank, sorting is done by username. Direct and group message channels cannot be deleted.Invalid or missing parameters in URL or request bodyPartially update a channel by providing only the fields you want to update. Use query parameters for paging.Invalid or missing parameters in URL or request bodyRevoke a user access token and delete any sessions using the token.Invalid or missing parameters in URL or request bodyGet a user access token. The fields that can be updated are listed as parameters. '{"login_id":"someone@nowhere.com","password":"thisisabadpassword"}'"{\"login_id\":\"someone@nowhere.com\",\"password\":\"thisisabadpassword\"}"// Deleting user's profile image consists on resetting it to default one/teams/name/{team_name}/channels/name/{channel_name}/channels/{channel_id}/members/{user_id}/schemeRoles/channels/{channel_id}/members/{user_id}/notify_props'http://your-mattermost-url.com/api/v4/channels/3wyp678obid8pggjmhmhwpah1r/members_minus_group_members?group_ids=eoezijg8zffgjmch8icy5bjd1e,ugaw6wjc3tfxpcr1eq5u5k8dhe&page=0&per_page=100''http://your-mattermost-url.com/api/v4/channels/3wyp678obid8pggjmhmhwpah1r/member_counts_by_group?include_timezones=true'/users/{user_id}/teams/{team_id}/channels/categories/users/{user_id}/teams/{team_id}/channels/categories/users/{user_id}/teams/{team_id}/channels/categories/users/{user_id}/teams/{team_id}/channels/categories/order/users/{user_id}/teams/{team_id}/channels/categories/order/users/{user_id}/teams/{team_id}/channels/categories/{category_id}/users/{user_id}/teams/{team_id}/channels/categories/{category_id}/users/{user_id}/teams/{team_id}/channels/categories/{category_id}/users/{user_id}/channels/{channel_id}/posts/unread/users/{user_id}/preferences/{category}/name/{preference_name}/users/{user_id}/posts/{post_id}/reactions/{emoji_name}// The second parameter is to set if you want only custom commands (true) or defaults commands (false) that haven't been set through environment variables will be missing from the object.Invalid or missing parameters in URL or request bodySubmit configuration to patch. The fields that can be updated are defined in the request body, all other provided fields will be ignored.Invalid or missing parameters in URL or request bodySoft deletes a team, by marking the team as deleted in the database.
If no valid configuration is present in the request body the current server configuration will be tested.Sends a Ping request to the mattermost server using the specified Site URL.Invalid or missing parameters in URL or request bodySend a test to validate if can connect to AWS S3. Omitted fields will not be updated. Deletes all Bleve indexes and their contents.
the channel.Configured 'default' channels (ex Town Square and Off-Topic) can be excluded from the results The provided Scheme ID should be for a Team-scoped Scheme. (not yet implemented)Invalid or missing parameters in URL or request bodyEndpoints for creating, getting and updating roles.Requires an active session but no other permissions.Requires an active session but no other permissions.Partially update a role by providing only the fields you want to update. Import users, channels, posts, hooks.String that defines from which application the team was exported to be imported into Mattermost.JSON object containing a base64 encoded text file of the import logs in its Invalid or missing parameters in URL or request bodyInvalid or missing parameters in URL or request bodySet a team's scheme, more specifically sets the scheme_id value of a team record.Invalid or missing parameters in URL or request bodyGet the set of users who are members of the team minus the set of users who are members of the given groups. The server will pick a hard-coded filename for the PublicCertificateFile setting in your Invalid or missing parameters in URL or request bodyDelete the current public certificate being used with your SAML configuration. This will also disable encryption for SAML on your system as this certificate is required for that.Upload the private key to be used for encryption with your SAML configuration.
Does not include the actual authentication tokens. See the Restful API docs here. The link will contain a one-use, timed recovery code tied to the user's account. Valid user roles are "system_user", "system_admin" or both of them. The provided Scheme ID should be for a Channel-scoped Scheme. Users can sign-in to Mattermost with their SAML credentials. The application's client secret will be blanked out.Invalid or missing parameters in URL or request bodyGet a page of OAuth 2.0 client applications authorized to access a user's account.Invalid or missing parameters in URL or request bodyEndpoints for configuring and interacting with SAML.Get SAML metadata from the server.
Use the query parameters to modify the behaviour of this endpoint.Invalid or missing parameters in URL or request bodyEndpoints for interactive actions for use by integrations.Open an interactive dialog using a trigger ID provided by a slash command, or some other action payload. Set this key and add YouTube Data API v3 as a service to your key to enable the display of titles for embedded YouTube video previews. The fields that can be updated are defined in the request body, all other provided fields will be ignored.Invalid or missing parameters in URL or request bodyPartially update a GroupSyncable by providing only the fields you want to update. (Note that the non-paginated responseâreturned if the request body does not contain both Invalid or missing parameters in URL or request bodyGet a list of group channels for a user which members' usernames match the search term.The search term to match against the members' usernames of the group channelsInvalid or missing parameters in URL or request bodyInvalid or missing parameters in URL or request bodyGet a list of timezones for the users who are in this channel.Invalid or missing parameters in URL or request bodyUpdate a channel.