@managed-api/microsoft-graph-v1-core

v2.0.0

Published

3 months ago

Adaptavist Managed API for Microsoft Graph

Downloads

0High
0Medium
0Low

adaptavist-horizon-dev

jsaks

eknoll

Managed API for Microsoft Graph

Managed API for Microsoft Graph is an API Client for Microsoft Graph by Adaptavist primarily designed for the use in ScriptRunner Connect. You can read more about Managed APIs here.

This is a runtime agnostic version of the Managed API (with core suffix) that makes it easy to port it to any runtime you may want to use this Managed API on.

Platform specific ports

ScriptRunner Connect

Supported API calls

fetch
Groups
- getGroups
Teams
- Messaging
  - Channel
  - Chat
- Team
Users

Porting to other runtimes

While the primary reason for creating Managed APIs was to use them in ScriptRunner Connect runtime, then you can easily port them to any runtime of your choosing.

You can do so by extending the *Core Managed API class where you'll be asked to provide implementation for getPlatformImplementation function. In this implementation you have to specify how to perform buffer encoding/decoding operations and how to perform HTTP calls:

{
    buffer: {
        encode(input: string): ArrayBuffer;
        decode(input: ArrayBuffer): string;
    },
    performHttpCall(request: Request): Promise<Response>
}

Here is an example how to create a Node port of the Managed API:

import { MicrosoftGraphApiCore } from "@managed-api/microsoft-graph-v1-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";

export class MicrosoftGraphApi extends MicrosoftGraphApiCore {
    constructor(private baseUrl: string, private authToken: string) {
        super();
    }

    protected getPlatformImplementation(): PlatformImplementation {
        return {
            buffer: {
                encode: (input) => Buffer.from(input, 'utf-8'),
                decode: (input) => Buffer.from(input).toString('utf-8')
            },
            performHttpCall: (request) => this.performHttpCall(request)
        };
    }
    
    private async performHttpCall(request: Request): Promise<Response> {
        const requestUrl = `${this.baseUrl}${request.url}`; // Substitute base URL
        request.headers.set('Authorization', `Basic ${this.authToken}`); // Substitute auth token
        const response = await fetch(requestUrl, {
            method: request.method,
            headers: request.headers as any,
            body: request.method.toLowerCase() !== 'get' ? Buffer.from((await request.arrayBuffer()) ?? new ArrayBuffer(0)) : undefined
        });

        const apiHeaders = new Headers();
        response.headers.forEach((value, key) => apiHeaders.append(key, value));

        const body = await response.arrayBuffer();

        return super.buildResponse(response.url, response.status, response.statusText, apiHeaders, body);
    }
}

Please note that the authentication handling details may not be accurate and serve as an example. If you wish to use these Managed APIs without having to concern yourself how to deal with and secure authentication details when working with APIs, then feel free to evaluate ScriptRunner Connect platform.

Contact

At this time Managed APIs are unlicensed and close sourced, but feel free to drop an email to [email protected] for ideas, suggestions and improvements.

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.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme