msgraphgocore

README

Microsoft Graph Core SDK for Go

Get started with the Microsoft Graph Core SDK for Go by integrating the Microsoft Graph API into your Go application! You can also have a look at the Go documentation

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 Go API and models.

Note: the Microsoft Graph Go 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

• Middleware usage

1. Installation

go get github.com/microsoftgraph/msgraph-sdk-go-core
go get github.com/Azure/azure-sdk-for-go/sdk/azidentity
go get github.com/microsoft/kiota-authentication-azure-go

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 GraphRequestAdapterBase 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 Go to our public documentation, in the meantime the following sample should help you getting started.

import (
    azidentity "github.com/Azure/azure-sdk-for-go/sdk/azidentity"
    a          "github.com/microsoft/kiota-authentication-azure-go"
    "context"
)

cred, err := azidentity.NewDeviceCodeCredential(&azidentity.DeviceCodeCredentialOptions{
    TenantID: "<the tenant id from your app registration>",
    ClientID: "<the client id from your app registration>",
    UserPrompt: func(ctx context.Context, message azidentity.DeviceCodeMessage) error {
        fmt.Println(message.Message)
        return nil
    },
})

if err != nil {
    fmt.Printf("Error creating credentials: %v\n", err)
}

auth, err := a.NewAzureIdentityAuthenticationProviderWithScopes(cred, []string{"Mail.Read", "Mail.Send"})
if err != nil {
    fmt.Printf("Error authentication provider: %v\n", err)
    return
}

2.3 Get a Request Adapter object

You must get a GraphRequestAdapterBase object to make requests against the service.

import core "github.com/microsoftgraph/msgraph-sdk-go-core"

adapter, err := core.NewGraphRequestAdapterBase(auth)
if err != nil {
    fmt.Printf("Error creating adapter: %v\n", err)
    return
}

3. Make requests against the service

After you have a GraphRequestAdapterBase 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 details

To retrieve the user's details

import abs "github.com/microsoft/kiota-abstractions-go"

requestInf := abs.NewRequestInformation()
targetUrl, err := url.Parse("https://graph.microsoft.com/v1.0/me")
if err != nil {
    fmt.Printf("Error parsing URL: %v\n", err)
}
requestInf.SetUri(*targetUrl)

// User is your own type that implements Parsable or comes from the service library
user, err := adapter.SendAsync(*requestInf, func() { return &User }, nil)

if err != nil {
    fmt.Printf("Error getting the user: %v\n", err)
}

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.

7. Third-party notices

Third-party notices

Documentation

Index

• Variables
• func GetDefaultClient(options *GraphClientOptions, middleware ...khttp.Middleware) *nethttp.Client
• func GetDefaultMiddlewaresWithOptions(options *GraphClientOptions) []khttp.Middleware
• type GraphClientOptions
• type GraphRequestAdapterBase
  • func NewGraphRequestAdapterBase(authenticationProvider absauth.AuthenticationProvider, ...) (*GraphRequestAdapterBase, error)
  • func NewGraphRequestAdapterBaseWithParseNodeFactory(authenticationProvider absauth.AuthenticationProvider, ...) (*GraphRequestAdapterBase, error)
  • func NewGraphRequestAdapterBaseWithParseNodeFactoryAndSerializationWriterFactory(authenticationProvider absauth.AuthenticationProvider, ...) (*GraphRequestAdapterBase, error)
  • func NewGraphRequestAdapterBaseWithParseNodeFactoryAndSerializationWriterFactoryAndHttpClient(authenticationProvider absauth.AuthenticationProvider, ...) (*GraphRequestAdapterBase, error)
• type GraphTelemetryHandler
  • func NewGraphTelemetryHandler(options *GraphClientOptions) *GraphTelemetryHandler
  • func (middleware GraphTelemetryHandler) Intercept(pipeline khttp.Pipeline, middlewareIndex int, req *nethttp.Request) (*nethttp.Response, error)
• type PageIterator
  • func NewPageIterator(res interface{}, reqAdapter abstractions.RequestAdapter, ...) (*PageIterator, error)
  • func (pI *PageIterator) Iterate(callback func(pageItem interface{}) bool) error
  • func (pI *PageIterator) SetHeaders(headers map[string]string)
  • func (pI *PageIterator) SetReqOptions(reqOptions []abstractions.RequestOption)
• type PageResult

Variables

var CoreVersion = "0.25.0"

Functions

func GetDefaultClient

func GetDefaultClient(options *GraphClientOptions, middleware ...khttp.Middleware) *nethttp.Client

GetDefaultClient creates a new http client with a preconfigured middleware pipeline

func GetDefaultMiddlewaresWithOptions

func GetDefaultMiddlewaresWithOptions(options *GraphClientOptions) []khttp.Middleware

GetDefaultMiddlewaresWithOptions creates a default slice of middleware for the Graph Client.

Types

type GraphClientOptions

type GraphClientOptions struct {
	GraphServiceVersion        string
	GraphServiceLibraryVersion string
}

GraphClientOptions represents a combination of GraphServiceVersion and GraphServiceLibraryVersion

GraphServiceVersion is version of the targeted service. GraphServiceLibraryVersion is the version of the service library

type GraphRequestAdapterBase

type GraphRequestAdapterBase struct {
	khttp.NetHttpRequestAdapter
}

GraphRequestAdapterBase is the core service used by GraphServiceClient to make requests to Microsoft Graph.

func NewGraphRequestAdapterBase

func NewGraphRequestAdapterBase(authenticationProvider absauth.AuthenticationProvider, clientOptions GraphClientOptions) (*GraphRequestAdapterBase, error)

NewGraphRequestAdapterBase creates a new GraphRequestAdapterBase with the given parameters

func NewGraphRequestAdapterBaseWithParseNodeFactory

func NewGraphRequestAdapterBaseWithParseNodeFactory(authenticationProvider absauth.AuthenticationProvider, clientOptions GraphClientOptions, parseNodeFactory absser.ParseNodeFactory) (*GraphRequestAdapterBase, error)

NewGraphRequestAdapterBaseWithParseNodeFactory creates a new GraphRequestAdapterBase with the given parameters

func NewGraphRequestAdapterBaseWithParseNodeFactoryAndSerializationWriterFactory

func NewGraphRequestAdapterBaseWithParseNodeFactoryAndSerializationWriterFactory(authenticationProvider absauth.AuthenticationProvider, clientOptions GraphClientOptions, parseNodeFactory absser.ParseNodeFactory, serializationWriterFactory absser.SerializationWriterFactory) (*GraphRequestAdapterBase, error)

NewGraphRequestAdapterBaseWithParseNodeFactoryAndSerializationWriterFactory creates a new GraphRequestAdapterBase with the given parameters

func NewGraphRequestAdapterBaseWithParseNodeFactoryAndSerializationWriterFactoryAndHttpClient

func NewGraphRequestAdapterBaseWithParseNodeFactoryAndSerializationWriterFactoryAndHttpClient(authenticationProvider absauth.AuthenticationProvider, clientOptions GraphClientOptions, parseNodeFactory absser.ParseNodeFactory, serializationWriterFactory absser.SerializationWriterFactory, httpClient *nethttp.Client) (*GraphRequestAdapterBase, error)

NewGraphRequestAdapterBaseWithParseNodeFactoryAndSerializationWriterFactoryAndHttpClient creates a new GraphRequestAdapterBase with the given parameters

type GraphTelemetryHandler

type GraphTelemetryHandler struct {
	// contains filtered or unexported fields
}

GraphTelemetryHandler is a middleware handler that adds telemetry headers to requests.

func NewGraphTelemetryHandler

func NewGraphTelemetryHandler(options *GraphClientOptions) *GraphTelemetryHandler

NewGraphTelemetryHandler creates a new GraphTelemetryHandler.

func (GraphTelemetryHandler) Intercept

func (middleware GraphTelemetryHandler) Intercept(pipeline khttp.Pipeline, middlewareIndex int, req *nethttp.Request) (*nethttp.Response, error)

type PageIterator

type PageIterator struct {
	// contains filtered or unexported fields
}

PageIterator represents an iterator object that can be used to get subsequent pages of a collection.

func NewPageIterator

func NewPageIterator(res interface{}, reqAdapter abstractions.RequestAdapter, constructorFunc serialization.ParsableFactory) (*PageIterator, error)

NewPageIterator creates an iterator instance

It has three parameters. res is the graph response from the initial request and represents the first page. reqAdapter is used for getting the next page and constructorFunc is used for serializing next page's response to the specified type.

func (*PageIterator) Iterate

func (pI *PageIterator) Iterate(callback func(pageItem interface{}) bool) error

Iterate traverses all pages and enumerates all items in the current page and returns an error if something goes wrong.

Iterate receives a callback function which is called with each item in the current page as an argument. The callback function returns a boolean. To traverse and enumerate all pages always return true and to pause traversal and enumeration return false from the callback.

Example

pageIterator, err := NewPageIterator(resp, reqAdapter, parsableFactory)
callbackFunc := func (pageItem interface{}) bool {
    fmt.Println(pageitem.GetDisplayName())
    return true
}
err := pageIterator.Iterate(callbackFunc)

func (*PageIterator) SetHeaders

func (pI *PageIterator) SetHeaders(headers map[string]string)

SetHeaders provides headers for requests made to get subsequent pages

Headers in the initial request -- request to get the first page -- are not included in subsequent page requests.

func (*PageIterator) SetReqOptions

func (pI *PageIterator) SetReqOptions(reqOptions []abstractions.RequestOption)

SetReqOptions provides configuration for handlers during requests for subsequent pages

type PageResult

type PageResult struct {
	// contains filtered or unexported fields
}

PageResult represents a page object built from a graph response object