There is also a work-in-progress Postman API reference.
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
org.openapitools.codegen.languages.RustClientCodegenPut the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:
openapi = { path = "./openapi" }
All URIs are relative to http://your-mattermost-url.com/api/v4
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AuthenticationApi | migrateauthtoldap | POST /users/migrateauth/ldap | Migrate user accounts authentication type to LDAP. AuthenticationApi | migrateauthtosaml | POST /users/migrateauth/saml | Migrate user accounts authentication type to SAML. BleveApi | purgebleveindexes | POST /bleve/purgeindexes | Purge all Bleve indexes *BotsApi* | assignbot | POST /bots/{botuserid}/assign/{userid} | Assign a bot to a user *BotsApi* | convertbottouser | POST /bots/{botuserid}/converttouser | Convert a bot into a user BotsApi | convertusertobot | POST /users/{userid}/converttobot | Convert a user into a bot BotsApi | createbot | POST /bots | Create a bot *BotsApi* | deleteboticonimage | DELETE /bots/{botuserid}/icon | Delete bot's LHS icon image BotsApi | disablebot | POST /bots/{botuserid}/disable | Disable a bot *BotsApi* | enablebot | POST /bots/{botuserid}/enable | Enable a bot BotsApi | getbot | GET /bots/{botuserid} | Get a bot *BotsApi* | getboticonimage | GET /bots/{botuserid}/icon | Get bot's LHS icon BotsApi | getbots | GET /bots | Get bots *BotsApi* | patchbot | PUT /bots/{botuserid} | Patch a bot BotsApi | setboticonimage | POST /bots/{botuserid}/icon | Set bot's LHS icon image *BrandApi* | deletebrandimage | DELETE /brand/image | Delete current brand image *BrandApi* | getbrandimage | GET /brand/image | Get brand image *BrandApi* | uploadbrandimage | POST /brand/image | Upload brand image *ChannelsApi* | addchannelmember | POST /channels/{channelid}/members | Add user to channel ChannelsApi | autocompletechannelsforteam | GET /teams/{teamid}/channels/autocomplete | Autocomplete channels ChannelsApi | autocompletechannelsforteamforsearch | GET /teams/{teamid}/channels/searchautocomplete | Autocomplete channels for search *ChannelsApi* | channelmembersminusgroupmembers | GET /channels/{channelid}/membersminusgroupmembers | Channel members minus group members. *ChannelsApi* | createchannel | POST /channels | Create a channel ChannelsApi | createdirectchannel | POST /channels/direct | Create a direct message channel ChannelsApi | creategroupchannel | POST /channels/group | Create a group message channel ChannelsApi | createsidebarcategoryforteamforuser | POST /users/{userid}/teams/{teamid}/channels/categories | Create user's sidebar category ChannelsApi | deletechannel | DELETE /channels/{channelid} | Delete a channel ChannelsApi | getallchannels | GET /channels | Get a list of all channels ChannelsApi | getchannel | GET /channels/{channelid} | Get a channel ChannelsApi | getchannelbyname | GET /teams/{teamid}/channels/name/{channelname} | Get a channel by name *ChannelsApi* | getchannelbynameforteamname | GET /teams/name/{teamname}/channels/name/{channelname} | Get a channel by name and team name *ChannelsApi* | getchannelmember | GET /channels/{channelid}/members/{userid} | Get channel member *ChannelsApi* | getchannelmembercountsbygroup | GET /channels/{channelid}/membercountsbygroup | Channel members counts for each group that has atleast one member in the channel ChannelsApi | getchannelmembers | GET /channels/{channelid}/members | Get channel members *ChannelsApi* | getchannelmembersbyids | POST /channels/{channelid}/members/ids | Get channel members by ids ChannelsApi | getchannelmembersforuser | GET /users/{userid}/teams/{teamid}/channels/members | Get channel memberships and roles for a user ChannelsApi | getchannelmemberstimezones | GET /channels/{channelid}/timezones | Get timezones in a channel ChannelsApi | getchannelmoderations | GET /channels/{channelid}/moderations | Get information about channel's moderation. *ChannelsApi* | getchannelstats | GET /channels/{channelid}/stats | Get channel statistics ChannelsApi | getchannelunread | GET /users/{userid}/channels/{channelid}/unread | Get unread messages ChannelsApi | getchannelsforteamforuser | GET /users/{userid}/teams/{teamid}/channels | Get channels for user *ChannelsApi* | getchannelsforuser | GET /users/{userid}/channels | Get all channels from all teams *ChannelsApi* | getdeletedchannelsforteam | GET /teams/{teamid}/channels/deleted | Get deleted channels ChannelsApi | getpinnedposts | GET /channels/{channelid}/pinned | Get a channel's pinned posts *ChannelsApi* | getprivatechannelsforteam | GET /teams/{teamid}/channels/private | Get private channels ChannelsApi | getpublicchannelsbyidsforteam | POST /teams/{teamid}/channels/ids | Get a list of channels by ids *ChannelsApi* | getpublicchannelsforteam | GET /teams/{teamid}/channels | Get public channels ChannelsApi | getsidebarcategoriesforteamforuser | GET /users/{userid}/teams/{teamid}/channels/categories | Get user's sidebar categories ChannelsApi | getsidebarcategoryforteamforuser | GET /users/{userid}/teams/{teamid}/channels/categories/{categoryid} | Get sidebar category *ChannelsApi* | getsidebarcategoryorderforteamforuser | GET /users/{userid}/teams/{teamid}/channels/categories/order | Get user's sidebar category order ChannelsApi | movechannel | POST /channels/{channelid}/move | Move a channel ChannelsApi | patchchannel | PUT /channels/{channelid}/patch | Patch a channel ChannelsApi | patchchannelmoderations | PUT /channels/{channelid}/moderations/patch | Update a channel's moderation settings. *ChannelsApi* | removesidebarcategoryforteamforuser | DELETE /users/{userid}/teams/{teamid}/channels/categories/{categoryid} | Delete sidebar category ChannelsApi | removeuserfromchannel | DELETE /channels/{channelid}/members/{userid} | Remove user from channel *ChannelsApi* | restorechannel | POST /channels/{channelid}/restore | Restore a channel *ChannelsApi* | searchallchannels | POST /channels/search | Search all private and open type channels across all teams *ChannelsApi* | searcharchivedchannels | POST /teams/{teamid}/channels/searcharchived | Search archived channels *ChannelsApi* | searchchannels | POST /teams/{teamid}/channels/search | Search channels *ChannelsApi* | searchgroupchannels | POST /channels/group/search | Search Group Channels *ChannelsApi* | updatechannel | PUT /channels/{channelid} | Update a channel *ChannelsApi* | updatechannelmemberschemeroles | PUT /channels/{channelid}/members/{userid}/schemeRoles | Update the scheme-derived roles of a channel member. *ChannelsApi* | updatechannelnotifyprops | PUT /channels/{channelid}/members/{userid}/notifyprops | Update channel notifications *ChannelsApi* | updatechannelprivacy | PUT /channels/{channelid}/privacy | Update channel's privacy ChannelsApi | updatechannelroles | PUT /channels/{channelid}/members/{userid}/roles | Update channel roles ChannelsApi | updatechannelscheme | PUT /channels/{channelid}/scheme | Set a channel's scheme *ChannelsApi* | updatesidebarcategoriesforteamforuser | PUT /users/{userid}/teams/{teamid}/channels/categories | Update user's sidebar categories *ChannelsApi* | updatesidebarcategoryforteamforuser | PUT /users/{userid}/teams/{teamid}/channels/categories/{categoryid} | Update sidebar category ChannelsApi | updatesidebarcategoryorderforteamforuser | PUT /users/{userid}/teams/{teamid}/channels/categories/order | Update user's sidebar category order *ChannelsApi* | viewchannel | POST /channels/members/{userid}/view | View channel *CloudApi* | confirmcustomerpayment | POST /cloud/payment/confirm | Completes the payment setup intent *CloudApi* | createcustomerpayment | POST /cloud/payment | Create a customer setup payment intent *CloudApi* | getcloudcustomer | GET /cloud/customer | Get cloud customer *CloudApi* | getcloudproducts | GET /cloud/products | Get cloud products *CloudApi* | getinvoiceforsubscriptionaspdf | GET /cloud/subscription/invoices/{invoiceid}/pdf | Get cloud invoice PDF *CloudApi* | getinvoicesforsubscription | GET /cloud/subscription/invoices | Get cloud subscription invoices CloudApi | getsubscription | GET /cloud/subscription | Get cloud subscription *CloudApi* | getsubscriptionstats | GET /cloud/subscription/stats | GET endpoint for cloud subscription stats *CloudApi* | postendpointforcwswebhooks | POST /cloud/webhook | POST endpoint for CWS Webhooks *CloudApi* | sendadminupgraderequestemail | POST /cloud/subscription/limitreached/invite | POST endpoint for triggering sending emails to admin with request to upgrade workspace *CloudApi* | sendadminupgraderequestemailonjoin | POST /cloud/subscription/limitreached/join | POST endpoint for triggering sending emails to admin with request to upgrade workspace *CloudApi* | updatecloudcustomer | PUT /cloud/customer | Update cloud customer *CloudApi* | updatecloudcustomeraddress | PUT /cloud/customer/address | Update cloud customer address ClusterApi | getclusterstatus | GET /cluster/status | Get cluster status CommandsApi | createcommand | POST /commands | Create a command *CommandsApi* | deletecommand | DELETE /commands/{commandid} | Delete a command *CommandsApi* | executecommand | POST /commands/execute | Execute a command CommandsApi | getcommandbyid | GET /commands/{commandid} | Get a command CommandsApi | listautocompletecommands | GET /teams/{teamid}/commands/autocomplete | List autocomplete commands *CommandsApi* | listcommandautocompletesuggestions | GET /teams/{teamid}/commands/autocompletesuggestions | List commands' autocomplete data CommandsApi | listcommands | GET /commands | List commands for a team *CommandsApi* | movecommand | PUT /commands/{commandid}/move | Move a command *CommandsApi* | regencommandtoken | PUT /commands/{commandid}/regentoken | Generate a new token *CommandsApi* | updatecommand | PUT /commands/{commandid} | Update a command *ComplianceApi* | createcompliancereport | POST /compliance/reports | Create report *ComplianceApi* | downloadcompliancereport | GET /compliance/reports/{reportid}/download | Download a report ComplianceApi | getcompliancereport | GET /compliance/reports/{reportid} | Get a report *ComplianceApi* | getcompliancereports | GET /compliance/reports | Get reports *DataRetentionApi* | addchannelstoretentionpolicy | POST /dataretention/policies/{policyid}/channels | Add channels to a granular data retention policy *DataRetentionApi* | addteamstoretentionpolicy | POST /dataretention/policies/{policyid}/teams | Add teams to a granular data retention policy *DataRetentionApi* | createdataretentionpolicy | POST /dataretention/policies | Create a new granular data retention policy *DataRetentionApi* | deletedataretentionpolicy | DELETE /dataretention/policies/{policyid} | Delete a granular data retention policy DataRetentionApi | getchannelpoliciesforuser | GET /users/{userid}/dataretention/channelpolicies | Get the policies which are applied to a user's channels *DataRetentionApi* | getchannelsforretentionpolicy | GET /dataretention/policies/{policyid}/channels | Get the channels for a granular data retention policy *DataRetentionApi* | getdataretentionpolicies | GET /dataretention/policies | Get the granular data retention policies *DataRetentionApi* | getdataretentionpoliciescount | GET /dataretention/policiescount | Get the number of granular data retention policies *DataRetentionApi* | getdataretentionpolicy | GET /dataretention/policy | Get the global data retention policy *DataRetentionApi* | getdataretentionpolicybyid | GET /dataretention/policies/{policyid} | Get a granular data retention policy DataRetentionApi | getteampoliciesforuser | GET /users/{userid}/dataretention/teampolicies | Get the policies which are applied to a user's teams *DataRetentionApi* | getteamsforretentionpolicy | GET /dataretention/policies/{policyid}/teams | Get the teams for a granular data retention policy *DataRetentionApi* | patchdataretentionpolicy | PATCH /dataretention/policies/{policyid} | Patch a granular data retention policy DataRetentionApi | removechannelsfromretentionpolicy | DELETE /dataretention/policies/{policyid}/channels | Delete channels from a granular data retention policy DataRetentionApi | removeteamsfromretentionpolicy | DELETE /dataretention/policies/{policyid}/teams | Delete teams from a granular data retention policy DataRetentionApi | searchchannelsforretentionpolicy | POST /dataretention/policies/{policyid}/channels/search | Search for the channels in a granular data retention policy DataRetentionApi | searchteamsforretentionpolicy | POST /dataretention/policies/{policyid}/teams/search | Search for the teams in a granular data retention policy ElasticsearchApi | purgeelasticsearchindexes | POST /elasticsearch/purgeindexes | Purge all Elasticsearch indexes *ElasticsearchApi* | testelasticsearch | POST /elasticsearch/test | Test Elasticsearch configuration EmojiApi | autocompleteemoji | GET /emoji/autocomplete | Autocomplete custom emoji *EmojiApi* | createemoji | POST /emoji | Create a custom emoji EmojiApi | deleteemoji | DELETE /emoji/{emojiid} | Delete a custom emoji EmojiApi | getemoji | GET /emoji/{emojiid} | Get a custom emoji EmojiApi | getemojibyname | GET /emoji/name/{emojiname} | Get a custom emoji by name EmojiApi | getemojiimage | GET /emoji/{emojiid}/image | Get custom emoji image *EmojiApi* | getemojilist | GET /emoji | Get a list of custom emoji *EmojiApi* | searchemoji | POST /emoji/search | Search custom emoji ExportsApi | deleteexport | DELETE /exports/{exportname} | Delete an export file ExportsApi | downloadexport | GET /exports/{exportname} | Download an export file ExportsApi | listexports | GET /exports | List export files *FilesApi* | getfile | GET /files/{fileid} | Get a file *FilesApi* | getfileinfo | GET /files/{fileid}/info | Get metadata for a file FilesApi | getfilelink | GET /files/{fileid}/link | Get a public file link *FilesApi* | getfilepreview | GET /files/{fileid}/preview | Get a file's preview FilesApi | getfilepublic | GET /files/{fileid}/public | Get a public file *FilesApi* | getfilethumbnail | GET /files/{fileid}/thumbnail | Get a file's thumbnail FilesApi | searchfiles | POST /teams/{teamid}/files/search | Search files in a team FilesApi | uploadfile | POST /files | Upload a file *GroupsApi* | addgroupmembers | POST /groups/{groupid}/members | Adds members to a custom group GroupsApi | creategroup | POST /groups | Create a custom group *GroupsApi* | deletegroup | DELETE /groups/{groupid} | Deletes a custom group *GroupsApi* | deletegroupmembers | DELETE /groups/{groupid}/members | Removes members from a custom group GroupsApi | getgroup | GET /groups/{groupid} | Get a group GroupsApi | getgroupstats | GET /groups/{groupid}/stats | Get group stats *GroupsApi* | getgroupsyncableforchannelid | GET /groups/{groupid}/channels/{channelid} | Get GroupSyncable from channel ID GroupsApi | getgroupsyncableforteamid | GET /groups/{groupid}/teams/{teamid} | Get GroupSyncable from Team ID *GroupsApi* | getgroupsyncableschannels | GET /groups/{groupid}/channels | Get group channels *GroupsApi* | getgroupsyncablesteams | GET /groups/{groupid}/teams | Get group teams *GroupsApi* | getgroupusers | GET /groups/{groupid}/members | Get group users GroupsApi | getgroups | GET /groups | Get groups *GroupsApi* | getgroupsassociatedtochannelsbyteam | GET /teams/{teamid}/groupsbychannels | Get team groups by channels GroupsApi | getgroupsbychannel | GET /channels/{channelid}/groups | Get channel groups GroupsApi | getgroupsbyteam | GET /teams/{teamid}/groups | Get team groups GroupsApi | getgroupsbyuserid | GET /users/{userid}/groups | Get groups for a userId *GroupsApi* | linkgroupsyncableforchannel | POST /groups/{groupid}/channels/{channelid}/link | Link a channel to a group *GroupsApi* | linkgroupsyncableforteam | POST /groups/{groupid}/teams/{teamid}/link | Link a team to a group *GroupsApi* | patchgroup | PUT /groups/{groupid}/patch | Patch a group *GroupsApi* | patchgroupsyncableforchannel | PUT /groups/{groupid}/channels/{channelid}/patch | Patch a GroupSyncable associated to Channel *GroupsApi* | patchgroupsyncableforteam | PUT /groups/{groupid}/teams/{teamid}/patch | Patch a GroupSyncable associated to Team *GroupsApi* | unlinkgroupsyncableforchannel | DELETE /groups/{groupid}/channels/{channelid}/link | Delete a link from a channel to a group *GroupsApi* | unlinkgroupsyncableforteam | DELETE /groups/{groupid}/teams/{teamid}/link | Delete a link from a team to a group *GroupsApi* | unlinkldapgroup | DELETE /ldap/groups/{remoteid}/link | Delete a link for LDAP group ImportsApi | listimports | GET /imports | List import files *IntegrationActionsApi* | openinteractivedialog | POST /actions/dialogs/open | Open a dialog *IntegrationActionsApi* | submitinteractivedialog | POST /actions/dialogs/submit | Submit a dialog *JobsApi* | canceljob | POST /jobs/{jobid}/cancel | Cancel a job. *JobsApi* | createjob | POST /jobs | Create a new job. JobsApi | downloadjob | GET /jobs/{jobid}/download | Download the results of a job. JobsApi | getjob | GET /jobs/{jobid} | Get a job. JobsApi | getjobs | GET /jobs | Get the jobs. *JobsApi* | getjobsbytype | GET /jobs/type/{type} | Get the jobs of the given type. LDAPApi | deleteldapprivatecertificate | DELETE /ldap/certificate/private | Remove private key *LDAPApi* | deleteldappubliccertificate | DELETE /ldap/certificate/public | Remove public certificate LDAPApi | migrateauthtoldap | POST /users/migrateauth/ldap | Migrate user accounts authentication type to LDAP. LDAPApi | migrateidldap | POST /ldap/migrateid | Migrate Id LDAP LDAPApi | syncldap | POST /ldap/sync | Sync with LDAP *LDAPApi* | testldap | POST /ldap/test | Test LDAP configuration LDAPApi | uploadldapprivatecertificate | POST /ldap/certificate/private | Upload private key *LDAPApi* | uploadldappubliccertificate | POST /ldap/certificate/public | Upload public certificate LdapApi | getldapgroups | GET /ldap/groups | Returns a list of LDAP groups LdapApi | linkldapgroup | POST /ldap/groups/{remoteid}/link | Link a LDAP group *MigrateApi* | migrateauthtoldap | POST /users/migrateauth/ldap | Migrate user accounts authentication type to LDAP. *MigrateApi* | migrateauthtosaml | POST /users/migrateauth/saml | Migrate user accounts authentication type to SAML. *OAuthApi* | createoauthapp | POST /oauth/apps | Register OAuth app OAuthApi | deleteoauthapp | DELETE /oauth/apps/{appid} | Delete an OAuth app OAuthApi | getauthorizedoauthappsforuser | GET /users/{userid}/oauth/apps/authorized | Get authorized OAuth apps *OAuthApi* | getoauthapp | GET /oauth/apps/{appid} | Get an OAuth app *OAuthApi* | getoauthappinfo | GET /oauth/apps/{appid}/info | Get info on an OAuth app OAuthApi | getoauthapps | GET /oauth/apps | Get OAuth apps *OAuthApi* | regenerateoauthappsecret | POST /oauth/apps/{appid}/regensecret | Regenerate OAuth app secret *OAuthApi* | updateoauthapp | PUT /oauth/apps/{appid} | Update an OAuth app *OpenGraphApi* | opengraph | POST /opengraph | Get open graph metadata for url PermissionsApi | getancillarypermissions | GET /permissions/ancillary | Return all system console subsection ancillary permissions PluginsApi | disableplugin | POST /plugins/{pluginid}/disable | Disable plugin PluginsApi | enableplugin | POST /plugins/{pluginid}/enable | Enable plugin PluginsApi | getmarketplaceplugins | GET /plugins/marketplace | Gets all the marketplace plugins PluginsApi | getmarketplacevisitedbyadmin | GET /plugins/marketplace/firstadminvisit | Get if the Plugin Marketplace has been visited by at least an admin. PluginsApi | getpluginstatuses | GET /plugins/statuses | Get plugins status PluginsApi | getplugins | GET /plugins | Get plugins *PluginsApi* | getwebappplugins | GET /plugins/webapp | Get webapp plugins *PluginsApi* | installmarketplaceplugin | POST /plugins/marketplace | Installs a marketplace plugin *PluginsApi* | installpluginfromurl | POST /plugins/installfromurl | Install plugin from url PluginsApi | removeplugin | DELETE /plugins/{pluginid} | Remove plugin PluginsApi | uploadplugin | POST /plugins | Upload plugin *PostsApi* | createpost | POST /posts | Create a post PostsApi | createpostephemeral | POST /posts/ephemeral | Create a ephemeral post PostsApi | deletepost | DELETE /posts/{postid} | Delete a post PostsApi | dopostaction | POST /posts/{postid}/actions/{actionid} | Perform a post action PostsApi | getfileinfosforpost | GET /posts/{postid}/files/info | Get file info for post *PostsApi* | getflaggedpostsforuser | GET /users/{userid}/posts/flagged | Get a list of flagged posts PostsApi | getpost | GET /posts/{postid} | Get a post PostsApi | getpostthread | GET /posts/{postid}/thread | Get a thread *PostsApi* | getpostsaroundlastunread | GET /users/{userid}/channels/{channelid}/posts/unread | Get posts around oldest unread *PostsApi* | getpostsbyids | POST /posts/ids | Get posts by a list of ids PostsApi | getpostsforchannel | GET /channels/{channelid}/posts | Get posts for a channel PostsApi | patchpost | PUT /posts/{postid}/patch | Patch a post PostsApi | pinpost | POST /posts/{postid}/pin | Pin a post to the channel PostsApi | searchposts | POST /teams/{teamid}/posts/search | Search for team posts PostsApi | setpostunread | POST /users/{userid}/posts/{postid}/setunread | Mark as unread from a post. *PostsApi* | unpinpost | POST /posts/{postid}/unpin | Unpin a post to the channel *PostsApi* | updatepost | PUT /posts/{postid} | Update a post *PreferencesApi* | deletepreferences | POST /users/{userid}/preferences/delete | Delete user's preferences *PreferencesApi* | getpreferences | GET /users/{userid}/preferences | Get the user's preferences *PreferencesApi* | getpreferencesbycategory | GET /users/{userid}/preferences/{category} | List a user's preferences by category *PreferencesApi* | getpreferencesbycategorybyname | GET /users/{userid}/preferences/{category}/name/{preferencename} | Get a specific user preference PreferencesApi | updatepreferences | PUT /users/{userid}/preferences | Save the user's preferences ReactionsApi | deletereaction | DELETE /users/{userid}/posts/{postid}/reactions/{emojiname} | Remove a reaction from a post ReactionsApi | getbulkreactions | POST /posts/ids/reactions | Bulk get the reaction for posts ReactionsApi | getreactions | GET /posts/{postid}/reactions | Get a list of reactions to a post ReactionsApi | gettopreactionsforteam | GET /teams/{teamid}/top/reactions | Get a list of the top reactions for a team. *ReactionsApi* | gettopreactionsforuser | GET /users/me/top/reactions | Get a list of the top reactions across all public and private channels (the user is a member of) for a given user. *ReactionsApi* | savereaction | POST /reactions | Create a reaction RolesApi | getrole | GET /roles/{roleid} | Get a role RolesApi | getrolebyname | GET /roles/name/{rolename} | Get a role RolesApi | getrolesbynames | POST /roles/names | Get a list of roles by name *RolesApi* | patchrole | PUT /roles/{roleid}/patch | Patch a role *RolesApi* | rolesget | GET /roles | Get a list of all the roles RootApi | acknowledgenotification | POST /notifications/ack | Acknowledge receiving of a notification *SAMLApi* | deletesamlidpcertificate | DELETE /saml/certificate/idp | Remove IDP certificate SAMLApi | deletesamlprivatecertificate | DELETE /saml/certificate/private | Remove private key *SAMLApi* | deletesamlpubliccertificate | DELETE /saml/certificate/public | Remove public certificate SAMLApi | getsamlcertificatestatus | GET /saml/certificate/status | Get certificate status *SAMLApi* | getsamlmetadata | GET /saml/metadata | Get metadata *SAMLApi* | getsamlmetadatafromidp | POST /saml/metadatafromidp | Get metadata from Identity Provider *SAMLApi* | migrateauthtosaml | POST /users/migrateauth/saml | Migrate user accounts authentication type to SAML. *SAMLApi* | resetsamlauthdatatoemail | POST /saml/resetauthdata | Reset AuthData to Email SAMLApi | uploadsamlidpcertificate | POST /saml/certificate/idp | Upload IDP certificate *SAMLApi* | uploadsamlprivatecertificate | POST /saml/certificate/private | Upload private key SAMLApi | uploadsamlpubliccertificate | POST /saml/certificate/public | Upload public certificate *SchemesApi* | createscheme | POST /schemes | Create a scheme SchemesApi | deletescheme | DELETE /schemes/{schemeid} | Delete a scheme SchemesApi | getchannelsforscheme | GET /schemes/{schemeid}/channels | Get a page of channels which use this scheme. SchemesApi | getscheme | GET /schemes/{schemeid} | Get a scheme SchemesApi | getschemes | GET /schemes | Get the schemes. *SchemesApi* | getteamsforscheme | GET /schemes/{schemeid}/teams | Get a page of teams which use this scheme. *SchemesApi* | patchscheme | PUT /schemes/{schemeid}/patch | Patch a scheme *SearchApi* | searchfiles | POST /teams/{teamid}/files/search | Search files in a team *SharedChannelsApi* | getallsharedchannels | GET /sharedchannels/{teamid} | Get all shared channels for team. *SharedChannelsApi* | getremoteclusterinfo | GET /sharedchannels/remoteinfo/{remoteid} | Get remote cluster info by ID for user. StatusApi | getuserstatus | GET /users/{userid}/status | Get user status *StatusApi* | getusersstatusesbyids | POST /users/status/ids | Get user statuses by id *StatusApi* | postuserrecentcustomstatusdelete | POST /users/{userid}/status/custom/recent/delete | Delete user's recent custom status *StatusApi* | removerecentcustomstatus | DELETE /users/{userid}/status/custom/recent | Delete user's recent custom status *StatusApi* | unsetusercustomstatus | DELETE /users/{userid}/status/custom | Unsets user custom status *StatusApi* | updateusercustomstatus | PUT /users/{userid}/status/custom | Update user custom status *StatusApi* | updateuserstatus | PUT /users/{userid}/status | Update user status SystemApi | checkintegrity | POST /integrity | Perform a database integrity check *SystemApi* | clearserverbusy | DELETE /serverbusy | Clears the server busy (high load) flag SystemApi | databaserecycle | POST /database/recycle | Recycle database connections *SystemApi* | generatesupportpacket | GET /system/supportpacket | Download a zip file which contains helpful and useful information for troubleshooting your mattermost instance. SystemApi | getanalyticsold | GET /analytics/old | Get analytics SystemApi | getaudits | GET /audits | Get audits *SystemApi* | getclientconfig | GET /config/client | Get client configuration *SystemApi* | getclientlicense | GET /license/client | Get client license *SystemApi* | getconfig | GET /config | Get configuration SystemApi | getenvironmentconfig | GET /config/environment | Get configuration made through environment variables SystemApi | getimagebyurl | GET /image | Get an image by url *SystemApi* | getlogs | GET /logs | Get logs SystemApi | getnotices | GET /system/notices/{teamId} | Get notices for logged in user in specified team *SystemApi* | getping | GET /system/ping | Check system health SystemApi | getredirectlocation | GET /redirectlocation | Get redirect location *SystemApi* | getserverbusyexpires | GET /serverbusy | Get server busy expiry time. *SystemApi* | getsupportedtimezone | GET /system/timezones | Retrieve a list of supported timezones *SystemApi* | getwarnmetricsstatus | GET /warnmetrics/status | Get the warn metrics status (enabled or disabled) *SystemApi* | invalidatecaches | POST /caches/invalidate | Invalidate all the caches SystemApi | marknoticesviewed | PUT /system/notices/view | Update notices as 'viewed' SystemApi | patchconfig | PUT /config/patch | Patch configuration *SystemApi* | postlog | POST /logs | Add log message SystemApi | reloadconfig | POST /config/reload | Reload configuration *SystemApi* | removelicensefile | DELETE /license | Remove license file *SystemApi* | requestlicenserenewallink | GET /license/renewal | Request the license renewal link SystemApi | requesttriallicense | POST /trial-license | Request and install a trial license for your server SystemApi | restartserver | POST /restart | Restart the system after an upgrade from Team Edition to Enterprise Edition *SystemApi* | sendtriallicensewarnmetricack | POST /warnmetrics/trial-license-ack/{warnmetricid} | Request trial license and acknowledge a warning of a metric status *SystemApi* | sendwarnmetricack | POST /warnmetrics/ack/{warnmetricid} | Acknowledge a warning of a metric status *SystemApi* | setserverbusy | POST /serverbusy | Set the server busy (high load) flag SystemApi | testemail | POST /email/test | Send a test email *SystemApi* | tests3connection | POST /file/s3test | Test AWS S3 connection SystemApi | testsiteurl | POST /siteurl/test | Checks the validity of a Site URL *SystemApi* | triallicenseprevget | GET /trial-license/prev | Get last trial license used SystemApi | updateconfig | PUT /config | Update configuration *SystemApi* | updatemarketplacevisitedbyadmin | POST /plugins/marketplace/firstadminvisit | Stores that the Plugin Marketplace has been visited by at least an admin. *SystemApi* | upgradetoenterprise | POST /upgradetoenterprise | Executes an inplace upgrade from Team Edition to Enterprise Edition *SystemApi* | upgradetoenterprisestatus | GET /upgradetoenterprise/status | Get the current status for the inplace upgrade from Team Edition to Enterprise Edition SystemApi | uploadlicensefile | POST /license | Upload license file TeamsApi | addteammember | POST /teams/{teamid}/members | Add user to team *TeamsApi* | addteammemberfrominvite | POST /teams/members/invite | Add user to team from invite *TeamsApi* | addteammembers | POST /teams/{teamid}/members/batch | Add multiple users to team TeamsApi | createteam | POST /teams | Create a team *TeamsApi* | getallteams | GET /teams | Get teams *TeamsApi* | getteam | GET /teams/{teamid} | Get a team *TeamsApi* | getteambyname | GET /teams/name/{name} | Get a team by name TeamsApi | getteamicon | GET /teams/{teamid}/image | Get the team icon *TeamsApi* | getteaminviteinfo | GET /teams/invite/{inviteid} | Get invite info for a team *TeamsApi* | getteammember | GET /teams/{teamid}/members/{userid} | Get a team member *TeamsApi* | getteammembers | GET /teams/{teamid}/members | Get team members TeamsApi | getteammembersbyids | POST /teams/{teamid}/members/ids | Get team members by ids *TeamsApi* | getteammembersforuser | GET /users/{userid}/teams/members | Get team members for a user TeamsApi | getteamstats | GET /teams/{teamid}/stats | Get a team stats *TeamsApi* | getteamunread | GET /users/{userid}/teams/{teamid}/unread | Get unreads for a team *TeamsApi* | getteamsforuser | GET /users/{userid}/teams | Get a user's teams *TeamsApi* | getteamsunreadforuser | GET /users/{userid}/teams/unread | Get team unreads for a user TeamsApi | importteam | POST /teams/{teamid}/import | Import a Team from other application TeamsApi | invalidateemailinvites | DELETE /teams/invites/email | Invalidate active email invitations TeamsApi | invitegueststoteam | POST /teams/{teamid}/invite-guests/email | Invite guests to the team by email TeamsApi | inviteuserstoteam | POST /teams/{teamid}/invite/email | Invite users to the team by email TeamsApi | patchteam | PUT /teams/{teamid}/patch | Patch a team TeamsApi | regenerateteaminviteid | POST /teams/{teamid}/regenerateinviteid | Regenerate the Invite ID from a Team TeamsApi | removeteamicon | DELETE /teams/{teamid}/image | Remove the team icon *TeamsApi* | removeteammember | DELETE /teams/{teamid}/members/{userid} | Remove user from team *TeamsApi* | restoreteam | POST /teams/{teamid}/restore | Restore a team *TeamsApi* | searchfiles | POST /teams/{teamid}/files/search | Search files in a team *TeamsApi* | searchteams | POST /teams/search | Search teams TeamsApi | setteamicon | POST /teams/{teamid}/image | Sets the team icon *TeamsApi* | softdeleteteam | DELETE /teams/{teamid} | Delete a team TeamsApi | teamexists | GET /teams/name/{name}/exists | Check if team exists *TeamsApi* | teammembersminusgroupmembers | GET /teams/{teamid}/membersminusgroupmembers | Team members minus group members. *TeamsApi* | updateteam | PUT /teams/{teamid} | Update a team *TeamsApi* | updateteammemberroles | PUT /teams/{teamid}/members/{userid}/roles | Update a team member roles TeamsApi | updateteammemberschemeroles | PUT /teams/{teamid}/members/{userid}/schemeRoles | Update the scheme-derived roles of a team member. TeamsApi | updateteamprivacy | PUT /teams/{teamid}/privacy | Update teams's privacy *TeamsApi* | updateteamscheme | PUT /teams/{teamid}/scheme | Set a team's scheme TermsOfServiceApi | createtermsofservice | POST /termsofservice | Creates a new terms of service *TermsOfServiceApi* | gettermsofservice | GET /termsofservice | Get latest terms of service TermsOfServiceApi | getusertermsofservice | GET /users/{userid}/termsofservice | Fetches user's latest terms of service action if the latest action was for acceptance. *TermsOfServiceApi* | registertermsofserviceaction | POST /users/{userid}/termsofservice | Records user action when they accept or decline custom terms of service ThreadsApi | getthreadmentioncountsbychannel | GET /users/{userid}/teams/{teamid}/threads/mentioncounts | Get all unread mention counts from followed threads, per-channel ThreadsApi | getuserthread | GET /users/{userid}/teams/{teamid}/threads/{threadid} | Get a thread followed by the user *ThreadsApi* | getuserthreads | GET /users/{userid}/teams/{teamid}/threads | Get all threads that user is following *ThreadsApi* | startfollowingthread | PUT /users/{userid}/teams/{teamid}/threads/{threadid}/following | Start following a thread ThreadsApi | stopfollowingthread | DELETE /users/{userid}/teams/{teamid}/threads/{threadid}/following | Stop following a thread *ThreadsApi* | updatethreadreadforuser | PUT /users/{userid}/teams/{teamid}/threads/{threadid}/read/{timestamp} | Mark a thread that user is following read state to the timestamp ThreadsApi | updatethreadsreadforuser | PUT /users/{userid}/teams/{teamid}/threads/read | Mark all threads that user is following as read UploadsApi | createupload | POST /uploads | Create an upload *UploadsApi* | getupload | GET /uploads/{uploadid} | Get an upload session *UploadsApi* | uploaddata | POST /uploads/{uploadid} | Perform a file upload *UsersApi* | attachdeviceid | PUT /users/sessions/device | Attach mobile device *UsersApi* | autocompleteusers | GET /users/autocomplete | Autocomplete users UsersApi | checkusermfa | POST /users/mfa | Check MFA UsersApi | convertbottouser | POST /bots/{botuserid}/converttouser | Convert a bot into a user *UsersApi* | convertusertobot | POST /users/{userid}/converttobot | Convert a user into a bot *UsersApi* | createuser | POST /users | Create a user UsersApi | createuseraccesstoken | POST /users/{userid}/tokens | Create a user access token UsersApi | deleteuser | DELETE /users/{userid} | Deactivate a user account. UsersApi | demoteusertoguest | POST /users/{userid}/demote | Demote a user to a guest UsersApi | disableuseraccesstoken | POST /users/tokens/disable | Disable personal access token *UsersApi* | enableuseraccesstoken | POST /users/tokens/enable | Enable personal access token UsersApi | generatemfasecret | POST /users/{userid}/mfa/generate | Generate MFA secret *UsersApi* | getchannelmemberswithteamdataforuser | GET /users/{userid}/channelmembers | Get all channel members from all teams for a user UsersApi | getdefaultprofileimage | GET /users/{userid}/image/default | Return user's default (generated) profile image UsersApi | getknownusers | GET /users/known | Get user IDs of known users UsersApi | getprofileimage | GET /users/{userid}/image | Get user's profile image *UsersApi* | getsessions | GET /users/{userid}/sessions | Get user's sessions *UsersApi* | gettotalusersstats | GET /users/stats | Get total count of users in the system UsersApi | gettotalusersstatsfiltered | GET /users/stats/filtered | Get total count of users in the system matching the specified filters UsersApi | getuploadsforuser | GET /users/{userid}/uploads | Get uploads for a user UsersApi | getuser | GET /users/{userid} | Get a user UsersApi | getuseraccesstoken | GET /users/tokens/{tokenid} | Get a user access token UsersApi | getuseraccesstokens | GET /users/tokens | Get user access tokens *UsersApi* | getuseraccesstokensforuser | GET /users/{userid}/tokens | Get user access tokens *UsersApi* | getuseraudits | GET /users/{userid}/audits | Get user's audits UsersApi | getuserbyemail | GET /users/email/{email} | Get a user by email *UsersApi* | getuserbyusername | GET /users/username/{username} | Get a user by username UsersApi | getusertermsofservice | GET /users/{userid}/termsofservice | Fetches user's latest terms of service action if the latest action was for acceptance. *UsersApi* | getusers | GET /users | Get users UsersApi | getusersbygroupchannelids | POST /users/groupchannels | Get users by group channels ids UsersApi | getusersbyids | POST /users/ids | Get users by ids *UsersApi* | getusersbyusernames | POST /users/usernames | Get users by usernames UsersApi | login | POST /users/login | Login to Mattermost server UsersApi | loginbycwstoken | POST /users/login/cws | Auto-Login to Mattermost server using CWS token *UsersApi* | logout | POST /users/logout | Logout from the Mattermost server *UsersApi* | migrateauthtoldap | POST /users/migrateauth/ldap | Migrate user accounts authentication type to LDAP. *UsersApi* | migrateauthtosaml | POST /users/migrateauth/saml | Migrate user accounts authentication type to SAML. *UsersApi* | patchuser | PUT /users/{userid}/patch | Patch a user *UsersApi* | permanentdeleteallusers | DELETE /users | Permanent delete all users UsersApi | promoteguesttouser | POST /users/{userid}/promote | Promote a guest to user UsersApi | publishusertyping | POST /users/{userid}/typing | Publish a user typing websocket event. *UsersApi* | registertermsofserviceaction | POST /users/{userid}/termsofservice | Records user action when they accept or decline custom terms of service UsersApi | resetpassword | POST /users/password/reset | Reset password *UsersApi* | revokeallsessions | POST /users/{userid}/sessions/revoke/all | Revoke all active sessions for a user UsersApi | revokesession | POST /users/{userid}/sessions/revoke | Revoke a user session UsersApi | revokesessionsfromallusers | POST /users/sessions/revoke/all | Revoke all sessions from all users. UsersApi | revokeuseraccesstoken | POST /users/tokens/revoke | Revoke a user access token *UsersApi* | searchuseraccesstokens | POST /users/tokens/search | Search tokens UsersApi | searchusers | POST /users/search | Search users *UsersApi* | sendpasswordresetemail | POST /users/password/reset/send | Send password reset email UsersApi | sendverificationemail | POST /users/email/verify/send | Send verification email UsersApi | setdefaultprofileimage | DELETE /users/{userid}/image | Delete user's profile image UsersApi | setprofileimage | POST /users/{userid}/image | Set user's profile image *UsersApi* | switchaccounttype | POST /users/login/switch | Switch login method *UsersApi* | updateuser | PUT /users/{userid} | Update a user *UsersApi* | updateuseractive | PUT /users/{userid}/active | Update user active status UsersApi | updateuserauth | PUT /users/{userid}/auth | Update a user's authentication method *UsersApi* | updateusermfa | PUT /users/{userid}/mfa | Update a user's MFA UsersApi | updateuserpassword | PUT /users/{userid}/password | Update a user's password *UsersApi* | updateuserroles | PUT /users/{userid}/roles | Update a user's roles UsersApi | verifyuseremail | POST /users/email/verify | Verify user email UsersApi | verifyuseremailwithouttoken | POST /users/{userid}/email/verify/member | Verify user email by ID *WebhooksApi* | createincomingwebhook | POST /hooks/incoming | Create an incoming webhook *WebhooksApi* | createoutgoingwebhook | POST /hooks/outgoing | Create an outgoing webhook *WebhooksApi* | deleteincomingwebhook | DELETE /hooks/incoming/{hookid} | Delete an incoming webhook WebhooksApi | deleteoutgoingwebhook | DELETE /hooks/outgoing/{hookid} | Delete an outgoing webhook *WebhooksApi* | getincomingwebhook | GET /hooks/incoming/{hookid} | Get an incoming webhook WebhooksApi | getincomingwebhooks | GET /hooks/incoming | List incoming webhooks WebhooksApi | getoutgoingwebhook | GET /hooks/outgoing/{hookid} | Get an outgoing webhook *WebhooksApi* | getoutgoingwebhooks | GET /hooks/outgoing | List outgoing webhooks *WebhooksApi* | regenoutgoinghooktoken | POST /hooks/outgoing/{hookid}/regentoken | Regenerate the token for the outgoing webhook. WebhooksApi | updateincomingwebhook | PUT /hooks/incoming/{hookid} | Update an incoming webhook *WebhooksApi* | updateoutgoingwebhook | PUT /hooks/outgoing/{hookid} | Update an outgoing webhook
To get access to the crate's generated documentation, use:
cargo doc --open
feedback@mattermost.com