Endpoints

Bots

class mattermostdriver.endpoints.bots.Bots(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/bots'

create_bot(options)

get_bots(params=None)

patch_bot(bot_id, options)

get_bot(bot_id, params=None)

disable_bot(bot_id)

enable_bot(bot_id)

assign_bot_to_user(bot_id, user_id)

get_bot_lhs_icon(bot_id)

set_bot_lhs_icon(bot_id, files)

delete_bot_lhs_icon(bot_id)

Brand

class mattermostdriver.endpoints.brand.Brand(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/brand'

get_brand_image()

upload_brand_image(files)

Channels

class mattermostdriver.endpoints.channels.Channels(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/channels'

create_channel(options)

create_direct_message_channel(options)

create_group_message_channel(options)

get_list_of_channels_by_ids(team_id, options=None)

get_channel(channel_id)

update_channel(channel_id, options)

delete_channel(channel_id)

patch_channel(channel_id, options)

restore_channel(channel_id)

get_channel_statistics(channel_id)

get_channel_pinned_posts(channel_id)

get_channel_by_name(team_id, channel_name)

get_channel_by_name_and_team_name(team_name, channel_name)

get_channel_members(channel_id, params=None)

add_user(channel_id, options=None)

get_channel_members_by_ids(channel_id, options=None)

get_channel_member(channel_id, user_id)

remove_channel_member(channel_id, user_id)

update_channel_roles(channel_id, user_id, options)

update_channel_notifications(channel_id, user_id, options=None)

view_channel(user_id, options)

get_channel_members_for_user(user_id, team_id)

get_channels_for_user(user_id, team_id)

get_channel_for_user(user_id, team_id)

get_unread_messages(user_id, channel_id)

get_public_channels(team_id, params=None)

get_deleted_channels(team_id, params=None)

search_channels(team_id, options=None)

autocomplete_channels(team_id, params=None)

update_scheme_derived_roles_of_channel_member(channel_id, user_id, options=None)

set_channel_scheme(channel_id)

convert_channel(channel_id)

Cluster

class mattermostdriver.endpoints.cluster.Cluster(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/cluster'

get_cluster_status()

Commands

class mattermostdriver.endpoints.commands.Commands(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/commands'

create_command(options=None)

list_commands_for_team(params=None)

list_autocomplete_commands(team_id)

update_command(command_id, options=None)

delete_command(command_id)

generate_new_token(command_id)

execute_command(options=None)

Compliance

class mattermostdriver.endpoints.compliance.Compliance(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/compliance'

create_report(params)

get_reports(params=None)

get_report(report_id)

download_report(report_id)

Data_retention

class mattermostdriver.endpoints.data_retention.DataRetention(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/data_retention'

get_data_retention_policy()

Elasticsearch

class mattermostdriver.endpoints.elasticsearch.Elasticsearch(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/elasticsearch'

test_elasticsearch_configuration()

purge_all_elasticsearch_indexes()

Emoji

class mattermostdriver.endpoints.emoji.Emoji(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/emoji'

create_custom_emoji(emoji_name, files)

get_emoji_list(params=None)

get_custom_emoji(emoji_id)

delete_custom_emoji(emoji_id)

get_custom_emoji_by_name(name)

get_custom_emoji_image(emoji_id)

search_custom_emoji(options=None)

autocomplete_custom_emoji(params=None)

Files

class mattermostdriver.endpoints.files.Files(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/files'

upload_file(channel_id, files)

get_file(file_id)

get_file_thumbnail(file_id)

get_file_preview(file_id)

get_public_file_link(file_id)

get_file_metadata(file_id)

Integration_actions

class mattermostdriver.endpoints.integration_actions.IntegrationActions(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/actions'

open_dialog(options)

submit_dialog(options)

LDAP

class mattermostdriver.endpoints.ldap.LDAP(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/ldap'

sync_ldap()

test_ldap_config()

OAuth

class mattermostdriver.endpoints.oauth.OAuth(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/oauth'

register_oauth_app(options)

get_oauth_apps(params=None)

get_oauth_app(app_id)

delete_oauth_app(app_id)

regenerate_oauth_app_secret(app_id)

get_info_on_oauth_app(app_id)

get_authorized_oauth_apps(user_id, params=None)

Posts

class mattermostdriver.endpoints.posts.Posts(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/posts'

create_post(options)

create_ephemeral_post(options)

get_post(post_id)

delete_post(post_id)

update_post(post_id, options=None)

patch_post(post_id, options=None)

get_thread(post_id)

get_list_of_flagged_posts(user_id, params=None)

get_file_info_for_post(post_id)

get_posts_for_channel(channel_id, params=None)

search_for_team_posts(team_id, options)

pin_post_to_channel(post_id)

unpin_post_to_channel(post_id)

perform_post_action(post_id, action_id)

get_unread_posts_for_channel(user_id, channel_id, params=None)

Preferences

class mattermostdriver.endpoints.preferences.Preferences(client)

Bases: mattermostdriver.endpoints.base.Base

This is the endpoint for Preferences. It is special in a way, that the endpoint is /user and not /preferences, like one might expect at first!

endpoint = '/users'

get_user_preferences(user_id)

save_user_preferences(user_id, options=None)

delete_user_preferences(user_id, options=None)

list_user_preferences_by_category(user_id, category)

get_specific_user_preference(user_id, category, preference_name)

Reactions

class mattermostdriver.endpoints.reactions.Reactions(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/reactions'

create_reaction(options=None)

get_reactions_of_post(post_id)

delete_reaction(user_id, post_id, emoji_name, params=None)

Roles

class mattermostdriver.endpoints.roles.Roles(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/roles'

get_role_by_id(role_id)

get_role_by_name(role_name)

patch_role(role_id, options=None)

get_list_of_roles_by_name()

SAML

class mattermostdriver.endpoints.saml.SAML(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/saml'

get_metadata()

upload_idp_certificate(files)

remove_idp_certificate()

upload_public_certificate(files)

remove_public_certificate()

upload_private_key(files)

remove_private_key()

get_certificate_status()

Scheme

class mattermostdriver.endpoints.scheme.Scheme(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/schemes'

get_schemes(params=None)

create_scheme(options=None)

get_scheme(scheme_id)

delete_scheme(scheme_id)

patch_scheme(scheme_id, options=None)

get_page_of_teams_using_scheme(scheme_id, params=None)

get_page_of_channels_using_scheme(scheme_id, params=None)

Status

class mattermostdriver.endpoints.status.Status(client)

Bases: mattermostdriver.endpoints.base.Base

get_user_status(user_id)

update_user_status(user_id, options=None)

get_user_statuses_by_id(options=None)

System

class mattermostdriver.endpoints.system.System(client)

Bases: mattermostdriver.endpoints.base.Base

This endpoint has a mix of different endpoints, not only /system

check_system_health()

recycle_database_connection()

send_test_email(options=None)

get_configuration()

update_configuration(options)

reload_configuration()

get_client_configuration(params)

upload_license_file(files)

remove_license_file()

get_client_license(params)

get_audits(params)

invalidate_all_caches()

get_logs(params)

add_log_message(options)

get_webrtc_token()

get_analytics(params)

get_configuration_environment()

test_aws_s3_connection(options=None)

Teams

class mattermostdriver.endpoints.teams.Teams(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/teams'

create_team(options=None)

get_teams(params=None)

get_team(team_id)

update_team(team_id, options=None)

delete_team(team_id, params=None)

patch_team(team_id, options=None)

get_team_by_name(name)

search_teams(options=None)

check_team_exists(name)

get_user_teams(user_id)

get_team_members(team_id, params=None)

add_user_to_team(team_id, options=None)

add_user_to_team_from_invite(params=None)

add_multiple_users_to_team(team_id, options=None)

get_team_members_for_user(user_id)

get_team_member(team_id, user_id)

remove_user_from_team(team_id, user_id)

get_team_members_by_id(team_id, options=None)

get_team_stats(team_id)

update_team_member_roles(team_id, user_id, options=None)

get_team_unreads_for_user(user_id, params=None)

get_unreads_for_team(user_id, team_id)

invite_users_to_team_by_mail(team_id, options=None)

import_team_from_other_app(team_id, data=None)

get_invite_info_for_team(invite_id)

get_public_channels(team_id, params=None)

get_deleted_channels(team_id, params=None)

search_channels(team_id, options=None)

get_team_icon(team_id)

set_team_icon(team_id, file)

update_scheme_derived_roles_of_team_member(team_id, user_id, options=None)

delete_team_icon(team_id)

set_team_scheme(team_id)

Users

class mattermostdriver.endpoints.users.Users(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/users'

login_user(options)

logout_user()

create_user(options=None, params=None)

get_users(params=None)

get_users_by_ids(options=None)

get_users_by_usernames(options=None)

search_users(options=None)

autocomplete_users(params=None)

get_user(user_id)

update_user(user_id, options=None)

deactivate_user(user_id)

patch_user(user_id, options=None)

update_user_role(user_id, options=None)

update_user_active_status(user_id, options=None)

get_user_profile_image(user_id)

set_user_profile_image(user_id, files)

get_user_by_username(username)

reset_password(options=None)

update_user_mfa(user_id, options=None)

generate_mfa(user_id)

check_mfa(options=None)

update_user_password(user_id, options=None)

send_password_reset_mail(options=None)

get_user_by_email(email)

get_user_sessions(user_id)

revoke_user_session(user_id, options=None)

revoke_all_user_sessions(user_id)

attach_mobile_device(options=None)

get_user_audits(user_id)

verify_user_email(options=None)

send_verification_mail(options=None)

switch_login_method(options=None)

disable_personal_access_token(options=None)

enable_personal_access_token(options=None)

get_user_access_token(token_id)

search_tokens(options=None)

update_user_authentication_method(user_id, options=None)

create_user_access_token(user_id, options=None)

get_stats()

Webhooks

class mattermostdriver.endpoints.webhooks.Webhooks(client)

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/hooks'

create_incoming_hook(options)

list_incoming_hooks(params)

get_incoming_hook(hook_id)

update_incoming_hook(hook_id, options)

create_outgoing_hook(options)

list_outgoing_hooks(params)

get_outgoing_hook(hook_id)

delete_outgoing_hook(hook_id)

update_outgoing_hook(hook_id, options)

regenerate_token_outgoing_hook(hook_id)

call_webhook(hook_id, options=None)