Microsoft Graph Core SDK for Ruby
Get started with the Microsoft Graph Core SDK for Ruby by integrating the Microsoft Graph API into your Ruby application!
Note: Although you can use this library directly, we recommend you use the v1 or beta library which rely on this library and additionally provide a fluent style ruby API and models.
Note: the Microsoft Graph Ruby SDK is currently in Community Preview. During this period we're expecting breaking changes to happen to the SDK based on community's feedback. Checkout the known limitations.
Samples and usage guide
1. Installation
run gem install microsoft_graph_core or include gem microsoft_graph_core in your gemfile.
2. Getting started
2.1 Register your application
Register your application by following the steps at Register your app with the Microsoft Identity Platform.
2.2 Create an AuthenticationProvider object
An instance of the MicrosoftGraphServiceClient class handles building client. To create a new instance of this class, you need to provide an instance of AuthenticationProvider, which can authenticate requests to Microsoft Graph.
For an example of how to get an authentication provider, see choose a Microsoft Graph authentication provider.
Note: we are working to add the getting started information for Ruby to our public documentation, in the meantime the following sample should help you getting started.
require "microsoft_kiota_authentication_oauth"
require "microsoft_graph_core"
context = MicrosoftKiotaAuthenticationOauth::ClientCredentialContext.new("<the tenant id from your app registration>", "<the client id from your app registration>", "<the client secret from your app registration>")
authentication_provider = MicrosoftGraphCore::Authentication::OAuthAuthenticationProvider.new(context, nil, ["Files.Read"])
2.3 Get a Graph Service Client and Adapter object
You must get a MicrosoftGraphRequestAdapter object to make requests against the service.
require "microsoft_graph"
adapter = MicrosoftGraph::MicrosoftGraphRequestAdapter.new(authentication_provider)
3. Make requests against the service
After you have a MicrosoftGraphRequestAdapter that is authenticated, you can begin making calls against the service. The requests against the service look like our REST API.
3.1 Get the user's drive
To retrieve the user's drive:
import "microsoft_kiota_abstractions"
request_information = MicrosoftKiotaAbstractions::RequestInformation.new
request_information.url = "https://graph.microsoft.com/v1.0/me"
result = adapter.send_async(request_information, lambda |pn| { return UserModel.new }, nil, nil).resume
4. Issues
For known issues, see issues.
5. Contributions
The Microsoft Graph SDK is open for contribution. To contribute to this project, see Contributing.
6. License
Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT license.