mattermost_dart 4.0.0 icon indicating copy to clipboard operation
mattermost_dart: ^4.0.0 copied to clipboard

MatterMost API Client for Dart

mattermost_dart (EXPERIMENTAL) #

There is also a work-in-progress Postman API reference.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 4.0.0
  • Build package: org.openapitools.codegen.languages.DartDioNextClientCodegen

Requirements #

  • Dart 2.12.0 or later OR Flutter 1.26.0 or later
  • Dio 4.0.0+

Installation & Usage #

pub.dev #

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  mattermost_dart: 4.0.0

Github #

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  mattermost_dart:
    git:
      url: https://github.com/tuyen-vuduc/mattermost-dart-openapi.git
      #ref: main

Local development #

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  mattermost_dart:
    path: /path/to/mattermost_dart

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:mattermost_dart/mattermost_dart.dart';


final api = MattermostDart().getAuthenticationApi();
final InlineObject26 inlineObject26 = ; // InlineObject26 | 

try {
    api.migrateAuthToLdap(inlineObject26);
} catch on DioError (e) {
    print("Exception when calling AuthenticationApi->migrateAuthToLdap: $e\n");
}

Documentation for API Endpoints #

All URIs are relative to http://your-mattermost-url.com/api/v4

ClassMethodHTTP requestDescription
AuthenticationApimigrateAuthToLdapPOST /users/migrate_auth/ldapMigrate user accounts authentication type to LDAP.
AuthenticationApimigrateAuthToSamlPOST /users/migrate_auth/samlMigrate user accounts authentication type to SAML.
BleveApipurgeBleveIndexesPOST /bleve/purge_indexesPurge all Bleve indexes
BotsApiassignBotPOST /bots/{bot_user_id}/assign/{user_id}Assign a bot to a user
BotsApiconvertBotToUserPOST /bots/{bot_user_id}/convert_to_userConvert a bot into a user
BotsApiconvertUserToBotPOST /users/{user_id}/convert_to_botConvert a user into a bot
BotsApicreateBotPOST /botsCreate a bot
BotsApideleteBotIconImageDELETE /bots/{bot_user_id}/iconDelete bot's LHS icon image
BotsApidisableBotPOST /bots/{bot_user_id}/disableDisable a bot
BotsApienableBotPOST /bots/{bot_user_id}/enableEnable a bot
BotsApigetBotGET /bots/{bot_user_id}Get a bot
BotsApigetBotIconImageGET /bots/{bot_user_id}/iconGet bot's LHS icon
BotsApigetBotsGET /botsGet bots
BotsApipatchBotPUT /bots/{bot_user_id}Patch a bot
BotsApisetBotIconImagePOST /bots/{bot_user_id}/iconSet bot's LHS icon image
BrandApideleteBrandImageDELETE /brand/imageDelete current brand image
BrandApigetBrandImageGET /brand/imageGet brand image
BrandApiuploadBrandImagePOST /brand/imageUpload brand image
ChannelsApiaddChannelMemberPOST /channels/{channel_id}/membersAdd user to channel
ChannelsApiautocompleteChannelsForTeamGET /teams/{team_id}/channels/autocompleteAutocomplete channels
ChannelsApiautocompleteChannelsForTeamForSearchGET /teams/{team_id}/channels/search_autocompleteAutocomplete channels for search
ChannelsApichannelMembersMinusGroupMembersGET /channels/{channel_id}/members_minus_group_membersChannel members minus group members.
ChannelsApicreateChannelPOST /channelsCreate a channel
ChannelsApicreateDirectChannelPOST /channels/directCreate a direct message channel
ChannelsApicreateGroupChannelPOST /channels/groupCreate a group message channel
ChannelsApicreateSidebarCategoryForTeamForUserPOST /users/{user_id}/teams/{team_id}/channels/categoriesCreate user's sidebar category
ChannelsApideleteChannelDELETE /channels/{channel_id}Delete a channel
ChannelsApigetAllChannelsGET /channelsGet a list of all channels
ChannelsApigetChannelGET /channels/{channel_id}Get a channel
ChannelsApigetChannelByNameGET /teams/{team_id}/channels/name/{channel_name}Get a channel by name
ChannelsApigetChannelByNameForTeamNameGET /teams/name/{team_name}/channels/name/{channel_name}Get a channel by name and team name
ChannelsApigetChannelMemberGET /channels/{channel_id}/members/{user_id}Get channel member
ChannelsApigetChannelMemberCountsByGroupGET /channels/{channel_id}/member_counts_by_groupChannel members counts for each group that has atleast one member in the channel
ChannelsApigetChannelMembersGET /channels/{channel_id}/membersGet channel members
ChannelsApigetChannelMembersByIdsPOST /channels/{channel_id}/members/idsGet channel members by ids
ChannelsApigetChannelMembersForUserGET /users/{user_id}/teams/{team_id}/channels/membersGet channel memberships and roles for a user
ChannelsApigetChannelMembersTimezonesGET /channels/{channel_id}/timezonesGet timezones in a channel
ChannelsApigetChannelModerationsGET /channels/{channel_id}/moderationsGet information about channel's moderation.
ChannelsApigetChannelStatsGET /channels/{channel_id}/statsGet channel statistics
ChannelsApigetChannelUnreadGET /users/{user_id}/channels/{channel_id}/unreadGet unread messages
ChannelsApigetChannelsForTeamForUserGET /users/{user_id}/teams/{team_id}/channelsGet channels for user
ChannelsApigetChannelsForUserGET /users/{user_id}/channelsGet all channels from all teams
ChannelsApigetDeletedChannelsForTeamGET /teams/{team_id}/channels/deletedGet deleted channels
ChannelsApigetPinnedPostsGET /channels/{channel_id}/pinnedGet a channel's pinned posts
ChannelsApigetPrivateChannelsForTeamGET /teams/{team_id}/channels/privateGet private channels
ChannelsApigetPublicChannelsByIdsForTeamPOST /teams/{team_id}/channels/idsGet a list of channels by ids
ChannelsApigetPublicChannelsForTeamGET /teams/{team_id}/channelsGet public channels
ChannelsApigetSidebarCategoriesForTeamForUserGET /users/{user_id}/teams/{team_id}/channels/categoriesGet user's sidebar categories
ChannelsApigetSidebarCategoryForTeamForUserGET /users/{user_id}/teams/{team_id}/channels/categories/{category_id}Get sidebar category
ChannelsApigetSidebarCategoryOrderForTeamForUserGET /users/{user_id}/teams/{team_id}/channels/categories/orderGet user's sidebar category order
ChannelsApimoveChannelPOST /channels/{channel_id}/moveMove a channel
ChannelsApipatchChannelPUT /channels/{channel_id}/patchPatch a channel
ChannelsApipatchChannelModerationsPUT /channels/{channel_id}/moderations/patchUpdate a channel's moderation settings.
ChannelsApiremoveSidebarCategoryForTeamForUserDELETE /users/{user_id}/teams/{team_id}/channels/categories/{category_id}Delete sidebar category
ChannelsApiremoveUserFromChannelDELETE /channels/{channel_id}/members/{user_id}Remove user from channel
ChannelsApirestoreChannelPOST /channels/{channel_id}/restoreRestore a channel
ChannelsApisearchAllChannelsPOST /channels/searchSearch all private and open type channels across all teams
ChannelsApisearchArchivedChannelsPOST /teams/{team_id}/channels/search_archivedSearch archived channels
ChannelsApisearchChannelsPOST /teams/{team_id}/channels/searchSearch channels
ChannelsApisearchGroupChannelsPOST /channels/group/searchSearch Group Channels
ChannelsApiupdateChannelPUT /channels/{channel_id}Update a channel
ChannelsApiupdateChannelMemberSchemeRolesPUT /channels/{channel_id}/members/{user_id}/schemeRolesUpdate the scheme-derived roles of a channel member.
ChannelsApiupdateChannelNotifyPropsPUT /channels/{channel_id}/members/{user_id}/notify_propsUpdate channel notifications
ChannelsApiupdateChannelPrivacyPUT /channels/{channel_id}/privacyUpdate channel's privacy
ChannelsApiupdateChannelRolesPUT /channels/{channel_id}/members/{user_id}/rolesUpdate channel roles
ChannelsApiupdateChannelSchemePUT /channels/{channel_id}/schemeSet a channel's scheme
ChannelsApiupdateSidebarCategoriesForTeamForUserPUT /users/{user_id}/teams/{team_id}/channels/categoriesUpdate user's sidebar categories
ChannelsApiupdateSidebarCategoryForTeamForUserPUT /users/{user_id}/teams/{team_id}/channels/categories/{category_id}Update sidebar category
ChannelsApiupdateSidebarCategoryOrderForTeamForUserPUT /users/{user_id}/teams/{team_id}/channels/categories/orderUpdate user's sidebar category order
ChannelsApiviewChannelPOST /channels/members/{user_id}/viewView channel
CloudApiconfirmCustomerPaymentPOST /cloud/payment/confirmCompletes the payment setup intent
CloudApicreateCustomerPaymentPOST /cloud/paymentCreate a customer setup payment intent
CloudApigetCloudCustomerGET /cloud/customerGet cloud customer
CloudApigetCloudProductsGET /cloud/productsGet cloud products
CloudApigetInvoiceForSubscriptionAsPdfGET /cloud/subscription/invoices/{invoice_id}/pdfGet cloud invoice PDF
CloudApigetInvoicesForSubscriptionGET /cloud/subscription/invoicesGet cloud subscription invoices
CloudApigetSubscriptionGET /cloud/subscriptionGet cloud subscription
CloudApigetSubscriptionStatsGET /cloud/subscription/statsGET endpoint for cloud subscription stats
CloudApipostEndpointForCwsWebhooksPOST /cloud/webhookPOST endpoint for CWS Webhooks
CloudApisendAdminUpgradeRequestEmailPOST /cloud/subscription/limitreached/invitePOST endpoint for triggering sending emails to admin with request to upgrade workspace
CloudApisendAdminUpgradeRequestEmailOnJoinPOST /cloud/subscription/limitreached/joinPOST endpoint for triggering sending emails to admin with request to upgrade workspace
CloudApiupdateCloudCustomerPUT /cloud/customerUpdate cloud customer
CloudApiupdateCloudCustomerAddressPUT /cloud/customer/addressUpdate cloud customer address
ClusterApigetClusterStatusGET /cluster/statusGet cluster status
CommandsApicreateCommandPOST /commandsCreate a command
CommandsApideleteCommandDELETE /commands/{command_id}Delete a command
CommandsApiexecuteCommandPOST /commands/executeExecute a command
CommandsApigetCommandByIdGET /commands/{command_id}Get a command
CommandsApilistAutocompleteCommandsGET /teams/{team_id}/commands/autocompleteList autocomplete commands
CommandsApilistCommandAutocompleteSuggestionsGET /teams/{team_id}/commands/autocomplete_suggestionsList commands' autocomplete data
CommandsApilistCommandsGET /commandsList commands for a team
CommandsApimoveCommandPUT /commands/{command_id}/moveMove a command
CommandsApiregenCommandTokenPUT /commands/{command_id}/regen_tokenGenerate a new token
CommandsApiupdateCommandPUT /commands/{command_id}Update a command
ComplianceApicreateComplianceReportPOST /compliance/reportsCreate report
ComplianceApidownloadComplianceReportGET /compliance/reports/{report_id}/downloadDownload a report
ComplianceApigetComplianceReportGET /compliance/reports/{report_id}Get a report
ComplianceApigetComplianceReportsGET /compliance/reportsGet reports
DataRetentionApiaddChannelsToRetentionPolicyPOST /data_retention/policies/{policy_id}/channelsAdd channels to a granular data retention policy
DataRetentionApiaddTeamsToRetentionPolicyPOST /data_retention/policies/{policy_id}/teamsAdd teams to a granular data retention policy
DataRetentionApicreateDataRetentionPolicyPOST /data_retention/policiesCreate a new granular data retention policy
DataRetentionApideleteDataRetentionPolicyDELETE /data_retention/policies/{policy_id}Delete a granular data retention policy
DataRetentionApigetChannelPoliciesForUserGET /users/{user_id}/data_retention/channel_policiesGet the policies which are applied to a user's channels
DataRetentionApigetChannelsForRetentionPolicyGET /data_retention/policies/{policy_id}/channelsGet the channels for a granular data retention policy
DataRetentionApigetDataRetentionPoliciesGET /data_retention/policiesGet the granular data retention policies
DataRetentionApigetDataRetentionPoliciesCountGET /data_retention/policies_countGet the number of granular data retention policies
DataRetentionApigetDataRetentionPolicyGET /data_retention/policyGet the global data retention policy
DataRetentionApigetDataRetentionPolicyByIDGET /data_retention/policies/{policy_id}Get a granular data retention policy
DataRetentionApigetTeamPoliciesForUserGET /users/{user_id}/data_retention/team_policiesGet the policies which are applied to a user's teams
DataRetentionApigetTeamsForRetentionPolicyGET /data_retention/policies/{policy_id}/teamsGet the teams for a granular data retention policy
DataRetentionApipatchDataRetentionPolicyPATCH /data_retention/policies/{policy_id}Patch a granular data retention policy
DataRetentionApiremoveChannelsFromRetentionPolicyDELETE /data_retention/policies/{policy_id}/channelsDelete channels from a granular data retention policy
DataRetentionApiremoveTeamsFromRetentionPolicyDELETE /data_retention/policies/{policy_id}/teamsDelete teams from a granular data retention policy
DataRetentionApisearchChannelsForRetentionPolicyPOST /data_retention/policies/{policy_id}/channels/searchSearch for the channels in a granular data retention policy
DataRetentionApisearchTeamsForRetentionPolicyPOST /data_retention/policies/{policy_id}/teams/searchSearch for the teams in a granular data retention policy
ElasticsearchApipurgeElasticsearchIndexesPOST /elasticsearch/purge_indexesPurge all Elasticsearch indexes
ElasticsearchApitestElasticsearchPOST /elasticsearch/testTest Elasticsearch configuration
EmojiApiautocompleteEmojiGET /emoji/autocompleteAutocomplete custom emoji
EmojiApicreateEmojiPOST /emojiCreate a custom emoji
EmojiApideleteEmojiDELETE /emoji/{emoji_id}Delete a custom emoji
EmojiApigetEmojiGET /emoji/{emoji_id}Get a custom emoji
EmojiApigetEmojiByNameGET /emoji/name/{emoji_name}Get a custom emoji by name
EmojiApigetEmojiImageGET /emoji/{emoji_id}/imageGet custom emoji image
EmojiApigetEmojiListGET /emojiGet a list of custom emoji
EmojiApisearchEmojiPOST /emoji/searchSearch custom emoji
ExportsApideleteExportDELETE /exports/{export_name}Delete an export file
ExportsApidownloadExportGET /exports/{export_name}Download an export file
ExportsApilistExportsGET /exportsList export files
FilesApigetFileGET /files/{file_id}Get a file
FilesApigetFileInfoGET /files/{file_id}/infoGet metadata for a file
FilesApigetFileLinkGET /files/{file_id}/linkGet a public file link
FilesApigetFilePreviewGET /files/{file_id}/previewGet a file's preview
FilesApigetFilePublicGET /files/{file_id}/publicGet a public file
FilesApigetFileThumbnailGET /files/{file_id}/thumbnailGet a file's thumbnail
FilesApisearchFilesPOST /teams/{team_id}/files/searchSearch files in a team
FilesApiuploadFilePOST /filesUpload a file
GroupsApigetGroupGET /groups/{group_id}Get a group
GroupsApigetGroupStatsGET /groups/{group_id}/statsGet group stats
GroupsApigetGroupSyncableForChannelIdGET /groups/{group_id}/channels/{channel_id}Get GroupSyncable from channel ID
GroupsApigetGroupSyncableForTeamIdGET /groups/{group_id}/teams/{team_id}Get GroupSyncable from Team ID
GroupsApigetGroupSyncablesChannelsGET /groups/{group_id}/channelsGet group channels
GroupsApigetGroupSyncablesTeamsGET /groups/{group_id}/teamsGet group teams
GroupsApigetGroupUsersGET /groups/{group_id}/membersGet group users
GroupsApigetGroupsGET /groupsGet groups
GroupsApigetGroupsAssociatedToChannelsByTeamGET /teams/{team_id}/groups_by_channelsGet team groups by channels
GroupsApigetGroupsByChannelGET /channels/{channel_id}/groupsGet channel groups
GroupsApigetGroupsByTeamGET /teams/{team_id}/groupsGet team groups
GroupsApigetGroupsByUserIdGET /users/{user_id}/groupsGet groups for a userId
GroupsApilinkGroupSyncableForChannelPOST /groups/{group_id}/channels/{channel_id}/linkLink a channel to a group
GroupsApilinkGroupSyncableForTeamPOST /groups/{group_id}/teams/{team_id}/linkLink a team to a group
GroupsApipatchGroupPUT /groups/{group_id}/patchPatch a group
GroupsApipatchGroupSyncableForChannelPUT /groups/{group_id}/channels/{channel_id}/patchPatch a GroupSyncable associated to Channel
GroupsApipatchGroupSyncableForTeamPUT /groups/{group_id}/teams/{team_id}/patchPatch a GroupSyncable associated to Team
GroupsApiunlinkGroupSyncableForChannelDELETE /groups/{group_id}/channels/{channel_id}/linkDelete a link from a channel to a group
GroupsApiunlinkGroupSyncableForTeamDELETE /groups/{group_id}/teams/{team_id}/linkDelete a link from a team to a group
GroupsApiunlinkLdapGroupDELETE /ldap/groups/{remote_id}/linkDelete a link for LDAP group
ImportsApilistImportsGET /importsList import files
IntegrationActionsApiopenInteractiveDialogPOST /actions/dialogs/openOpen a dialog
IntegrationActionsApisubmitInteractiveDialogPOST /actions/dialogs/submitSubmit a dialog
JobsApicancelJobPOST /jobs/{job_id}/cancelCancel a job.
JobsApicreateJobPOST /jobsCreate a new job.
JobsApidownloadJobGET /jobs/{job_id}/downloadDownload the results of a job.
JobsApigetJobGET /jobs/{job_id}Get a job.
JobsApigetJobsGET /jobsGet the jobs.
JobsApigetJobsByTypeGET /jobs/type/{type}Get the jobs of the given type.
LDAPApideleteLdapPrivateCertificateDELETE /ldap/certificate/privateRemove private key
LDAPApideleteLdapPublicCertificateDELETE /ldap/certificate/publicRemove public certificate
LDAPApimigrateAuthToLdapPOST /users/migrate_auth/ldapMigrate user accounts authentication type to LDAP.
LDAPApimigrateIdLdapPOST /ldap/migrateidMigrate Id LDAP
LDAPApisyncLdapPOST /ldap/syncSync with LDAP
LDAPApitestLdapPOST /ldap/testTest LDAP configuration
LDAPApiuploadLdapPrivateCertificatePOST /ldap/certificate/privateUpload private key
LDAPApiuploadLdapPublicCertificatePOST /ldap/certificate/publicUpload public certificate
LdapApigetLdapGroupsGET /ldap/groupsReturns a list of LDAP groups
LdapApilinkLdapGroupPOST /ldap/groups/{remote_id}/linkLink a LDAP group
MigrateApimigrateAuthToLdapPOST /users/migrate_auth/ldapMigrate user accounts authentication type to LDAP.
MigrateApimigrateAuthToSamlPOST /users/migrate_auth/samlMigrate user accounts authentication type to SAML.
OAuthApicreateOAuthAppPOST /oauth/appsRegister OAuth app
OAuthApideleteOAuthAppDELETE /oauth/apps/{app_id}Delete an OAuth app
OAuthApigetAuthorizedOAuthAppsForUserGET /users/{user_id}/oauth/apps/authorizedGet authorized OAuth apps
OAuthApigetOAuthAppGET /oauth/apps/{app_id}Get an OAuth app
OAuthApigetOAuthAppInfoGET /oauth/apps/{app_id}/infoGet info on an OAuth app
OAuthApigetOAuthAppsGET /oauth/appsGet OAuth apps
OAuthApiregenerateOAuthAppSecretPOST /oauth/apps/{app_id}/regen_secretRegenerate OAuth app secret
OAuthApiupdateOAuthAppPUT /oauth/apps/{app_id}Update an OAuth app
OpenGraphApiopenGraphPOST /opengraphGet open graph metadata for url
PermissionsApigetAncillaryPermissionsGET /permissions/ancillaryReturn all system console subsection ancillary permissions
PluginsApidisablePluginPOST /plugins/{plugin_id}/disableDisable plugin
PluginsApienablePluginPOST /plugins/{plugin_id}/enableEnable plugin
PluginsApigetMarketplacePluginsGET /plugins/marketplaceGets all the marketplace plugins
PluginsApigetMarketplaceVisitedByAdminGET /plugins/marketplace/first_admin_visitGet if the Plugin Marketplace has been visited by at least an admin.
PluginsApigetPluginStatusesGET /plugins/statusesGet plugins status
PluginsApigetPluginsGET /pluginsGet plugins
PluginsApigetWebappPluginsGET /plugins/webappGet webapp plugins
PluginsApiinstallMarketplacePluginPOST /plugins/marketplaceInstalls a marketplace plugin
PluginsApiinstallPluginFromUrlPOST /plugins/install_from_urlInstall plugin from url
PluginsApiremovePluginDELETE /plugins/{plugin_id}Remove plugin
PluginsApiuploadPluginPOST /pluginsUpload plugin
PostsApicreatePostPOST /postsCreate a post
PostsApicreatePostEphemeralPOST /posts/ephemeralCreate a ephemeral post
PostsApideletePostDELETE /posts/{post_id}Delete a post
PostsApidoPostActionPOST /posts/{post_id}/actions/{action_id}Perform a post action
PostsApigetFileInfosForPostGET /posts/{post_id}/files/infoGet file info for post
PostsApigetFlaggedPostsForUserGET /users/{user_id}/posts/flaggedGet a list of flagged posts
PostsApigetPostGET /posts/{post_id}Get a post
PostsApigetPostThreadGET /posts/{post_id}/threadGet a thread
PostsApigetPostsAroundLastUnreadGET /users/{user_id}/channels/{channel_id}/posts/unreadGet posts around oldest unread
PostsApigetPostsByIdsPOST /posts/idsGet posts by a list of ids
PostsApigetPostsForChannelGET /channels/{channel_id}/postsGet posts for a channel
PostsApipatchPostPUT /posts/{post_id}/patchPatch a post
PostsApipinPostPOST /posts/{post_id}/pinPin a post to the channel
PostsApisearchPostsPOST /teams/{team_id}/posts/searchSearch for team posts
PostsApisetPostUnreadPOST /users/{user_id}/posts/{post_id}/set_unreadMark as unread from a post.
PostsApiunpinPostPOST /posts/{post_id}/unpinUnpin a post to the channel
PostsApiupdatePostPUT /posts/{post_id}Update a post
PreferencesApideletePreferencesPOST /users/{user_id}/preferences/deleteDelete user's preferences
PreferencesApigetPreferencesGET /users/{user_id}/preferencesGet the user's preferences
PreferencesApigetPreferencesByCategoryGET /users/{user_id}/preferences/{category}List a user's preferences by category
PreferencesApigetPreferencesByCategoryByNameGET /users/{user_id}/preferences/{category}/name/{preference_name}Get a specific user preference
PreferencesApiupdatePreferencesPUT /users/{user_id}/preferencesSave the user's preferences
ReactionsApideleteReactionDELETE /users/{user_id}/posts/{post_id}/reactions/{emoji_name}Remove a reaction from a post
ReactionsApigetBulkReactionsPOST /posts/ids/reactionsBulk get the reaction for posts
ReactionsApigetReactionsGET /posts/{post_id}/reactionsGet a list of reactions to a post
ReactionsApisaveReactionPOST /reactionsCreate a reaction
RolesApigetRoleGET /roles/{role_id}Get a role
RolesApigetRoleByNameGET /roles/name/{role_name}Get a role
RolesApigetRolesByNamesPOST /roles/namesGet a list of roles by name
RolesApipatchRolePUT /roles/{role_id}/patchPatch a role
RolesApirolesGetGET /rolesGet a list of all the roles
RootApiacknowledgeNotificationPOST /notifications/ackAcknowledge receiving of a notification
SAMLApideleteSamlIdpCertificateDELETE /saml/certificate/idpRemove IDP certificate
SAMLApideleteSamlPrivateCertificateDELETE /saml/certificate/privateRemove private key
SAMLApideleteSamlPublicCertificateDELETE /saml/certificate/publicRemove public certificate
SAMLApigetSamlCertificateStatusGET /saml/certificate/statusGet certificate status
SAMLApigetSamlMetadataGET /saml/metadataGet metadata
SAMLApigetSamlMetadataFromIdpPOST /saml/metadatafromidpGet metadata from Identity Provider
SAMLApimigrateAuthToSamlPOST /users/migrate_auth/samlMigrate user accounts authentication type to SAML.
SAMLApiresetSamlAuthDataToEmailPOST /saml/reset_auth_dataReset AuthData to Email
SAMLApiuploadSamlIdpCertificatePOST /saml/certificate/idpUpload IDP certificate
SAMLApiuploadSamlPrivateCertificatePOST /saml/certificate/privateUpload private key
SAMLApiuploadSamlPublicCertificatePOST /saml/certificate/publicUpload public certificate
SchemesApicreateSchemePOST /schemesCreate a scheme
SchemesApideleteSchemeDELETE /schemes/{scheme_id}Delete a scheme
SchemesApigetChannelsForSchemeGET /schemes/{scheme_id}/channelsGet a page of channels which use this scheme.
SchemesApigetSchemeGET /schemes/{scheme_id}Get a scheme
SchemesApigetSchemesGET /schemesGet the schemes.
SchemesApigetTeamsForSchemeGET /schemes/{scheme_id}/teamsGet a page of teams which use this scheme.
SchemesApipatchSchemePUT /schemes/{scheme_id}/patchPatch a scheme
SearchApisearchFilesPOST /teams/{team_id}/files/searchSearch files in a team
SharedChannelsApigetAllSharedChannelsGET /sharedchannels/{team_id}Get all shared channels for team.
SharedChannelsApigetRemoteClusterInfoGET /sharedchannels/remote_info/{remote_id}Get remote cluster info by ID for user.
StatusApigetUserStatusGET /users/{user_id}/statusGet user status
StatusApigetUsersStatusesByIdsPOST /users/status/idsGet user statuses by id
StatusApipostUserRecentCustomStatusDeletePOST /users/{user_id}/status/custom/recent/deleteDelete user's recent custom status
StatusApiremoveRecentCustomStatusDELETE /users/{user_id}/status/custom/recentDelete user's recent custom status
StatusApiunsetUserCustomStatusDELETE /users/{user_id}/status/customUnsets user custom status
StatusApiupdateUserCustomStatusPUT /users/{user_id}/status/customUpdate user custom status
StatusApiupdateUserStatusPUT /users/{user_id}/statusUpdate user status
SystemApicheckIntegrityPOST /integrityPerform a database integrity check
SystemApiclearServerBusyDELETE /server_busyClears the server busy (high load) flag
SystemApidatabaseRecyclePOST /database/recycleRecycle database connections
SystemApigenerateSupportPacketGET /system/support_packetDownload a zip file which contains helpful and useful information for troubleshooting your mattermost instance.
SystemApigetAnalyticsOldGET /analytics/oldGet analytics
SystemApigetAuditsGET /auditsGet audits
SystemApigetClientConfigGET /config/clientGet client configuration
SystemApigetClientLicenseGET /license/clientGet client license
SystemApigetConfigGET /configGet configuration
SystemApigetEnvironmentConfigGET /config/environmentGet configuration made through environment variables
SystemApigetImageByUrlGET /imageGet an image by url
SystemApigetLogsGET /logsGet logs
SystemApigetNoticesGET /system/notices/{teamId}Get notices for logged in user in specified team
SystemApigetPingGET /system/pingCheck system health
SystemApigetRedirectLocationGET /redirect_locationGet redirect location
SystemApigetServerBusyExpiresGET /server_busyGet server busy expiry time.
SystemApigetSupportedTimezoneGET /system/timezonesRetrieve a list of supported timezones
SystemApigetWarnMetricsStatusGET /warn_metrics/statusGet the warn metrics status (enabled or disabled)
SystemApiinvalidateCachesPOST /caches/invalidateInvalidate all the caches
SystemApimarkNoticesViewedPUT /system/notices/viewUpdate notices as 'viewed'
SystemApipatchConfigPUT /config/patchPatch configuration
SystemApipostLogPOST /logsAdd log message
SystemApireloadConfigPOST /config/reloadReload configuration
SystemApiremoveLicenseFileDELETE /licenseRemove license file
SystemApirequestLicenseRenewalLinkGET /license/renewalRequest the license renewal link
SystemApirequestTrialLicensePOST /trial-licenseRequest and install a trial license for your server
SystemApirestartServerPOST /restartRestart the system after an upgrade from Team Edition to Enterprise Edition
SystemApisendTrialLicenseWarnMetricAckPOST /warn_metrics/trial-license-ack/{warn_metric_id}Request trial license and acknowledge a warning of a metric status
SystemApisendWarnMetricAckPOST /warn_metrics/ack/{warn_metric_id}Acknowledge a warning of a metric status
SystemApisetServerBusyPOST /server_busySet the server busy (high load) flag
SystemApitestEmailPOST /email/testSend a test email
SystemApitestS3ConnectionPOST /file/s3_testTest AWS S3 connection
SystemApitestSiteURLPOST /site_url/testChecks the validity of a Site URL
SystemApitrialLicensePrevGetGET /trial-license/prevGet last trial license used
SystemApiupdateConfigPUT /configUpdate configuration
SystemApiupdateMarketplaceVisitedByAdminPOST /plugins/marketplace/first_admin_visitStores that the Plugin Marketplace has been visited by at least an admin.
SystemApiupgradeToEnterprisePOST /upgrade_to_enterpriseExecutes an inplace upgrade from Team Edition to Enterprise Edition
SystemApiupgradeToEnterpriseStatusGET /upgrade_to_enterprise/statusGet the current status for the inplace upgrade from Team Edition to Enterprise Edition
SystemApiuploadLicenseFilePOST /licenseUpload license file
TeamsApiaddTeamMemberPOST /teams/{team_id}/membersAdd user to team
TeamsApiaddTeamMemberFromInvitePOST /teams/members/inviteAdd user to team from invite
TeamsApiaddTeamMembersPOST /teams/{team_id}/members/batchAdd multiple users to team
TeamsApicreateTeamPOST /teamsCreate a team
TeamsApigetAllTeamsGET /teamsGet teams
TeamsApigetTeamGET /teams/{team_id}Get a team
TeamsApigetTeamByNameGET /teams/name/{name}Get a team by name
TeamsApigetTeamIconGET /teams/{team_id}/imageGet the team icon
TeamsApigetTeamInviteInfoGET /teams/invite/{invite_id}Get invite info for a team
TeamsApigetTeamMemberGET /teams/{team_id}/members/{user_id}Get a team member
TeamsApigetTeamMembersGET /teams/{team_id}/membersGet team members
TeamsApigetTeamMembersByIdsPOST /teams/{team_id}/members/idsGet team members by ids
TeamsApigetTeamMembersForUserGET /users/{user_id}/teams/membersGet team members for a user
TeamsApigetTeamStatsGET /teams/{team_id}/statsGet a team stats
TeamsApigetTeamUnreadGET /users/{user_id}/teams/{team_id}/unreadGet unreads for a team
TeamsApigetTeamsForUserGET /users/{user_id}/teamsGet a user's teams
TeamsApigetTeamsUnreadForUserGET /users/{user_id}/teams/unreadGet team unreads for a user
TeamsApiimportTeamPOST /teams/{team_id}/importImport a Team from other application
TeamsApiinvalidateEmailInvitesDELETE /teams/invites/emailInvalidate active email invitations
TeamsApiinviteGuestsToTeamPOST /teams/{team_id}/invite-guests/emailInvite guests to the team by email
TeamsApiinviteUsersToTeamPOST /teams/{team_id}/invite/emailInvite users to the team by email
TeamsApipatchTeamPUT /teams/{team_id}/patchPatch a team
TeamsApiregenerateTeamInviteIdPOST /teams/{team_id}/regenerate_invite_idRegenerate the Invite ID from a Team
TeamsApiremoveTeamIconDELETE /teams/{team_id}/imageRemove the team icon
TeamsApiremoveTeamMemberDELETE /teams/{team_id}/members/{user_id}Remove user from team
TeamsApirestoreTeamPOST /teams/{team_id}/restoreRestore a team
TeamsApisearchFilesPOST /teams/{team_id}/files/searchSearch files in a team
TeamsApisearchTeamsPOST /teams/searchSearch teams
TeamsApisetTeamIconPOST /teams/{team_id}/imageSets the team icon
TeamsApisoftDeleteTeamDELETE /teams/{team_id}Delete a team
TeamsApiteamExistsGET /teams/name/{name}/existsCheck if team exists
TeamsApiteamMembersMinusGroupMembersGET /teams/{team_id}/members_minus_group_membersTeam members minus group members.
TeamsApiupdateTeamPUT /teams/{team_id}Update a team
TeamsApiupdateTeamMemberRolesPUT /teams/{team_id}/members/{user_id}/rolesUpdate a team member roles
TeamsApiupdateTeamMemberSchemeRolesPUT /teams/{team_id}/members/{user_id}/schemeRolesUpdate the scheme-derived roles of a team member.
TeamsApiupdateTeamPrivacyPUT /teams/{team_id}/privacyUpdate teams's privacy
TeamsApiupdateTeamSchemePUT /teams/{team_id}/schemeSet a team's scheme
TermsOfServiceApicreateTermsOfServicePOST /terms_of_serviceCreates a new terms of service
TermsOfServiceApigetTermsOfServiceGET /terms_of_serviceGet latest terms of service
TermsOfServiceApigetUserTermsOfServiceGET /users/{user_id}/terms_of_serviceFetches user's latest terms of service action if the latest action was for acceptance.
TermsOfServiceApiregisterTermsOfServiceActionPOST /users/{user_id}/terms_of_serviceRecords user action when they accept or decline custom terms of service
ThreadsApigetThreadMentionCountsByChannelGET /users/{user_id}/teams/{team_id}/threads/mention_countsGet all unread mention counts from followed threads, per-channel
ThreadsApigetUserThreadGET /users/{user_id}/teams/{team_id}/threads/{thread_id}Get a thread followed by the user
ThreadsApigetUserThreadsGET /users/{user_id}/teams/{team_id}/threadsGet all threads that user is following
ThreadsApistartFollowingThreadPUT /users/{user_id}/teams/{team_id}/threads/{thread_id}/followingStart following a thread
ThreadsApistopFollowingThreadDELETE /users/{user_id}/teams/{team_id}/threads/{thread_id}/followingStop following a thread
ThreadsApiupdateThreadReadForUserPUT /users/{user_id}/teams/{team_id}/threads/{thread_id}/read/{timestamp}Mark a thread that user is following read state to the timestamp
ThreadsApiupdateThreadsReadForUserPUT /users/{user_id}/teams/{team_id}/threads/readMark all threads that user is following as read
UploadsApicreateUploadPOST /uploadsCreate an upload
UploadsApigetUploadGET /uploads/{upload_id}Get an upload session
UploadsApiuploadDataPOST /uploads/{upload_id}Perform a file upload
UsersApiattachDeviceIdPUT /users/sessions/deviceAttach mobile device
UsersApiautocompleteUsersGET /users/autocompleteAutocomplete users
UsersApicheckUserMfaPOST /users/mfaCheck MFA
UsersApiconvertBotToUserPOST /bots/{bot_user_id}/convert_to_userConvert a bot into a user
UsersApiconvertUserToBotPOST /users/{user_id}/convert_to_botConvert a user into a bot
UsersApicreateUserPOST /usersCreate a user
UsersApicreateUserAccessTokenPOST /users/{user_id}/tokensCreate a user access token
UsersApideleteUserDELETE /users/{user_id}Deactivate a user account.
UsersApidemoteUserToGuestPOST /users/{user_id}/demoteDemote a user to a guest
UsersApidisableUserAccessTokenPOST /users/tokens/disableDisable personal access token
UsersApienableUserAccessTokenPOST /users/tokens/enableEnable personal access token
UsersApigenerateMfaSecretPOST /users/{user_id}/mfa/generateGenerate MFA secret
UsersApigetChannelMembersWithTeamDataForUserGET /users/{user_id}/channel_membersGet all channel members from all teams for a user
UsersApigetDefaultProfileImageGET /users/{user_id}/image/defaultReturn user's default (generated) profile image
UsersApigetKnownUsersGET /users/knownGet user IDs of known users
UsersApigetProfileImageGET /users/{user_id}/imageGet user's profile image
UsersApigetSessionsGET /users/{user_id}/sessionsGet user's sessions
UsersApigetTotalUsersStatsGET /users/statsGet total count of users in the system
UsersApigetTotalUsersStatsFilteredGET /users/stats/filteredGet total count of users in the system matching the specified filters
UsersApigetUploadsForUserGET /users/{user_id}/uploadsGet uploads for a user
UsersApigetUserGET /users/{user_id}Get a user
UsersApigetUserAccessTokenGET /users/tokens/{token_id}Get a user access token
UsersApigetUserAccessTokensGET /users/tokensGet user access tokens
UsersApigetUserAccessTokensForUserGET /users/{user_id}/tokensGet user access tokens
UsersApigetUserAuditsGET /users/{user_id}/auditsGet user's audits
UsersApigetUserByEmailGET /users/email/{email}Get a user by email
UsersApigetUserByUsernameGET /users/username/{username}Get a user by username
UsersApigetUserTermsOfServiceGET /users/{user_id}/terms_of_serviceFetches user's latest terms of service action if the latest action was for acceptance.
UsersApigetUsersGET /usersGet users
UsersApigetUsersByGroupChannelIdsPOST /users/group_channelsGet users by group channels ids
UsersApigetUsersByIdsPOST /users/idsGet users by ids
UsersApigetUsersByUsernamesPOST /users/usernamesGet users by usernames
UsersApiloginPOST /users/loginLogin to Mattermost server
UsersApiloginByCwsTokenPOST /users/login/cwsAuto-Login to Mattermost server using CWS token
UsersApilogoutPOST /users/logoutLogout from the Mattermost server
UsersApimigrateAuthToLdapPOST /users/migrate_auth/ldapMigrate user accounts authentication type to LDAP.
UsersApimigrateAuthToSamlPOST /users/migrate_auth/samlMigrate user accounts authentication type to SAML.
UsersApipatchUserPUT /users/{user_id}/patchPatch a user
UsersApipermanentDeleteAllUsersDELETE /usersPermanent delete all users
UsersApipromoteGuestToUserPOST /users/{user_id}/promotePromote a guest to user
UsersApipublishUserTypingPOST /users/{user_id}/typingPublish a user typing websocket event.
UsersApiregisterTermsOfServiceActionPOST /users/{user_id}/terms_of_serviceRecords user action when they accept or decline custom terms of service
UsersApiresetPasswordPOST /users/password/resetReset password
UsersApirevokeAllSessionsPOST /users/{user_id}/sessions/revoke/allRevoke all active sessions for a user
UsersApirevokeSessionPOST /users/{user_id}/sessions/revokeRevoke a user session
UsersApirevokeSessionsFromAllUsersPOST /users/sessions/revoke/allRevoke all sessions from all users.
UsersApirevokeUserAccessTokenPOST /users/tokens/revokeRevoke a user access token
UsersApisearchUserAccessTokensPOST /users/tokens/searchSearch tokens
UsersApisearchUsersPOST /users/searchSearch users
UsersApisendPasswordResetEmailPOST /users/password/reset/sendSend password reset email
UsersApisendVerificationEmailPOST /users/email/verify/sendSend verification email
UsersApisetDefaultProfileImageDELETE /users/{user_id}/imageDelete user's profile image
UsersApisetProfileImagePOST /users/{user_id}/imageSet user's profile image
UsersApiswitchAccountTypePOST /users/login/switchSwitch login method
UsersApiupdateUserPUT /users/{user_id}Update a user
UsersApiupdateUserActivePUT /users/{user_id}/activeUpdate user active status
UsersApiupdateUserAuthPUT /users/{user_id}/authUpdate a user's authentication method
UsersApiupdateUserMfaPUT /users/{user_id}/mfaUpdate a user's MFA
UsersApiupdateUserPasswordPUT /users/{user_id}/passwordUpdate a user's password
UsersApiupdateUserRolesPUT /users/{user_id}/rolesUpdate a user's roles
UsersApiverifyUserEmailPOST /users/email/verifyVerify user email
UsersApiverifyUserEmailWithoutTokenPOST /users/{user_id}/email/verify/memberVerify user email by ID
WebhooksApicreateIncomingWebhookPOST /hooks/incomingCreate an incoming webhook
WebhooksApicreateOutgoingWebhookPOST /hooks/outgoingCreate an outgoing webhook
WebhooksApideleteIncomingWebhookDELETE /hooks/incoming/{hook_id}Delete an incoming webhook
WebhooksApideleteOutgoingWebhookDELETE /hooks/outgoing/{hook_id}Delete an outgoing webhook
WebhooksApigetIncomingWebhookGET /hooks/incoming/{hook_id}Get an incoming webhook
WebhooksApigetIncomingWebhooksGET /hooks/incomingList incoming webhooks
WebhooksApigetOutgoingWebhookGET /hooks/outgoing/{hook_id}Get an outgoing webhook
WebhooksApigetOutgoingWebhooksGET /hooks/outgoingList outgoing webhooks
WebhooksApiregenOutgoingHookTokenPOST /hooks/outgoing/{hook_id}/regen_tokenRegenerate the token for the outgoing webhook.
WebhooksApiupdateIncomingWebhookPUT /hooks/incoming/{hook_id}Update an incoming webhook
WebhooksApiupdateOutgoingWebhookPUT /hooks/outgoing/{hook_id}Update an outgoing webhook

Documentation For Models #

Documentation For Authorization #

bearerAuth #

  • Type: HTTP basic authentication

Author #

feedback@mattermost.com

0
likes
100
pub points
21%
popularity

Publisher

verified publisher iconnaxam.net

MatterMost API Client for Dart

Homepage

Documentation

API reference

License

Icon for licenses.MIT (LICENSE)

Dependencies

built_collection, built_value, dio

More

Packages that depend on mattermost_dart