Microsoft Teams
96 min
the microsoft teams connector allows for the automation of team communication and collaboration tasks, facilitating efficient incident response and management within the swimlane platform microsoft teams is a widely used communication platform that enables collaboration through chat, meetings, and file sharing the microsoft teams connector for swimlane turbine allows users to automate key communication tasks within their security workflows by integrating with microsoft teams, swimlane turbine users can streamline incident response, coordinate team actions, and share critical information directly within the teams environment, enhancing the overall efficiency and response time of security operations prerequisites to utilize the microsoft teams connector for swimlane turbine, ensure you have the following prerequisites oauth 2 0 client credentials authentication with these parameters url endpoint for microsoft teams api access client id application (client) id registered in azure ad client secret secret generated for the registered application token url url to obtain the oauth2 token scopes permissions required for the connector to interact with microsoft teams oauth 2 0 password credentials authentication with these parameters url endpoint for microsoft teams api access oauth2 username username for oauth2 authentication oauth2 password password for oauth2 authentication token url url to obtain the oauth2 token client id application (client) id registered in azure ad scopes permissions required for the connector to interact with microsoft teams oauth 2 0 refresh token authentication with these parameters url endpoint for microsoft teams api access and so on capabilities in order to use actions within this connector you need to ensure you have created a microsoft teams team , you can use the create team action the microsoft teams integration provides the following capabilities using the microsoft graph api add member to channel add member to team create channel create chat create team get channel filesfolder get chat by id get one on one chat for user list channel messages list chats list chats by user id list messages in a chat list pinnedchatmessages in a chat pin a message in a chat reply channel message and so on additional information about graph api features certain actions within microsoft teams and the microsoft graph api are considered https //docs microsoft com/en us/graph/teams protected apis you can request access https //docs microsoft com/en us/graph/teams protected apis to use oauth2's delegated authentication webhook considerations in order to post messages to a channel in microsoft teams you must https //sankalpit com/how to get channel webhook url/ first you will use the url when creating the asset for the action microsoft graph considerations in order to use most actions within this connector, you must define the appropriate scopes for the action you are using below are a list of the action and their required scopes when registering an application in microsoft azure delegated permissions per task add members to a channel channelmember readwrite all add members to a team teammember readwrite all create channel channel create channel create group directory readwrite all group readwrite all teamwork migrate all create team directory readwrite all group readwrite all team create teamwork migrate all and so on asset setup microsoft graph setup steps to create the azure app go to the https //portal azure com/#blade/microsoft aad registeredapps/applicationslistblade in the azure portal click new registration enter a name for your new application and choose accounts in this organizational directory only , then click register at the bottom navigate to the api permissions tab on the left navigation menu select add a permission select microsoft graph select application permissions or delegated permissions , then mark all the permissions you need for the actions you are using (see suggested permissions at the top of the asset setup section) click the add permissions button at the bottom of the page select grant admin consent for your organization, then your permissions should look as below navigate to the certificates & secrets tab and select new client secret fill out the description and expiration, then click the add button at the bottom the value of the secret you just created is the client secret needed for the swimlane asset 14\ navigate to the overview tab on the left menu 15\ the client id and tenant id needed in the asset are shown on this page authentication the connector can be authenticated in one of two ways oauth 2 0 resource owner password credentials, which require a username , password , token url and client id for more information, click https //learn microsoft com/en us/azure/active directory/develop/v2 oauth ropc oauth 2 0 client credentials flow, which requires a client id , client secret and token url for more information, click https //learn microsoft com/en us/azure/active directory/develop/v2 oauth2 client creds grant flow oauth 2 0 refresh token grant, which requires a 'refresh token', 'tenant id', 'client id' and 'client secret' use this auth with accounts which have mfa enabled to generate a refresh token please follow the instructions below in step 3 of the above mentioned setup instructions, please provide a 'redirect uri' and select the platform as 'web', before clicking on 'register' at the the bottom proceed with the remaining steps to generate 'client id', 'tenant id' and 'client secret' the swimlane team will provide a python script and instructions on how to use the script to generate the refresh token notes for the refresh token auth, the generated refresh token will have 90 days as the default expiry value unless it is reduced by your organization you need to update the asset after the refresh token expires https //github com/rveachkc/pymsteams https //docs microsoft com/en us/outlook/actionable messages/message card reference https //docs microsoft com/en us/graph/api/resources/teams api overview?view=graph rest 1 0 this connector was last tested against product version microsoft graph v1 endpoints configurations ms teams client credentials authenticates using oauth 2 0 client credentials configuration parameters parameter description type required url a url to the target host string required token url string required client id the client id string required client secret the client secret string required scope permission scopes for this action array required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional ms teams password grant authenticates using oauth 2 0 password credentials configuration parameters parameter description type required url a url to the target host string required token url string required oauth2 username the username for authentication string required oauth2 password the password for authentication string required client id the client id string required client secret the client secret string optional scope permission scopes for this action array required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional ms teams refresh token grant authenticates using refresh token use this authentication for accounts with mfa enabled configuration parameters parameter description type required url a url to the target host string required tenant id string required cl id the client id string required cl secret the client secret string required refresh token refresh token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions add member to channel adds a new member to a private or shared microsoft teams channel, requiring team and channel ids, roles, and user binding endpoint url v1 0/teams/{{team id}}/channels/{{channel id}}/members method post input argument name type required description path parameters team id string required parameters for the add member to channel action path parameters channel id string required parameters for the add member to channel action @odata type string optional response data roles array optional parameter for add member to channel user\@odata bind string optional response data input example {"json body" {"@odata type" "#microsoft graph aaduserconversationmember","roles" \["owner"],"user\@odata bind" "https //graph microsoft com/v1 0/users('3987e15d f439 44e5 aa80 590fe116c266')"},"path parameters" {"team id" "2c435237 2587 4d26 a318 fc8537094d7b","channel id" "19 4190e9262a1441598f7d57bfef754612\@thread tacv2"}} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data @odata type string response data id string unique identifier roles array output field roles displayname string name of the resource visiblehistorystartdatetime string time value userid string unique identifier email object output field email tenantid string unique identifier output example {"status code" 201,"response headers" {"transfer encoding" "chunked","content type" "application/json;odata metadata=minimal;odata streaming=true;ieee754compatible=f ","content encoding" "gzip","location" "https //teamsgraph teams microsoft com/v1 0/teams('2c435237 2587 4d26 a318 fc853 ","vary" "accept encoding","strict transport security" "max age=31536000","request id" "b60b398a aa14 41a6 a2db e05e5230ad4e","client request id" "b60b398a aa14 41a6 a2db e05e5230ad4e","x ms ags diagnostic" "{ create channel creates a new channel within a specified team in microsoft teams, requiring the team's id as a path parameter endpoint url v1 0/teams/{{team id}}/channels method post input argument name type required description path parameters team id string required parameters for the create channel action displayname string optional name of the resource description string optional parameter for create channel membershiptype string optional type of the resource @odata type string optional response data members array optional parameter for create channel members \@odata type string optional response data members user\@odata bind string optional response data members roles array optional parameter for create channel @microsoft graph channelcreationmode string optional parameter for create channel createddatetime string optional time value input example {"json body" {"displayname" "architecture discussion","description" "this channel is where we debate all future architecture plans","membershiptype" "standard","@odata type" "#microsoft graph channel","members" \[{"@odata type" "#microsoft graph aaduserconversationmember","user\@odata bind" "https //graph microsoft com/v1 0/users('62855810 484b 4823 9e01 60667f8b12ae')","roles" \["owner"]}],"@microsoft graph channelcreationmode" "migration","createddatetime" "2020 03 14t11 22 17 067z"},"path parameters" {"team id" "2c435237 2587 4d26 a318 fc8537094d7b"}} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data id string unique identifier createddatetime string time value displayname string name of the resource description string output field description isfavoritebydefault boolean output field isfavoritebydefault email string output field email weburl string url endpoint for the request membershiptype string type of the resource output example {"status code" 201,"response headers" {"transfer encoding" "chunked","content type" "application/json;odata metadata=minimal;odata streaming=true;ieee754compatible=f ","content encoding" "gzip","location" "https //teamsgraph teams microsoft com/v1 0/teams('2c435237 2587 4d26 a318 fc853 ","vary" "accept encoding","strict transport security" "max age=31536000","request id" "956b7f1f cbe3 4478 bb64 d983f244a469","client request id" "956b7f1f cbe3 4478 bb64 d983f244a469","x ms ags diagnostic" "{ get channel filesfolder retrieve metadata for the storage location of files within a specified microsoft teams channel, requiring team and channel ids endpoint url v1 0/teams/{{team id}}/channels/{{channel id}}/filesfolder method get input argument name type required description path parameters team id string required parameters for the get channel filesfolder action path parameters channel id string required parameters for the get channel filesfolder action input example {"path parameters" {"team id" "2c435237 2587 4d26 a318 fc8537094d7b","channel id" "19 4190e9262a1441598f7d57bfef754612\@thread tacv2"}} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data id string unique identifier createddatetime string time value lastmodifieddatetime string time value name string name of the resource weburl string url endpoint for the request size number output field size parentreference object output field parentreference parentreference driveid string unique identifier parentreference drivetype string type of the resource filesysteminfo object output field filesysteminfo filesysteminfo createddatetime string time value filesysteminfo lastmodifieddatetime string time value folder object output field folder folder childcount number count value output example {"status code" 200,"response headers" {"transfer encoding" "chunked","content type" "application/json;odata metadata=minimal;odata streaming=true;ieee754compatible=f ","content encoding" "gzip","vary" "accept encoding","strict transport security" "max age=31536000","request id" "95c5fefe 5c82 4364 b3d4 fa3223d4b5fb","client request id" "95c5fefe 5c82 4364 b3d4 fa3223d4b5fb","x ms ags diagnostic" "{\\"serverinfo\\" {\\"datacenter\\" \\"south central us\\",\\"slice\\" \\"e\\",\\"ring\\" \\"5\\",\\"scaleunit list channel messages retrieve messages from a specified microsoft teams channel, excluding replies requires 'team id' and 'channel id' endpoint url v1 0/teams/{{team id}}/channels/{{channel id}}/messages method get input argument name type required description path parameters team id string required parameters for the list channel messages action path parameters channel id string required parameters for the list channel messages action parameters $top number optional parameters for the list channel messages action parameters $expand number optional parameters for the list channel messages action input example {"parameters" {"$top" 20,"$expand" 1000},"path parameters" {"team id" "2c435237 2587 4d26 a318 fc8537094d7b","channel id" "19 4190e9262a1441598f7d57bfef754612\@thread tacv2"}} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data @odata count number response data @odata nextlink string response data value array value for the parameter value id string unique identifier value replytoid object unique identifier value etag string value for the parameter value messagetype string type of the resource value createddatetime string value for the parameter value lastmodifieddatetime string value for the parameter value lastediteddatetime object value for the parameter value deleteddatetime object value for the parameter value subject object value for the parameter value summary object value for the parameter value chatid object unique identifier value importance string value for the parameter value locale string value for the parameter value weburl string url endpoint for the request value policyviolation object value for the parameter value eventdetail object value for the parameter value eventdetail \@odata type string response data value eventdetail teamid string unique identifier value eventdetail teamdescription string value for the parameter output example {"status code" 200,"response headers" {"transfer encoding" "chunked","content type" "application/json;odata metadata=minimal;odata streaming=true;ieee754compatible=f ","content encoding" "gzip","location" "https //teamsgraph teams microsoft com/v1 0/teams('2c435237 2587 4d26 a318 fc853 ","vary" "accept encoding","strict transport security" "max age=31536000","request id" "956b7f1f cbe3 4478 bb64 d983f244a469","client request id" "956b7f1f cbe3 4478 bb64 d983f244a469","x ms ags diagnostic" "{ reply channel message send a reply to a specific message within a microsoft teams channel, requiring the team id, channel id, message id, and message body endpoint url v1 0/teams/{{team id}}/channels/{{channel id}}/messages/{{message id}}/replies method post input argument name type required description path parameters team id string required parameters for the reply channel message action path parameters channel id string required parameters for the reply channel message action path parameters message id string required parameters for the reply channel message action attachments array optional parameter for reply channel message attachments content string optional response content attachments contenttype string optional type of the resource attachments contenturl string optional url endpoint for the request attachments id string optional unique identifier attachments name string optional name of the resource attachments teamsappid string optional unique identifier attachments thumbnailurl string optional url endpoint for the request body object optional request body data body content string required request body data body contenttype string optional request body data channelidentity object optional unique identifier channelidentity channelid string optional unique identifier channelidentity teamid string optional unique identifier chatid string optional unique identifier createddatetime string optional time value deleteddatetime string optional time value etag string optional parameter for reply channel message from object optional parameter for reply channel message from application object optional parameter for reply channel message from device object optional parameter for reply channel message from conversation object optional parameter for reply channel message input example {"path parameters" {"team id" "string","channel id" "string","message id" "string"},"attachments" \[{"content" "string","contenttype" "string","contenturl" "string","id" "12345678 1234 1234 1234 123456789abc","name" "example name","teamsappid" "string","thumbnailurl" "string"}],"body" {"content" "string","contenttype" "string"},"channelidentity" {"channelid" "string","teamid" "string"},"chatid" "string","createddatetime" "string","deleteddatetime" "string","etag" "string","from" {"application" {},"device" {},"conversation" {},"user" {"id" "12345678 1234 1234 1234 123456789abc","displayname" "example name","useridentitytype" "string"}},"id" "12345678 1234 1234 1234 123456789abc","importance" "string","lastediteddatetime" "string","lastmodifieddatetime" "string","locale" "string","messagetype" "string","replytoid" "string","subject" "string","summary" "string","weburl" "string"} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data id string unique identifier replytoid string unique identifier etag string output field etag messagetype string type of the resource createddatetime string time value lastmodifieddatetime string time value lastediteddatetime object time value deleteddatetime object time value subject object output field subject summary object output field summary chatid object unique identifier importance string output field importance locale string output field locale weburl string url endpoint for the request policyviolation object output field policyviolation eventdetail object output field eventdetail from object output field from from application object output field from application from device object output field from device from user object output field from user from user id string unique identifier from user displayname string name of the resource output example {"status code" 201,"response headers" {"transfer encoding" "chunked","content type" "application/json;odata metadata=minimal;odata streaming=true;ieee754compatible=f ","content encoding" "gzip","location" "https //teamsgraph teams microsoft com/v1 0/teams('2c435237 2587 4d26 a318 fc853 ","vary" "accept encoding","strict transport security" "max age=31536000","request id" "3bd868dd 1843 45b0 b08b 516f1ef2e8df","client request id" "3bd868dd 1843 45b0 b08b 516f1ef2e8df","x ms ags diagnostic" "{ send message to channel sends a new chatmessage to a specified channel in microsoft teams, requiring the 'channel id' and 'team id' endpoint url v1 0/teams/{{team id}}/channels/{{channel id}}/messages method post input argument name type required description path parameters channel id string required parameters for the send message to channel action path parameters team id string required parameters for the send message to channel action attachments array optional parameter for send message to channel attachments content string optional response content attachments contenttype string optional type of the resource attachments contenturl string optional url endpoint for the request attachments id string optional unique identifier attachments name string optional name of the resource attachments teamsappid string optional unique identifier attachments thumbnailurl string optional url endpoint for the request body object optional request body data body content string required request body data body contenttype string optional request body data channelidentity object optional unique identifier channelidentity channelid string optional unique identifier channelidentity teamid string optional unique identifier chatid string optional unique identifier createddatetime string optional time value deleteddatetime string optional time value etag string optional parameter for send message to channel from object optional parameter for send message to channel from application object optional parameter for send message to channel from device object optional parameter for send message to channel from conversation object optional parameter for send message to channel from user object optional parameter for send message to channel input example {"path parameters" {"channel id" "string","team id" "string"},"attachments" \[{"content" "string","contenttype" "string","contenturl" "string","id" "12345678 1234 1234 1234 123456789abc","name" "example name","teamsappid" "string","thumbnailurl" "string"}],"body" {"content" "string","contenttype" "string"},"channelidentity" {"channelid" "string","teamid" "string"},"chatid" "string","createddatetime" "string","deleteddatetime" "string","etag" "string","from" {"application" {},"device" {},"conversation" {},"user" {"id" "12345678 1234 1234 1234 123456789abc","displayname" "example name","useridentitytype" "string"}},"id" "12345678 1234 1234 1234 123456789abc","importance" "string","lastediteddatetime" "string","lastmodifieddatetime" "string","locale" "string","messagetype" "string","replytoid" "string","subject" "string","summary" "string","weburl" "string"} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data id string unique identifier replytoid object unique identifier etag string output field etag messagetype string type of the resource createddatetime string time value lastmodifieddatetime string time value lastediteddatetime object time value deleteddatetime object time value subject object output field subject summary object output field summary chatid object unique identifier importance string output field importance locale string output field locale weburl string url endpoint for the request policyviolation object output field policyviolation eventdetail object output field eventdetail from object output field from from application object output field from application from device object output field from device from user object output field from user from user id string unique identifier from user displayname string name of the resource output example {"status code" 201,"response headers" {"transfer encoding" "chunked","content type" "application/json;odata metadata=minimal;odata streaming=true;ieee754compatible=f ","content encoding" "gzip","location" "https //teamsgraph teams microsoft com/v1 0/teams('2c435237 2587 4d26 a318 fc853 ","vary" "accept encoding","strict transport security" "max age=31536000","request id" "c5d3a593 789e 4fb9 93b6 00ab6fca5b6d","client request id" "c5d3a593 789e 4fb9 93b6 00ab6fca5b6d","x ms ags diagnostic" "{ create chat initiates a new chat in microsoft teams with specified members and chat type requires 'chattype' and 'members' in the json body endpoint url v1 0/chats method post input argument name type required description chattype string optional type of the resource members array optional parameter for create chat members \@odata type string optional response data members roles array optional parameter for create chat members user\@odata bind string optional response data input example {"json body" {"chattype" "oneonone","members" \[{"@odata type" "#microsoft graph aaduserconversationmember","roles" \["owner"],"user\@odata bind" "https //graph microsoft com/v1 0/users('3987e15d f439 44e5 aa80 590fe116c266')"},{"@odata type" "#microsoft graph aaduserconversationmember","roles" \["owner"],"user\@odata bind" "https //graph microsoft com/v1 0/users('2b77f477 3a9f 4823 a882 6fb6cae8c7f9')"}]}} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data id string unique identifier topic object output field topic createddatetime string time value lastupdateddatetime string time value chattype string type of the resource weburl string url endpoint for the request tenantid string unique identifier viewpoint object output field viewpoint onlinemeetinginfo object output field onlinemeetinginfo output example {"status code" 201,"response headers" {"transfer encoding" "chunked","content type" "application/json;odata metadata=minimal;odata streaming=true;ieee754compatible=f ","content encoding" "gzip","location" "https //graph microsoft com","vary" "accept encoding","strict transport security" "max age=31536000","request id" "87834acd 0fba 48de 81f9 82f4db05f650","client request id" "87834acd 0fba 48de 81f9 82f4db05f650","x ms ags diagnostic" "{\\"serverinfo\\" {\\"datacenter\\" \\"south central us\\",\\"sl send message to chat sends a new chat message to a specified microsoft teams chat using the 'chat id' and message 'body' endpoint url v1 0/chats/{{chat id}}/messages method post input argument name type required description path parameters chat id string required parameters for the send message to chat action attachments array optional parameter for send message to chat attachments content string optional response content attachments contenttype string optional type of the resource attachments contenturl string optional url endpoint for the request attachments id string optional unique identifier attachments name string optional name of the resource attachments teamsappid string optional unique identifier attachments thumbnailurl string optional url endpoint for the request body object optional request body data body content string required request body data body contenttype string optional request body data channelidentity object optional unique identifier channelidentity channelid string optional unique identifier channelidentity teamid string optional unique identifier chatid string optional unique identifier createddatetime string optional time value deleteddatetime string optional time value etag string optional parameter for send message to chat from object optional parameter for send message to chat from application object optional parameter for send message to chat from device object optional parameter for send message to chat from conversation object optional parameter for send message to chat from user object optional parameter for send message to chat from user id string optional unique identifier input example {"path parameters" {"chat id" "string"},"attachments" \[{"content" "string","contenttype" "string","contenturl" "string","id" "12345678 1234 1234 1234 123456789abc","name" "example name","teamsappid" "string","thumbnailurl" "string"}],"body" {"content" "string","contenttype" "string"},"channelidentity" {"channelid" "string","teamid" "string"},"chatid" "string","createddatetime" "string","deleteddatetime" "string","etag" "string","from" {"application" {},"device" {},"conversation" {},"user" {"id" "12345678 1234 1234 1234 123456789abc","displayname" "example name","useridentitytype" "string"}},"id" "12345678 1234 1234 1234 123456789abc","importance" "string","lastediteddatetime" "string","lastmodifieddatetime" "string","locale" "string","messagetype" "string","replytoid" "string","subject" "string","summary" "string","weburl" "string"} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data id string unique identifier replytoid object unique identifier etag string output field etag messagetype string type of the resource createddatetime string time value lastmodifieddatetime string time value lastediteddatetime object time value deleteddatetime object time value subject object output field subject summary object output field summary chatid string unique identifier importance string output field importance locale string output field locale weburl object url endpoint for the request channelidentity object unique identifier policyviolation object output field policyviolation eventdetail object output field eventdetail from object output field from from application object output field from application from device object output field from device from user object output field from user from user id string unique identifier output example {"status code" 201,"response headers" {"transfer encoding" "chunked","content type" "application/json;odata metadata=minimal;odata streaming=true;ieee754compatible=f ","content encoding" "gzip","location" "https //teamsgraph teams microsoft com/v1 0/chats('19 2b77f477 3a9f 4823 a882 6f ","vary" "accept encoding","strict transport security" "max age=31536000","request id" "1e213b7f a48e 4632 90b6 5ab2d6498b97","client request id" "1e213b7f a48e 4632 90b6 5ab2d6498b97","x ms ags diagnostic" "{ get chat by id retrieve details of a specific chat in microsoft teams using the unique chat id endpoint url v1 0/chats/{{chat id}} method get input argument name type required description path parameters chat id string required parameters for the get chat by id action parameters expand string optional parameters for the get chat by id action input example {"parameters" {"expand" "lastmessagepreview"},"path parameters" {"chat id" "19\ b8577894a63548969c5c92bb9c80c5e1\@thread v2"}} output parameter type description status code number http status code of the response odata version string response data date string date value reason string response reason phrase @odata context string response data id string unique identifier topic string output field topic createddatetime string time value lastupdateddatetime string time value chattype string type of the resource weburl string url endpoint for the request tenantid string unique identifier onlinemeetinginfo object output field onlinemeetinginfo viewpoint object output field viewpoint viewpoint ishidden boolean unique identifier viewpoint lastmessagereaddatetime string response message output example {"status code" 200,"response headers" {"transfer encoding" "chunked","content type" "application/json;odata metadata=minimal;odata streaming=true;ieee754compatible=f ","content encoding" "gzip","location" "https //graph microsoft com","vary" "accept encoding","strict transport security" "max age=31536000","request id" "87834acd 0fba 48de 81f9 82f4db05f650","client request id" "87834acd 0fba 48de 81f9 82f4db05f650","x ms ags diagnostic" {"serverinfo" {}}},"odata version" "4 0","date" "wed, 01 f get one on one chat for user retrieves a specific one on one chat for a user in microsoft teams using the provided user id and chat id endpoint url v1 0/users/{{user id}}/chats/{{chat id}} method get input argument name type required description path parameters user id string required parameters for the get one on one chat for user action path parameters chat id string required parameters for the get one on one chat for user action input example {"path parameters" {"user id" "8b081ef6 4792 4def b2c9 c363a1bf41d5","chat id" "19\ b8577894a63548969c5c92bb9c80c5e1\@thread v2"}} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data id string unique identifier topic object output field topic createddatetime string time value lastupdateddatetime string time value chattype string type of the resource weburl string url endpoint for the request tenantid string unique identifier onlinemeetinginfo object output field onlinemeetinginfo viewpoint object output field viewpoint viewpoint ishidden boolean unique identifier viewpoint lastmessagereaddatetime string response message output example {"status code" 200,"response headers" {"transfer encoding" "chunked","content type" "application/json","content encoding" "gzip","vary" "accept encoding","strict transport security" "max age=31536000","request id" "dce591ab 03d2 4108 9425 3f28f44601ef","client request id" "dce591ab 03d2 4108 9425 3f28f44601ef","x ms ags diagnostic" "{\\"serverinfo\\" {\\"datacenter\\" \\"south india\\",\\"slice\\" \\"e\\",\\"ring\\" \\"2\\",\\"scaleunit\\" \\"00 ","date" "wed, 31 jan 2024 04 46 13 gmt"},"reason" "ok","json bod list chats retrieve a list of chat conversations for the currently logged in user in microsoft teams, available with delegated authentication endpoint url v1 0/chats/ method get input argument name type required description parameters $expand string optional parameters for the list chats action parameters $top number optional parameters for the list chats action parameters $filter string optional parameters for the list chats action parameters $orderby string optional parameters for the list chats action input example {"parameters" {"$expand" "members","$top" 10,"$filter" "string","$orderby" "createddatetime"}} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data @odata count number response data value array value for the parameter value id string unique identifier value topic object value for the parameter value createddatetime string value for the parameter value lastupdateddatetime string value for the parameter value chattype string type of the resource value weburl string url endpoint for the request value tenantid string unique identifier value onlinemeetinginfo object value for the parameter value viewpoint object value for the parameter value viewpoint ishidden boolean unique identifier value viewpoint lastmessagereaddatetime string value for the parameter output example {"status code" 200,"response headers" {"transfer encoding" "chunked","content type" "application/json;odata metadata=minimal;odata streaming=true;ieee754compatible=f ","content encoding" "gzip","vary" "accept encoding","strict transport security" "max age=31536000","request id" "75b62b4f b645 4a6a 9b6f 10330ef25269","client request id" "75b62b4f b645 4a6a 9b6f 10330ef25269","x ms ags diagnostic" "{\\"serverinfo\\" {\\"datacenter\\" \\"south india\\",\\"slice\\" \\"e\\",\\"ring\\" \\"2\\",\\"scaleunit\\" \\"00 list chats by user id retrieve a list of chat conversations associated with a specified microsoft teams user id endpoint url v1 0/users/{{user id}}/chats/ method get input argument name type required description path parameters user id string required parameters for the list chats by user id action parameters $expand string optional parameters for the list chats by user id action parameters $top number optional parameters for the list chats by user id action parameters $filter string optional parameters for the list chats by user id action parameters $orderby string optional parameters for the list chats by user id action input example {"parameters" {"$expand" "members","$top" 10,"$filter" "string","$orderby" "createddatetime"}} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data @odata count number response data value array value for the parameter value id string unique identifier value topic object value for the parameter value createddatetime string value for the parameter value lastupdateddatetime string value for the parameter value chattype string type of the resource value weburl string url endpoint for the request value tenantid string unique identifier value onlinemeetinginfo object value for the parameter value viewpoint object value for the parameter value viewpoint ishidden boolean unique identifier value viewpoint lastmessagereaddatetime string value for the parameter output example {"status code" 200,"response headers" {"transfer encoding" "chunked","content type" "application/json;odata metadata=minimal;odata streaming=true;ieee754compatible=f ","content encoding" "gzip","vary" "accept encoding","strict transport security" "max age=31536000","request id" "90cdf9d9 4e8d 4fec 9556 d3d796378d70","client request id" "90cdf9d9 4e8d 4fec 9556 d3d796378d70","x ms ags diagnostic" "{\\"serverinfo\\" {\\"datacenter\\" \\"south india\\",\\"slice\\" \\"e\\",\\"ring\\" \\"2\\",\\"scaleunit\\" \\"00 list messages in a chat retrieve a list of messages from a specified chat in microsoft teams using the chat id endpoint url /v1 0/chats/{{chat id}}/messages method get input argument name type required description path parameters chat id string required parameters for the list messages in a chat action parameters $top number optional parameters for the list messages in a chat action parameters $orderby string optional parameters for the list messages in a chat action parameters $filter string optional parameters for the list messages in a chat action input example {"parameters" {"top" 5,"orderby" "","filter" "subject eq 'welcome'"},"path parameters" {"chat id" "19 2da4c29f6d7041eca70b638b43d45437\@thread v2"}} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data @odata count number response data @odata nextlink string response data value array value for the parameter value id string unique identifier value replytoid object unique identifier value etag string value for the parameter value messagetype string type of the resource value createddatetime string value for the parameter value lastmodifieddatetime string value for the parameter value lastediteddatetime object value for the parameter value deleteddatetime object value for the parameter value subject object value for the parameter value summary object value for the parameter value chatid string unique identifier value importance string value for the parameter value locale string value for the parameter value weburl object url endpoint for the request value channelidentity object unique identifier value policyviolation object value for the parameter value eventdetail object value for the parameter value from object value for the parameter value from application object value for the parameter output example {"status code" 200,"response headers" {"transfer encoding" "chunked","content type" "application/json;odata metadata=minimal;odata streaming=true;ieee754compatible=f ","content encoding" "gzip","vary" "accept encoding","strict transport security" "max age=31536000","request id" "be6e1664 c548 43c2 af1f db4ab3c2ed16","client request id" "be6e1664 c548 43c2 af1f db4ab3c2ed16","x ms ags diagnostic" "{\\"serverinfo\\" {\\"datacenter\\" \\"south india\\",\\"slice\\" \\"e\\",\\"ring\\" \\"2\\",\\"scaleunit\\" \\"00 list pinnedchatmessages in a chat retrieve all pinned chat messages from a specified microsoft teams chat using the chat id endpoint url /chats/{{chat id}}/pinnedmessages method get input argument name type required description path parameters chat id string required the id of the chat parameters $expand number optional parameters for the list pinnedchatmessages in a chat action input example {"path parameters" {"chat id" "string"},"parameters" {"$expand" 123}} output parameter type description status code number http status code of the response reason string response reason phrase value array value for the parameter value \@odata type string response data value id string unique identifier output example {"status code" 200,"reason" "ok","json body" {"value" \[{},{}]}} pin a message in a chat pins a specified message within an existing microsoft teams chat using the chat's id requires an existing chat id endpoint url /chats/{{chat id}}/pinnedmessages method post input argument name type required description path parameters chat id string required the id of the chat headers object optional headers headers content type string required the content type of the request input example {"path parameters" {"chat id" "string"},"headers" {"content type" "application/json"}} output parameter type description status code number http status code of the response reason string response reason phrase @odata type string response data id string unique identifier output example {"status code" 201,"reason" "created","json body" {"@odata type" "#microsoft graph pinnedchatmessageinfo","id" "1616964509832"}} add member to team adds a new member to a specified microsoft teams team, requiring the team's id and member details such as type, roles, and user binding endpoint url v1 0/teams/{{team id}}/members method post input argument name type required description path parameters team id string required parameters for the add member to team action @odata type string optional response data roles array optional parameter for add member to team user\@odata bind string optional response data input example {"json body" {"@odata type" "#microsoft graph aaduserconversationmember","roles" \["owner"],"user\@odata bind" "https //graph microsoft com/v1 0/users('3987e15d f439 44e5 aa80 590fe116c266')"},"path parameters" {"team id" "2c435237 2587 4d26 a318 fc8537094d7b"}} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data @odata type string response data id string unique identifier roles array output field roles displayname string name of the resource visiblehistorystartdatetime string time value userid string unique identifier email object output field email tenantid string unique identifier output example {"status code" 201,"response headers" {"transfer encoding" "chunked","content type" "application/json;odata metadata=minimal;odata streaming=true;ieee754compatible=f ","content encoding" "gzip","location" "https //teamsgraph teams microsoft com/v1 0/teams('2c435237 2587 4d26 a318 fc853 ","vary" "accept encoding","strict transport security" "max age=31536000","request id" "c8fbe719 da69 45c7 bc1a f6395c5e8d53","client request id" "c8fbe719 da69 45c7 bc1a f6395c5e8d53","x ms ags diagnostic" "{ create team creates a new team in microsoft teams with specified details provided in the json body and headers endpoint url v1 0/teams method post input argument name type required description headers object required http headers for the request headers content type string required http headers for the request template\@odata bind string optional response data displayname string optional name of the resource description string optional parameter for create team members array optional parameter for create team members \@odata type string optional response data members roles array optional parameter for create team members user\@odata bind string optional response data visibility string optional parameter for create team channels array optional parameter for create team channels displayname string optional name of the resource channels isfavoritebydefault boolean optional parameter for create team channels description string optional parameter for create team channels tabs array optional parameter for create team channels tabs teamsapp\@odata bind string optional response data channels tabs displayname string optional name of the resource channels tabs configuration object optional parameter for create team channels tabs configuration contenturl string optional url endpoint for the request channels tabs configuration websiteurl string optional url endpoint for the request membersettings object optional parameter for create team membersettings allowcreateupdatechannels boolean optional parameter for create team membersettings allowdeletechannels boolean optional parameter for create team membersettings allowaddremoveapps boolean optional parameter for create team membersettings allowcreateupdateremovetabs boolean optional parameter for create team input example {"json body" {"template\@odata bind" "https //graph microsoft com/v1 0/teamstemplates('standard')","displayname" "my sample team","description" "my sample team\u2019s description","members" \[{"@odata type" "#microsoft graph aaduserconversationmember","roles" \["owner"],"user\@odata bind" "https //graph microsoft com/v1 0/users('0040b377 61d8 43db 94f5 81374122dc7e')"}],"visibility" "private","channels" \[{"displayname" "announcements \ud83d\udce2","isfavoritebydefault"\ true,"description" "this is a sample announcements channel that is favorited by default use this channel to make important team, product, and service announcements "},{"displayname" "training \ud83c\udfcb\ufe0f","isfavoritebydefault"\ true,"description" "this is a sample training channel, that is favorited by default, and contains an example of pinned website and youtube tabs ","tabs" \[{"teamsapp\@odata bind" "https //graph microsoft com/v1 0/appcatalogs/teamsapps('com microsoft teamspace tab web')","displayname" "a pinned website","configuration" {"contenturl" "https //learn microsoft com/microsoftteams/microsoft teams"}},{"teamsapp\@odata bind" "https //graph microsoft com/v1 0/appcatalogs/teamsapps('com microsoft teamspace tab youtube')","displayname" "a pinned youtube video","configuration" {"contenturl" "https //tabs teams microsoft com/youtube/home/youtubetab?videoid=x8kramdgvcq","websiteurl" "https //www youtube com/watch?v=x8kramdgvcq"}}]},{"displayname" "planning \ud83d\udcc5 ","description" "this is a sample of a channel that is not favorited by default, these channels will appear in the more channels overflow menu ","isfavoritebydefault"\ false},{"displayname" "issues and feedback \ud83d\udc1e","description" "this is a sample of a channel that is not favorited by default, these channels will appear in the more channels overflow menu "}],"membersettings" {"allowcreateupdatechannels"\ true,"allowdeletechannels"\ true,"allowaddremoveapps"\ true,"allowcreateupdateremovetabs"\ true,"allowcreateupdateremoveconnectors"\ true},"guestsettings" {"allowcreateupdatechannels"\ false,"allowdeletechannels"\ false},"funsettings" {"allowgiphy"\ true,"giphycontentrating" "moderate","allowstickersandmemes"\ true,"allowcustommemes"\ true},"messagingsettings" {"allowusereditmessages"\ true,"allowuserdeletemessages"\ true,"allowownerdeletemessages"\ true,"allowteammentions"\ true,"allowchannelmentions"\ true},"discoverysettings" {"showinteamssearchandsuggestions"\ true},"installedapps" \[{"teamsapp\@odata bind" "https //graph microsoft com/v1 0/appcatalogs/teamsapps('com microsoft teamspace tab vsts')"},{"teamsapp\@odata bind" "https //graph microsoft com/v1 0/appcatalogs/teamsapps('1542629c 01b3 4a6d 8f76 1938b779e48d')"}],"group\@odata bind" "https //graph microsoft com/v1 0/groups('71392b2f 1765 406e 86af 5907d9bdb2ab')","@microsoft graph teamcreationmode" "migration","createddatetime" "2020 03 14t11 22 17 067z"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text output example {"status code" 202,"response headers" {"content location" "/teams('454d3685 9ae8 476d 80fd 2d607e5b8d9d')","location" "/teams('454d3685 9ae8 476d 80fd 2d607e5b8d9d')/operations('38613ae4 0012 462c b7 ","strict transport security" "max age=31536000","request id" "a181d619 2cd5 400e a60c fcde238c8af7","client request id" "a181d619 2cd5 400e a60c fcde238c8af7","x ms ags diagnostic" "{\\"serverinfo\\" {\\"datacenter\\" \\"south central us\\",\\"slice\\" \\"e\\",\\"ring\\" \\"5\\",\\"scaleunit ","date" "fri, 27 unpin a message from a chat removes a pinned message from a specified chat in microsoft teams using the chat id and pinnedchatmessageid endpoint url delete /chats/{{chat id}}/pinnedmessages/{{pinnedchatmessageid}} method delete input argument name type required description path parameters chat id string required the id of the chat path parameters pinnedchatmessageid string required the id of the pinned chat message input example {"path parameters" {"chat id" "string","pinnedchatmessageid" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 204,"reason" "no content"} update chat updates the topic of a specified chat in microsoft teams using the chat id and a new topic value endpoint url v1 0/chats/{{chat id}} method patch input argument name type required description path parameters chat id string required parameters for the update chat action topic string optional the title of the chat this can only be set for a chat with a chattype value of group maximum length is 250 characters use of ' ' is not allowed input example {"json body" {"topic" "group chat title update"},"path parameters" {"chat id" "19 1c5b01696d2e4a179c292bc9cf04e63b\@thread v2"}} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data id string unique identifier topic string output field topic createddatetime string time value lastupdateddatetime string time value chattype string type of the resource output example {"status code" 200,"response headers" {"transfer encoding" "chunked","content type" "application/json","content encoding" "gzip","vary" "accept encoding","strict transport security" "max age=31536000","request id" "dce591ab 03d2 4108 9425 3f28f44601ef","client request id" "dce591ab 03d2 4108 9425 3f28f44601ef","x ms ags diagnostic" "{\\"serverinfo\\" {\\"datacenter\\" \\"south india\\",\\"slice\\" \\"e\\",\\"ring\\" \\"2\\",\\"scaleunit\\" \\"00 ","date" "wed, 31 jan 2024 04 46 13 gmt"},"reason" "ok","json bod response headers header description example client request id http response header client request id 75b62b4f b645 4a6a 9b6f 10330ef25269 content encoding http response header content encoding gzip content length the length of the response body in bytes 0 content location http response header content location /teams('454d3685 9ae8 476d 80fd 2d607e5b8d9d') content type the media type of the resource application/json;odata metadata=minimal;odata streaming=true;ieee754compatible=false;charset=utf 8 date the date and time at which the message was originated wed, 01 feb 2023 19 44 08 gmt location the url to redirect a page to https //teamsgraph teams microsoft com/v1 0/teams('2c435237 2587 4d26 a318 fc8537094d7b')/channels('19 85bd7e9fe7ef45b68aaf8ec40b2bc238\@thread tacv2')/messages('1675286007879 ') odata version http response header odata version 4 0 request id http response header request id 75b62b4f b645 4a6a 9b6f 10330ef25269 strict transport security http response header strict transport security max age=31536000 transfer encoding http response header transfer encoding chunked vary http response header vary accept encoding x ms ags diagnostic http response header x ms ags diagnostic {"serverinfo" {"datacenter" "south central us","slice" "e","ring" "5","scaleunit" "001","roleinstance" "sa2pepf000005c2"}}