As we decommissioned our instance, this repo will not be updated anymore. Please use the upstream repo for future updates.

Mattermost Plugin

This plugins syncs LDAP groups to Mattermost teams

Configuration

!plugin config Mattermost {'ADMINS': ('@mmadmin',),
'LDAP_BIND_ENCRYPTED_PASSWORD': 'ENCRYPTED_PASSWORD',
'LDAP_BIND_USER': 'cn=username,ou=org,dc=example,dc=com',
'LDAP_SEARCH_BASE': 'ou=BASE,dc=example,dc=com',
'LDAP_URI': 'ldaps://localhost:636',
'MM_CHANNEL': '#mattermost',
'MM_DEBUG': False,
'MM_ENCRYPTED_ACCESS_TOKEN': None,
'MM_PORT': 443,
'MM_SCHEME': 'https',
'MM_URL': 'https://mattermost.example.com',
'SYNC_FREQUENCY': 600}

Course Name Spec

Please see here for details.

Bot Commands

• !mm mapping add - Manually add a course to course mappings for automatic syncing
  • Usage: !mm mapping add COURSE_NAME_SPEC
• !mm mapping list - List all course mappings used for automatic syncing
• !mm mapping remove - Remove a course to course mappings for automatic syncing
  • Usage: !mm mapping remove COURSE_NAME_SPEC
• !mm scheduler start - Start scheduler for automatic syncing
• !mm scheduler stop - Stop scheduler for automatic syncing
• !mm sync - Manually sync a team with LDAP course
  • Usage: mm_sync [-h] [--once] course_spec
  • When a course is synced with this command, it is added to course mapping by default unless --once option is specified. The scheduler will use the mapping to do automatic syncing.
  • !mm sync COURSE_NAME_SPEC
  • !mm sync CPSC_101_101_2018W
  • !mm sync CPSC_101_101_2018W=CUSTOM-TEAM-NAME
  • !mm sync CPSC_101_101_2018W+CPSC_101_201_2018W=CUSTOM-TEAM-NAME
• !mm team add - Add a team
  • Usage: usage: mm_team_add [-h] [--type {O,I}] [--display-name DISPLAY_NAME] team_name
  • Display name is optional. Default is the value of team_name
  • Type: can be Open or Invite, default: Invite
• !mm team list - List all teams in in Mattermost
• !mm token list - List all encrypted access token stored
• !mm token set - Set encrypted access token to be used for ad-hoc command
  • Usage: !mm token set ENCRYPTED_ACCESS_TOKEN
• !mm token show - Show encrypted access token to be used for ad-hoc command
• !mm user get - Get user info
  • Usage: !mm user get USERNAME [-f/--full]
  • -f/--full is the flag to show full details. Otherwise, only return user id and username
• !mm user add - Add a user to a team
  • Usage: mm_user_add [-h] [--role {admin,user}] username team_name
  • By default, adding as user/member role
• !mm user remove - Remove a user from a team
  • Usage: mm_user_remove [-h] username team_name
• !mm user activate - Activate a user
  • Usage: !mm user activate USERNAME
• !mm user deactivate - Deactivate a user
  • Usage: !mm user deactivate USERNAME
• !mm user update - Update a user
  • Usage: !mm user update USERNAME [--username NEW_USERNAME] [--email NEW_EMAIL] [--firstname NEW_FIRSTNAME] [--lastname NEW_LASTNAME] [--nickname NEW_NICKNAME]
  • All fields are optional. Only provided fields are updated.
  • Please note that if the user is authenticated through LDAP, the fields other than username will be overwritten by LDAP. Please notify user to make the change from upstream