Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/microsoftgraph/msgraph-sdk-ruby
Microsoft Graph Ruby client library for v1 APIs
https://github.com/microsoftgraph/msgraph-sdk-ruby
devxeng microsoftgraph ruby
Last synced: 1 day ago
JSON representation
Microsoft Graph Ruby client library for v1 APIs
- Host: GitHub
- URL: https://github.com/microsoftgraph/msgraph-sdk-ruby
- Owner: microsoftgraph
- License: mit
- Created: 2016-05-11T17:11:20.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2025-01-14T11:58:14.000Z (12 days ago)
- Last Synced: 2025-01-18T01:03:41.675Z (8 days ago)
- Topics: devxeng, microsoftgraph, ruby
- Language: Ruby
- Homepage: https://graph.microsoft.com
- Size: 45.9 MB
- Stars: 106
- Watchers: 33
- Forks: 69
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Microsoft Graph SDK for Ruby
If you're using a version lower than 0.10.0 of this gem, please read this [post](https://github.com/microsoftgraph/msgraph-sdk-ruby/issues/69) for more information.
Get started with the Microsoft Graph SDK for Ruby by integrating the [Microsoft Graph API](https://learn.microsoft.com/graph/overview) into your Ruby application!
> **Note:** this SDK allows you to build applications using the [v1.0](https://learn.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs under beta, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-ruby) instead.
>
> **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](https://github.com/microsoftgraph/msgraph-sdk-ruby-core/issues/1).
## 1. Installation
run `gem install microsoft_graph` or include `gem microsoft_graph, "~> 0.22.2"` 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](https://learn.microsoft.com/graph/auth-register-app-v2).
### 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](https://learn.microsoft.com/graph/sdks/choose-authentication-providers?tabs=Ruby).
> 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.
```Ruby
require "microsoft_kiota_authentication_oauth"
require "microsoft_graph_core"
context = MicrosoftKiotaAuthenticationOAuth::ClientCredentialContext.new("", "", "")
authentication_provider = MicrosoftGraphCore::Authentication::OAuthAuthenticationProvider.new(context, nil, ["https://graph.microsoft.com/.default"])
```
### 2.3 Get a Graph Service Client and Adapter object
You must get a **MicrosoftGraphServiceClient** object to make requests against the service.
```ruby
require "microsoft_graph"
adapter = MicrosoftGraph::GraphRequestAdapter.new(authentication_provider)
client = MicrosoftGraph::GraphServiceClient.new(adapter)
```
## 3. Make requests against the service
After you have a **MicrosoftGraphServiceClient** that is authenticated, you can begin making calls against the service. The requests against the service look like our [REST API](https://learn.microsoft.com/graph/api/overview?view=graph-rest-1.0).
### 3.1 Get the user's drive
To retrieve the user's drive:
```ruby
result = client.users_by_id('').get.resume
puts "Found User : " + result.id
```
## 4. Getting results that span across multiple pages
Automatic paging is currently not supported with the Ruby SDK, we're working to enable this feature.
## 5. Documentation
For more detailed documentation, see:
* [Overview](https://learn.microsoft.com/graph/overview)
* [Collections](https://learn.microsoft.com/graph/sdks/paging)
* [Making requests](https://learn.microsoft.com/graph/sdks/create-requests)
* [Known issues](https://github.com/MicrosoftGraph/msgraph-sdk-ruby/issues)
* [Contributions](https://github.com/microsoftgraph/msgraph-sdk-ruby/blob/main/CONTRIBUTING.md)
## 6. Issues
For known issues, see [issues](https://github.com/MicrosoftGraph/msgraph-sdk-ruby/issues).
## 7. Contributions
The Microsoft Graph SDK is open for contribution. To contribute to this project, see [Contributing](https://github.com/microsoftgraph/msgraph-sdk-ruby/blob/main/CONTRIBUTING.md).
## 8. License
Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the [MIT license](LICENSE).
## 9. Third-party notices
[Third-party notices](THIRD%20PARTY%20NOTICES)