Endpoints

Brand

class mattermostdriver.endpoints.brand.Brand(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/brand'
get_brand_image()[source]
upload_brand_image(files)[source]

Channels

class mattermostdriver.endpoints.channels.Channels(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/channels'
create_channel(options)[source]
create_direct_message_channel(options)[source]
create_group_message_channel(options)[source]
get_list_of_channels_by_ids(team_id, options=None)[source]
get_channel(channel_id)[source]
update_channel(channel_id, options)[source]
delete_channel(channel_id)[source]
patch_channel(channel_id, options)[source]
restore_channel(channel_id)[source]
get_channel_statistics(channel_id)[source]
get_channel_pinned_posts(channel_id)[source]
get_channel_by_name(team_id, channel_name)[source]
get_channel_by_name_and_team_name(team_name, channel_name)[source]
get_channel_members(channel_id, params=None)[source]
add_user(channel_id, options=None)[source]
get_channel_members_by_ids(channel_id, options=None)[source]
get_channel_member(channel_id, user_id)[source]
remove_channel_member(channel_id, user_id)[source]
update_channel_roles(channel_id, user_id, options)[source]
update_channel_notifications(channel_id, user_id, options=None)[source]
view_channel(user_id, options)[source]
get_channel_members_for_user(user_id, team_id)[source]
get_channels_for_user(user_id, team_id)[source]
get_channel_for_user(user_id, team_id)[source]
get_unread_messages(user_id, channel_id)[source]
get_public_channels(team_id, params=None)[source]
get_deleted_channels(team_id, params=None)[source]
search_channels(team_id, options=None)[source]
autocomplete_channels(team_id, params=None)[source]

Cluster

class mattermostdriver.endpoints.cluster.Cluster(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/cluster'
get_cluster_status()[source]

Commands

class mattermostdriver.endpoints.commands.Commands(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/commands'
create_command(options=None)[source]
list_commands_for_team(params=None)[source]
list_autocomplete_commands(team_id)[source]
update_command(command_id, options=None)[source]
delete_command(command_id)[source]
generate_new_token(command_id)[source]
execute_command(options=None)[source]

Compliance

class mattermostdriver.endpoints.compliance.Compliance(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/compliance'
create_report()[source]
get_reports(params=None)[source]
get_report(report_id)[source]
download_report(report_id)[source]

Data_retention

class mattermostdriver.endpoints.data_retention.DataRetention(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/data_retention'
get_data_retention_policy()[source]

Elasticsearch

class mattermostdriver.endpoints.elasticsearch.Elasticsearch(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/elasticsearch'
test_elasticsearch_configuration()[source]
purge_all_elasticsearch_indexes()[source]

Emoji

class mattermostdriver.endpoints.emoji.Emoji(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/emoji'
create_custom_emoji(emoji_name, files)[source]
get_emoji_list(params=None)[source]
get_custom_emoji(emoji_id)[source]
delete_custom_emoji(emoji_id)[source]
get_custom_emoji_by_name(name)[source]
get_custom_emoji_image(emoji_id)[source]
search_custom_emoji(options=None)[source]
autocomplete_custom_emoji(params=None)[source]

Files

class mattermostdriver.endpoints.files.Files(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/files'
upload_file(channel_id, files)[source]
get_file(file_id)[source]
get_file_thumbnail(file_id)[source]
get_file_preview(file_id)[source]
get_file_metadata(file_id)[source]

LDAP

class mattermostdriver.endpoints.ldap.LDAP(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/ldap'
sync_ldap()[source]
test_ldap_config()[source]

OAuth

class mattermostdriver.endpoints.oauth.OAuth(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/oauth'
register_oauth_app(options)[source]
get_oauth_apps(params=None)[source]
get_oauth_app(app_id)[source]
delete_oauth_app(app_id)[source]
regenerate_oauth_app_secret(app_id)[source]
get_info_on_oauth_app(app_id)[source]
get_authorized_oauth_apps(user_id, params=None)[source]

Posts

class mattermostdriver.endpoints.posts.Posts(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/posts'
create_post(options)[source]
get_post(post_id)[source]
delete_post(post_id)[source]
update_post(post_id, options=None)[source]
patch_post(post_id, options=None)[source]
get_thread(post_id)[source]
get_list_of_flagged_posts(user_id, params=None)[source]
get_file_info_for_post(post_id)[source]
get_posts_for_channel(channel_id, params=None)[source]
search_for_team_posts(team_id, options)[source]
pin_post_to_channel(post_id)[source]
unpin_post_to_channel(post_id)[source]
perform_post_action(post_id, action_id)[source]

Preferences

class mattermostdriver.endpoints.preferences.Preferences(client)[source]

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)[source]
save_user_preferences(user_id, options=None)[source]
delete_user_preferences(user_id, options=None)[source]
list_user_preferences_by_category(user_id, category)[source]
get_specific_user_preference(user_id, category, preference_name)[source]

SAML

class mattermostdriver.endpoints.saml.SAML(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/saml'
get_metadata()[source]
upload_idp_certificate(files)[source]
remove_idp_certificate()[source]
upload_public_certificate(files)[source]
remove_public_certificate()[source]
upload_private_key(files)[source]
remove_private_key()[source]
get_certificate_status()[source]

System

class mattermostdriver.endpoints.system.System(client)[source]

Bases: mattermostdriver.endpoints.base.Base

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

check_system_health()[source]
recycle_database_connection()[source]
send_test_email()[source]
get_configuration()[source]
update_configuration(options)[source]
reload_configuration()[source]
get_client_configuration(params)[source]
upload_license_file(files)[source]
remove_license_file()[source]
get_client_license(params)[source]
get_audits(params)[source]
invalidate_all_caches()[source]
get_logs(params)[source]
add_log_message(options)[source]
get_webrtc_token()[source]
get_analytics(params)[source]

Teams

class mattermostdriver.endpoints.teams.Teams(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/teams'
create_team(options=None)[source]
get_teams(params=None)[source]
get_team(team_id)[source]
update_team(team_id, options=None)[source]
delete_team(team_id, params=None)[source]
patch_team(team_id, options=None)[source]
get_team_by_name(name)[source]
search_teams(options=None)[source]
check_team_exists(name)[source]
get_user_teams(user_id)[source]
get_team_members(team_id, params=None)[source]
add_user_to_team(team_id, options=None)[source]
add_user_to_team_from_invite(params=None)[source]
add_multiple_users_to_team(team_id, options=None)[source]
get_team_members_for_user(user_id)[source]
get_team_member(team_id, user_id)[source]
remove_user_from_team(team_id, user_id)[source]
get_team_members_by_id(team_id, options=None)[source]
get_team_stats(team_id)[source]
update_team_member_roles(team_id, user_id, options=None)[source]
get_team_unreads_for_user(user_id, params=None)[source]
get_unreads_for_team(user_id, team_id)[source]
invite_users_to_team_by_mail(team_id, options=None)[source]
import_team_from_other_app(team_id, data=None)[source]
get_invite_info_for_team(invite_id)[source]
get_public_channels(team_id, params=None)[source]
get_deleted_channels(team_id, params=None)[source]
search_channels(team_id, options=None)[source]

Users

class mattermostdriver.endpoints.users.Users(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/users'
login_user(options)[source]
logout_user()[source]
create_user(options=None)[source]
get_users(params=None)[source]
get_users_by_ids(options=None)[source]
get_users_by_usernames(options=None)[source]
search_users(options=None)[source]
autocomplete_users(params=None)[source]
get_user(user_id)[source]
update_user(user_id, options=None)[source]
deactivate_user(user_id)[source]
patch_user(user_id, options=None)[source]
update_user_role(user_id, options=None)[source]
update_user_active_status(user_id, options=None)[source]
get_user_profile_image(user_id)[source]
set_user_profile_image(user_id, files)[source]
get_user_by_username(username)[source]
reset_password(options=None)[source]
update_user_mfa(user_id, options=None)[source]
generate_mfa(user_id)[source]
check_mfa(options=None)[source]
update_user_password(user_id, options=None)[source]
send_password_reset_mail(options=None)[source]
get_user_by_email(email)[source]
get_user_sessions(user_id)[source]
revoke_user_session(user_id, options=None)[source]
revoke_all_user_sessions(user_id)[source]
attach_mobile_device(options=None)[source]
get_user_audits(user_id)[source]
verify_user_email(options=None)[source]
send_verification_mail(options=None)[source]
switch_login_method(options=None)[source]
disable_personal_access_token(options=None)[source]
enable_personal_access_token(options=None)[source]
get_user_access_token(token_id)[source]
search_tokens(options=None)[source]
update_user_authentication_method(user_id, options=None)[source]
create_user_access_token(user_id, options=None)[source]

Webhooks

class mattermostdriver.endpoints.webhooks.Webhooks(client)[source]

Bases: mattermostdriver.endpoints.base.Base

endpoint = '/hooks'
create_incoming_hook(options)[source]
list_incoming_hooks(params)[source]
get_incoming_hook(hook_id)[source]
update_incoming_hook(hook_id, options)[source]
create_outgoing_hook(options)[source]
list_outgoing_hooks(params)[source]
get_outgoing_hook(hook_id)[source]
delete_outgoing_hook(hook_id)[source]
update_outgoing_hook(hook_id, options)[source]
regenerate_token_outgoing_hook(hook_id)[source]
call_webhook(hook_id, options=None)[source]