Microsoft Teams Management

category: Messaging and Conferencing
provider: Microsoft
sectionorder:
- Connect
- Collect
commonfields:
  id: Microsoft Teams Management
  version: -1
configuration:
- defaultvalue: 3307a0ab-612c-47af-b3b5-8208247562db
  display: Application ID
  name: app_id
  type: 0
  section: Connect
  required: false
- defaultvalue: https://login.microsoftonline.com
  display: Azure AD endpoint
  name: azure_ad_endpoint
  options:
  - https://login.microsoftonline.com
  - https://login.microsoftonline.us
  - https://login.microsoftonline.de
  - https://login.chinacloudapi.cn
  type: 15
  additionalinfo: Azure AD endpoint associated with a national cloud.
  section: Connect
  advanced: true
  required: false
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  defaultvalue: 'false'
  section: Connect
  advanced: true
  required: false
- display: Use system proxy settings
  name: proxy
  type: 8
  defaultvalue: "false"
  section: Connect
  advanced: true
  required: false
- name: authentication_type
  display: Authentication Type
  defaultvalue: Device Code
  type: 15
  additionalinfo: Type of authentication - could be Client Credentials Authorization Flow (recommended) or Device Flow
  options:
  - Device Code
  - Client Credentials
  - Azure Managed Identities
  section: Connect
  advanced: true
  required: false
- name: tenant_id
  display: Tenant ID (for Client Credentials mode)
  defaultvalue:
  type: 0
  additionalinfo: ""
  section: Connect
  advanced: true
  required: false
- name: credentials
  hiddenusername: true
  displaypassword: Client Secret (for Client Credentials mode)
  display: Client Secret (for Client Credentials mode)
  defaultvalue:
  type: 9
  additionalinfo: ""
  section: Connect
  required: false
- additionalinfo: The Managed Identities client ID for authentication - relevant only if the integration is running on Azure VM.
  displaypassword: Azure Managed Identities Client ID
  name: managed_identities_client_id
  hiddenusername: true
  type: 9
  section: Connect
  required: false
description: Manage teams and members in Microsoft Teams.
display: Microsoft Teams Management
name: Microsoft Teams Management
script:
  commands:
  - description: Run this command to start the authorization process and follow the instructions in the command results.
    name: microsoft-teams-auth-start
    arguments: []
    outputs: []
  - description: |-
      Run this command to complete the authorization process.
      Should be used after running the microsoft-teams-auth-start command.
    name: microsoft-teams-auth-complete
    arguments: []
    outputs: []
  - description: Run this command if for some reason you need to rerun the authentication process.
    name: microsoft-teams-auth-reset
    arguments: []
    outputs: []
  - description: Tests connectivity to Microsoft.
    name: microsoft-teams-auth-test
    arguments: []
    outputs: []
  - arguments:
    - description: The name of the team.
      name: display_name
      required: true
    - description: Description of the team.
      name: description
    - auto: PREDEFINED
      defaultValue: public
      description: 'The visibility of the group and team. Possible values are: "public" and "private".'
      name: visibility
      predefined:
      - public
      - private
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether guests can add and update channels. Possible values are: "true" and "false".'
      name: allow_guests_create_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether guests can delete channels. Possible values are: "true" and "false".'
      name: allow_guests_delete_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether members can add and update private channels. Possible values are: "true" and "false".'
      name: allow_members_create_private_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether members can add and update channels. Possible values are: "true" and "false".'
      name: allow_members_create_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether members can delete channels. Possible values are: "true" and "false".'
      name: allow_members_delete_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether members can add and remove apps. Possible values are: "true" and "false".'
      name: allow_members_add_remove_apps
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether members can add, update, and remove tabs. Possible values are: "true" and "false".'
      name: allow_members_add_remove_tabs
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether members can add, update, and remove connectors. Possible values are: "true" and "false".'
      name: allow_members_add_remove_connectors
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether users can edit their messages. Possible values are: "true" and "false".'
      name: allow_user_edit_messages
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether users can delete their messages. Possible values are: "true" and "false".'
      name: allow_user_delete_messages
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether owners can delete any message. Possible values are: "true" and "false".'
      name: allow_owner_delete_messages
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether @team mentions are allowed. Possible values are: "true" and "false".'
      name: allow_team_mentions
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether @channel mentions are allowed. Possible values are: "true" and "false".'
      name: allow_channel_mentions
      predefined:
      - 'false'
      - 'true'
    - description: ID of the user to be the team owner (e.g., 0040b377-61d8-43db-94f5-81374122dc7e). Can be retrieved by running the msgraph-user-list command.
      name: owner
      required: true
    description: Creates a new team.
    name: microsoft-teams-team-create
  - arguments:
    - description: ID of group to create team from. Can be retrieved by running the msgraph-groups-list-groups command.
      name: group_id
      required: true
    - description: The name of the team.
      name: display_name
    - description: Description of the team.
      name: description
    - auto: PREDEFINED
      defaultValue: public
      description: 'The visibility of the group and team. Possible values are: "public" and "private".'
      name: visibility
      predefined:
      - public
      - private
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether guests can add and update channels. Possible values are: "true" and "false".'
      name: allow_guests_create_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether guests can delete channels. Possible values are: "true" and "false".'
      name: allow_guests_delete_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether members can add and update private channels. Possible values are: "true" and "false".'
      name: allow_members_create_private_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether members can add and update channels. Possible values are: "true" and "false".'
      name: allow_members_create_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether members can delete channels. Possible values are: "true" and "false".'
      name: allow_members_delete_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether members can add and remove apps. Possible values are: "true" and "false".'
      name: allow_members_add_remove_apps
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether members can add, update, and remove tabs. Possible values are: "true" and "false".'
      name: allow_members_add_remove_tabs
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether members can add, update, and remove connectors. Possible values are: "true" and "false".'
      name: allow_members_add_remove_connectors
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether users can edit their messages. Possible values are: "true" and "false".'
      name: allow_user_edit_messages
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether users can delete their messages. Possible values are: "true" and "false".'
      name: allow_user_delete_messages
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether owners can delete any message. Possible values are: "true" and "false".'
      name: allow_owner_delete_messages
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether @team mentions are allowed. Possible values are: "true" and "false".'
      name: allow_team_mentions
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether @channel mentions are allowed. Possible values are: "true" and "false".'
      name: allow_channel_mentions
      predefined:
      - 'false'
      - 'true'
    description: Create a new team under a group. In order to create a team, the group must have a least one owner and the group cannot be of type Security.
    name: microsoft-teams-team-create-from-group
  - description: Returns all the groups that have teams in an organization.
    name: microsoft-teams-teams-list
    outputs:
    - contextPath: MicrosoftTeams.Team.securityEnabled
      description: Specifies whether the group is a security group.
      type: Boolean
    - contextPath: MicrosoftTeams.Team.preferredDataLocation
      description: The preferred data location for the group.
      type: String
    - contextPath: MicrosoftTeams.Team.resourceProvisioningOptions
      description: Specifies the group resources that are provisioned as part of Microsoft 365 group creation, that are not normally part of default group creation. Possible value is Team.
      type: String
    - contextPath: MicrosoftTeams.Team.createdDateTime
      description: 'Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: ''2014-01-01T00:00:00Z''.'
      type: String
    - contextPath: MicrosoftTeams.Team.mailNickname
      description: The alias of the group in an Exchange organization.
      type: String
    - contextPath: MicrosoftTeams.Team.securityIdentifier
      description: Security identifier of the group, used in Windows scenarios.
      type: String
    - contextPath: MicrosoftTeams.Team.mailEnabled
      description: Specifies whether the group is mail-enabled.
      type: Boolean
    - contextPath: MicrosoftTeams.Team.displayName
      description: The display name for the group.
      type: String
    - contextPath: MicrosoftTeams.Team.visibility
      description: 'Specifies the visibility of a Microsoft 365 group. Possible values are: Private, Public, or Hiddenmembership. Blank values are treated as public.'
      type: String
    - contextPath: MicrosoftTeams.Team.proxyAddresses
      description: 'Email addresses for the group that direct to the same group mailbox. For example: ["SMTP: bob@demisto.com", "smtp: bob@sales.demisto.com"].'
      type: String
    - contextPath: MicrosoftTeams.Team.mail
      description: The SMTP address for the group, for example, "serviceadmins@contoso.onmicrosoft.com".
      type: String
    - contextPath: MicrosoftTeams.Team.id
      description: The unique identifier for the group.
      type: String
    - contextPath: MicrosoftTeams.Team.description
      description: An optional description for the group.
      type: String
  - arguments:
    - description: ID of the team to update. Can be retrieved by running the microsoft-teams-teams-list command.
      name: team_id
      required: true
    - description: The name of the team.
      name: display_name
    - description: Description of the team.
      name: description
    - auto: PREDEFINED
      description: 'Whether guests can add and update channels. Possible values are: "true" and "false".'
      name: allow_guests_create_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      description: 'Whether guests can delete channels. Possible values are: "true" and "false".'
      name: allow_guests_delete_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      description: 'Whether members can add and update private channels. Possible values are: "true" and "false".'
      name: allow_members_create_private_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      description: 'Whether members can add and update channels. Possible values are: "true" and "false".'
      name: allow_members_create_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      description: 'Whether members can delete channels. Possible values are: "true" and "false".'
      name: allow_members_delete_channels
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      description: 'Whether members can add and remove apps. Possible values are: "true" and "false".'
      name: allow_members_add_remove_apps
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      description: 'Whether members can add, update, and remove tabs. Possible values are: "true" and "false".'
      name: allow_members_add_remove_tabs
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      description: 'Whether members can add, update, and remove connectors. Possible values are: "true" and "false".'
      name: allow_members_add_remove_connectors
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      description: 'Whether users can edit their messages. Possible values are: "true" and "false".'
      name: allow_user_edit_messages
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      description: 'Whether users can delete their messages. Possible values are: "true" and "false".'
      name: allow_user_delete_messages
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      description: 'Whether owners can delete any message. Possible values are: "true" and "false".'
      name: allow_owner_delete_messages
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      description: 'Whether @team mentions are allowed. Possible values are: "true" and "false".'
      name: allow_team_mentions
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      description: 'Whether @channel mentions are allowed. Possible values are: "true" and "false".'
      name: allow_channel_mentions
      predefined:
      - 'false'
      - 'true'
    description: Update the properties of the specified team.
    name: microsoft-teams-team-update
  - arguments:
    - description: ID of the team to delete. Can be retrieved by running the microsoft-teams-teams-list command.
      name: team_id
      required: true
    description: 'Deletes a group. Note: it might take time for the team to disappear from the teams list.'
    name: microsoft-teams-team-delete
  - arguments:
    - description: ID of team to get. Can be retrieved by running the microsoft-teams-teams-list command.
      name: team_id
      required: true
    description: Retrieve the properties and relationships of the specified team.
    name: microsoft-teams-team-get
    outputs:
    - contextPath: MicrosoftTeams.Team.createdDateTime
      description: 'Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: ''2014-01-01T00:00:00Z''.'
      type: Date
    - contextPath: MicrosoftTeams.Team.classification
      description: Typically describes the data or business sensitivity of the team.
      type: String
    - contextPath: MicrosoftTeams.Team.isArchived
      description: Whether this team is in read-only mode.
      type: Boolean
    - contextPath: MicrosoftTeams.Team.displayName
      description: The display name for the group.
      type: String
    - contextPath: MicrosoftTeams.Team.visibility
      description: 'Specifies the visibility of a Microsoft 365 group. Possible values are: Private, Public, or Hiddenmembership; blank values are treated as public.'
      type: String
    - contextPath: MicrosoftTeams.Team.id
      description: The unique identifier for the group.
      type: String
    - contextPath: MicrosoftTeams.Team.description
      description: An optional description for the group.
      type: String
  - arguments:
    - description: ID of the team to get the member of. Can be retrieved by running the microsoft-teams-teams-list command.
      name: team_id
      required: true
    description: Returns the members of the specified team.
    name: microsoft-teams-members-list
    outputs:
    - contextPath: MicrosoftTeams.TeamMember.teamId
      description: The unique identifier for the group.
      type: String
    - contextPath: MicrosoftTeams.TeamMember.displayName
      description: The display name of the user.
      type: String
    - contextPath: MicrosoftTeams.TeamMember.email
      description: The email of the user.
      type: String
    - contextPath: MicrosoftTeams.TeamMember.id
      description: Unique ID of the user.
      type: String
    - contextPath: MicrosoftTeams.TeamMember.roles
      description: The roles for that user.
      type: String
  - arguments:
    - description: ID of member to get. Can be retrieved by running the microsoft-teams-members-list command.
      name: membership_id
      required: true
    - description: ID of the team to get the member of. Can be retrieved by running the microsoft-teams-teams-list command.
      name: team_id
      required: true
    description: Gets a member of a team.
    name: microsoft-teams-member-get
    outputs:
    - contextPath: MicrosoftTeams.TeamMember.teamId
      description: The unique identifier for the group.
      type: String
    - contextPath: MicrosoftTeams.TeamMember.displayName
      description: The display name of the user.
      type: String
    - contextPath: MicrosoftTeams.TeamMember.email
      description: The email of the user.
      type: String
    - contextPath: MicrosoftTeams.TeamMember.id
      description: Unique ID of the user.
      type: String
    - contextPath: MicrosoftTeams.TeamMember.roles
      description: The roles for that user.
      type: String
  - arguments:
    - description: ID of the team to add the user to. Can be retrieved by running the microsoft-teams-teams-list command.
      name: team_id
      required: true
    - description: Email address or ID of the user to add to the team. The ID can be retrieved by running the microsoft-teams-members-list command.
      name: user_id
      required: true
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether to add the member with the owner role. Possible values are: "false" and "true".'
      name: is_owner
      predefined:
      - 'false'
      - 'true'
    description: Add a user to be a team member.
    name: microsoft-teams-member-add
    outputs:
    - contextPath: MicrosoftTeams.TeamMember.displayName
      description: The display name of the user.
      type: String
    - contextPath: MicrosoftTeams.TeamMember.email
      description: The email of the user.
      type: String
    - contextPath: MicrosoftTeams.TeamMember.id
      description: Unique ID of the user.
      type: String
    - contextPath: MicrosoftTeams.TeamMember.roles
      description: The roles for that user.
      type: String
  - arguments:
    - description: ID of the team to remove the user from. Can be retrieved by running the microsoft-teams-teams-list command.
      name: team_id
      required: true
    - description: ID of the member to remove from the team. Can be retrieved by running the microsoft-teams-members-list command.
      name: membership_id
      required: true
    description: Remove a member from the team.
    name: microsoft-teams-member-remove
  - arguments:
    - description: ID of the team to update the member in. Can be retrieved by running the microsoft-teams-teams-list command.
      name: team_id
      required: true
    - description: ID of the team member to update. Can be retrieved by running the microsoft-teams-members-list command.
      name: membership_id
      required: true
    - auto: PREDEFINED
      defaultValue: 'false'
      description: 'Whether to set the member with the owner role. Possible values are: "false" and "true".'
      name: is_owner
      predefined:
      - 'false'
      - 'true'
    description: Updates a team member.
    name: microsoft-teams-member-update
    outputs:
    - contextPath: MicrosoftTeams.TeamMember.displayName
      description: The display name of the user.
      type: String
    - contextPath: MicrosoftTeams.TeamMember.email
      description: The email of the user.
      type: String
    - contextPath: MicrosoftTeams.TeamMember.id
      description: Unique ID of the user.
      type: String
    - contextPath: MicrosoftTeams.TeamMember.roles
      description: The roles for that user.
      type: String
  - arguments:
    - description: ID of the team to archive. Can be retrieved by running the microsoft-teams-teams-list command.
      name: team_id
      required: true
    description: Archive the specified team. When a team is archived, users can no longer send or like messages on any channel in the team, edit the team's name, description, or other settings, or in general make most changes to the team. Membership changes to the team continue to be allowed. Archiving is an async operation. A team is archived once the async operation completes successfully, which may occur subsequent to a response from this command. In order to archive a team, the team and group must have an owner.
    name: microsoft-teams-team-archive
  - arguments:
    - description: ID of the team to unarchive. Can be retrieved by running the microsoft-teams-teams-list command.
      name: team_id
      required: true
    description: Restore an archived team. This restores the users' ability to send messages and edit the team, abiding by tenant and team settings. Unarchiving is an async operation. A team is unarchived once the async operation completes successfully, which may occur subsequent to a response from this command.
    name: microsoft-teams-team-unarchive
  - arguments:
    - description: ID of the team to clone. Can be retrieved by running the microsoft-teams-teams-list command.
      name: team_id
      required: true
    - description: The name of the team.
      name: display_name
      required: true
    - description: Description of the team.
      name: description
    - auto: PREDEFINED
      defaultValue: public
      description: 'The visibility of the group and team. Possible values are: "public" and "private".'
      name: visibility
      predefined:
      - public
      - private
    - auto: PREDEFINED
      defaultValue: 'true'
      description: 'Whether to copy Microsoft Teams apps that are installed in the team. Possible values are: "false" and "true".'
      name: clone_apps
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'true'
      description: 'Whether to copy the tabs within channels. Possible values are: "false" and "true".'
      name: clone_tabs
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'true'
      description: 'Whether to copy all settings within the team, along with key group settings. Possible values are: "false" and "true".'
      name: clone_settings
      predefined:
      - 'false'
      - 'true'
    - auto: PREDEFINED
      defaultValue: 'true'
      description: 'Whether to copy the channel structure (but not the messages in the channel). Possible values are: "false" and "true".'
      name: clone_channels
      predefined:
      - 'false'
      - 'true'
    description: Create a copy of a team. This operation also creates a copy of the corresponding group. Cloning is a long-running operation.
    name: microsoft-teams-team-clone
  - arguments:
    - description: ID of the user (e.g., 2827c1e7-edb6-4529-b50d-25984e968637). Can be retrieved by running the msgraph-user-list command.
      name: user_id
      required: true
    description: Get the teams in Microsoft Teams that the user is a direct member of.
    name: microsoft-teams-teams-list-joined
    outputs:
    - contextPath: MicrosoftTeams.Team.createdDateTime
      description: 'Timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: ''2014-01-01T00:00:00Z''.'
      type: Date
    - contextPath: MicrosoftTeams.Team.classification
      description: Typically describes the data or business sensitivity of the team.
      type: String
    - contextPath: MicrosoftTeams.Team.isArchived
      description: Whether this team is in read-only mode.
      type: Boolean
    - contextPath: MicrosoftTeams.Team.displayName
      description: The display name for the group.
      type: String
    - contextPath: MicrosoftTeams.Team.visibility
      description: 'Specifies the visibility of a Microsoft 365 group. Possible values are: Private, Public, or Hiddenmembership; blank values are treated as public.'
      type: String
    - contextPath: MicrosoftTeams.Team.id
      description: The unique identifier for the group.
      type: String
    - contextPath: MicrosoftTeams.Team.description
      description: An optional description for the group.
      type: String
  dockerimage: demisto/crypto:1.0.0.10120494
  runonce: false
  script: '-'
  subtype: python3
  type: python
tests:
- "Microsoft Teams - Test"
- "Microsoft Teams Management - Test"
fromversion: 5.0.0