@managed-api/microsoft-graph-v1-sr-connect

ScriptRunner Connect Managed API for Microsoft Graph

Managed API for Microsoft Graph is an API Client for Microsoft Graph by Adaptavist. You can read more about Managed APIs here.

This is ScriptRunner Connect runtime specific version of the Managed API (with sr-connect suffix). If you want to use Managed API in any other runtime, have a look at the runtime agnostic version.

Supported API calls

• fetch
• Groups
  • getGroups
• Teams
  • Messaging
    • Channel
      • addMember
      • createChannel
      • deleteChannel
      • getChannel
      • getChannels
      • getMembers
      • getMessage
      • getMessageReplies
      • getMessages
      • removeMember
      • replyToMessage
      • sendMessage
      • updateChannel
      • updateMessage
    • Chat
      • addMember
      • createChat
      • getChat
      • getChats
      • getMember
      • getMembers
      • getMessage
      • getMessages
      • removeMember
      • sendMessage
      • updateChat
      • updateMessage
  • Team
    • addMember
    • createTeam
    • deleteTeam
    • getMember
    • getMembers
    • getMyTeams
    • getTeam
    • getUserAssociatedTeams
    • getUserTeams
    • removeMember
    • updateMember
    • updateTeam
• Users
  • createUser
  • deleteUser
  • getMyUser
  • getUser
  • getUsers
  • updateUser

Constructing Managed API

In ScriptRunner Connect a Managed API is constructed for you, but if you need to construct it manually, here's how you can do it:

import { MicrosoftGraphApi } from '@managed-api/microsoft-graph-v1-sr-connect';

export default async function() {
    const api = new MicrosoftGraphApi('API_CONNECTION_ID');
}

Contact

Feel free to drop ideas, suggestions or improvements into our Slack community channel.

Changelog

2.0.0

• Breaking change: URL and query string parameters are now URL encoded, meaning if you encoded them explicitly before you have to remove your own encoding, otherwise they will get double encoded.

0.2.0

Added support for the following Users methods:

• List users that can be used as Users.getUsers or All.getUsers.
• Create user that can be used as Users.createUser or All.createUser.
• Get user that can be used as Users.getUser or All.getUser.
• Get user that can be used as Users.getMyUser or All.getMyUser.
• Update user that can be used as Users.updateUser or All.updateUser.
• Delete a user that can be used as Users.deleteUser or All.deleteUser.

Added support for the following Teams.Team methods:

• Create team that can be used as Teams.Team.createTeam or All.createTeamsTeam.
• Get team that can be used as Teams.Team.getTeam or All.getTeamsTeam.
• Update team that can be used as Teams.Team.updateTeam or All.updateTeamsTeam.
• Delete group that can be used as Teams.Team.deleteTeam or All.deleteTeamsTeam.
• List members of team that can be used as Teams.Team.getMembers or All.getTeamsTeamMembers.
• Add member to team that can be used as Teams.Team.addMember or All.addTeamsTeamMember.
• Get member of team that can be used as Teams.Team.getMember or All.getTeamsTeamMember.
• Remove member from team that can be used as Teams.Team.removeMember or All.removeTeamsTeamMember.
• Update member in team that can be used as Teams.Team.updateMember or All.updateTeamsTeamMember.
• List joinedTeams that can be used as Teams.Team.getMyTeams or All.getMyTeams.
• List joinedTeams that can be used as Teams.Team.getUserTeams or All.getUserTeams.
• List associatedTeamInfo that can be used as Teams.Team.getUserAssociatedTeams or All.getUserAssociatedTeams.
• List all teams in Microsoft Teams for an organization that can be used as Groups.getGroups or All.getGroups.

Added support for the following Teams.Messaging.Channel methods:

• List channels that can be used as Teams.Messaging.Channel.getChannels or All.getTeamsChannels.
• Create channel that can be used as Teams.Messaging.Channel.createChannel or All.createTeamsChannel.
• Get channel that can be used as Teams.Messaging.Channel.getChannel or All.getTeamsChannel.
• Patch channel that can be used as Teams.Messaging.Channel.updateChannel or All.updateTeamsChannel.
• Delete channel that can be used as Teams.Messaging.Channel.deleteChannel or All.deleteTeamsChannel.
• List members of a channel that can be used as Teams.Messaging.Channel.getMembers or All.getTeamsChannelMembers.
• Add member to channel that can be used as Teams.Messaging.Channel.addMember or All.addMemberToTeamsChannel.
• Remove member from channel that can be used as Teams.Messaging.Channel.removeMember or All.removeMemberFromTeamsChannel.
• List channel messages that can be used as Teams.Messaging.Channel.getMessages or All.getTeamsChannelMessages.
• Send chatMessage in channel that can be used as Teams.Messaging.Channel.sendMessage or All.sendTeamsChannelMessage.
• Get chatMessage in a channel or chat that can be used as Teams.Messaging.Channel.getMessage or All.getTeamsChannelMessage.
• Update chatMessage that can be used as Teams.Messaging.Channel.updateMessage or All.updateTeamsChannelMessage.
• List replies that can be used as Teams.Messaging.Channel.getMessageReplies or All.getTeamsChannelMessageReplies.
• Send replies to a message in a channel that can be used as Teams.Messaging.Channel.replyToMessage or All.replyToTeamsChannelMessage.

Added support for the following Teams.Messaging.Chat methods:

• List chats that can be used as Teams.Messaging.Chat.getChats or All.getTeamsChats.
• Create chat that can be used as Teams.Messaging.Chat.createChat or All.createTeamsChat.
• Get chat that can be used as Teams.Messaging.Chat.getChat or All.getTeamsChat.
• Update chat that can be used as Teams.Messaging.Chat.updateChat or All.updateTeamsChat.
• List members of a chat that can be used as Teams.Messaging.Chat.getMembers or All.getTeamsChatMembers.
• Add member to a chat that can be used as Teams.Messaging.Chat.addMember or All.addMemberToTeamsChat.
• Get conversationMember in a chat that can be used as Teams.Messaging.Chat.getMember or All.getTeamsChatMember.
• Remove member from chat that can be used as Teams.Messaging.Chat.removeMember or All.removeTeamsChatMember.
• List messages in a chat that can be used as Teams.Messaging.Chat.getMessages or All.getTeamsChatMessages.
• Send message in a chat that can be used as Teams.Messaging.Chat.sendMessage or All.sendTeamsChatMessage.
• Get chatMessage in a channel or chat that can be used as Teams.Messaging.Chat.getMessage or All.getTeamsChatMessage.
• Update chatMessage that can be used as Teams.Messaging.Chat.updateMessage or All.updateTeamsChatMessage.

Copyright Adaptavist 2024 (c) All rights reserved