Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linx-software/azure-graph-api
\This solution shows how to integrate with the Microsoft Azure Graph API. Useful to interact with any Azure, Office365 or Outlook service. The solution shows how to create a new calendar event and how to download a file from SharePoint.
https://github.com/linx-software/azure-graph-api
graph linx microsoft microsoftgraphapi ms o365
Last synced: 27 days ago
JSON representation
\This solution shows how to integrate with the Microsoft Azure Graph API. Useful to interact with any Azure, Office365 or Outlook service. The solution shows how to create a new calendar event and how to download a file from SharePoint.
- Host: GitHub
- URL: https://github.com/linx-software/azure-graph-api
- Owner: linx-software
- License: mit
- Created: 2024-03-25T12:24:51.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-03-28T13:38:58.000Z (9 months ago)
- Last Synced: 2024-03-28T14:57:14.376Z (9 months ago)
- Topics: graph, linx, microsoft, microsoftgraphapi, ms, o365
- Homepage: https://linx.software/
- Size: 45.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Microsoft Graph API Example
## Description
This solution shows how to interact with the Microsoft Graph API with Linx. The solution does the following:
### Authentication
- Does OAuth Authentication
### Users
- Get a list of users
- Get information on a specific user
- Get a list of calendars for a user
- Get a list of events on a calendar
- Create a new event
### Site and Drive
- Get Root Site Information (SharePoint Site)
- Get a Site Information based off the Site Name (SharePoint Site)
- Get the Drive information of a specific Site (SharePoint Site)
- Retrieve all children of a drive (files and folders in that drive)
- Download a file from a drive (specifically a SharePoint drive using the graph API)
## Usage
### Functions
All Functions have an AccessToken input parameter, thus the Access Token must be retrieved with the GetToken function first
#### Authentication
- GetToken: Get an authentication token for use in all other functions (OAuth2) - Pass in the TennantID, ClientID, Client Secret and Scope.
#### Users and Calendar
- ListUsers: Retrieve a list of all users - Pass in the AccessToken
- GetUser: Retrieve a specific user based on a passed-in User ID - Pass in the AccessToken and UserID
- ListCalendars: Retrieve a list of all calendars for a specific user ID - Pass in the AccessToken and User ID
- ListEvents: Retrieve a list of all events for a specific user ID and calendar ID - Pass in the AccessToken, User ID and Callendar ID
- CreateEvent: Create a new event for a specified user and calendar. An event type is passed in to create this event - Pass in the AccessToken, User ID, Callendar ID and event details
#### Sites and Drive (SharePoint)
- GetRootSite: Get the information of the Root drive - Pass in the AccessToken
- GetSiteByName: Get the information of a specific site based on the site name - Pass in the AccessToken and the site name
- GetSiteDrive: Get the drive(s) of a site - Pass in the AccessToken and Site ID (Retreived via GetSiteByName OR GetRootSite)
- GetDriveChildren: Retrieve the children in a drive (Files and folders) - Pass in AccessToken and DriveID (retrieved via GetSiteDrive)
- DownloadItemFromDrive: Download a file from a SharePoint Drive - you need to know the File Name - Pass in AccessToken, DriveID, FileName (as is online) and SaveLocation (location where Linx must download the file to on the server)
### Try it out
For Calendar entries: Select the TestAddandListEvents function, add in your TenantID, ClientSecret and ClientID along with relevant User and calendar IDs (where required), click Debug and click Start. User and Calendar IDs can be retrieved by debugging to the ListUsers and ListCalendar functions.
For downloading a file from SharePoint: Select the TestDownloadFIleFromSharepoint, add in your TenantID, ClientSecret and ClientID along with relevant details including SiteName, SiteID, DriveID, FileName and SaveLocation into the various functions. SiteID and DriveID can be retreived by debugging to the GetSiteByName and GetSiteDrive functions.
### Use it in your own Linx solution
Copy the relevant function along with its types folder to your solution and call it from anywhere.
Note that you will need to create a setting for the MsGraphApiUrl - this is to facilitate easier switching when a new version of the API comes out.
### Notes
In order for the solution to work correctly, you must ensure that the correct permissions are applied to your Azure/Graph instance.
## Contributing
For questions, please ask the [Linx community](https://linx/software/community)
## License
[MIT](https://github.com/linx-software/template-repo/blob/main/LICENSE.txt)