Erstellen von Go-Apps mit Microsoft Graph und nur app-Authentifizierung

In diesem Tutorial erfahren Sie, wie Sie eine Go-Konsolen-App erstellen, die die Microsoft Graph-API verwendet, um mithilfe der reinen App-Authentifizierung auf Daten zuzugreifen. Die reine App-Authentifizierung ist eine gute Wahl für Hintergrunddienste oder Anwendungen, die auf Daten für alle Benutzer in einer Organisation zugreifen müssen.

In diesem Lernprogramm wird Folgendes vermittelt:

• Benutzer auflisten

Voraussetzungen

Bevor Sie mit diesem Tutorial beginnen, sollte Go auf Ihrem Entwicklungscomputer installiert sein.

Sie sollten auch über ein Microsoft-Geschäfts-, Schul- oder Unikonto mit der Rolle "Globaler Administrator" verfügen. Wenn Sie nicht über einen Microsoft 365-Mandanten verfügen, können Sie sich über das Microsoft 365-Entwicklerprogramm für einen mandantenfähigen Mandanten qualifizieren. Weitere Informationen finden Sie in den häufig gestellten Fragen. Alternativ können Sie sich für eine kostenlose 1-monatige Testversion registrieren oder einen Microsoft 365-Plan erwerben.

Registrieren der App im Portal

• 18 Minuten verbleibend

In dieser Übung registrieren Sie eine neue Anwendung in Azure Active Directory, um die reine App-Authentifizierung zu aktivieren. Sie können eine Anwendung über das Microsoft Entra Admin Center oder mithilfe des Microsoft Graph PowerShell SDK registrieren.

Registrieren der Anwendung für die reine App-Authentifizierung

In diesem Abschnitt registrieren Sie eine Anwendung, die die reine App-Authentifizierung mit Clientanmeldeinformationen unterstützt.

Erstellen einer Go-Konsolen-App

• 15 Minuten verbleibend

Initialisieren Sie zunächst ein neues Go-Modul mithilfe der Go CLI. Öffnen Sie Ihre Befehlszeilenschnittstelle (CLI) in einem Verzeichnis, in dem Sie das Projekt erstellen möchten. Führen Sie den folgenden Befehl aus.

go mod init graphapponlytutorial

Installieren von Abhängigkeiten

Bevor Sie mit dem Vorgang fortfahren, fügen Sie einige zusätzliche Abhängigkeiten hinzu, die Sie später verwenden werden.

• Azure Identity Client Module for Go zum Authentifizieren des Benutzers und Abrufen von Zugriffstoken.
• Microsoft Graph SDK für Go , um Aufrufe an Microsoft Graph zu senden.
• GoDotEnv zum Lesen von Umgebungsvariablen aus ENV-Dateien.

Führen Sie die folgenden Befehle in Ihrer CLI aus, um die Abhängigkeiten zu installieren.

go get github.com/Azure/azure-sdk-for-go/sdk/azidentity
go get github.com/microsoftgraph/msgraph-sdk-go
go get github.com/joho/godotenv

Laden von Anwendungseinstellungen

In diesem Abschnitt fügen Sie dem Projekt die Details Ihrer App-Registrierung hinzu.

1. Erstellen Sie eine Datei im selben Verzeichnis wie go.mod mit dem Namen .env , und fügen Sie den folgenden Code hinzu.

   CLIENT_ID=YOUR_CLIENT_ID_HERE
   CLIENT_SECRET=YOUR_CLIENT_SECRET_HERE
   TENANT_ID=YOUR_TENANT_ID_HERE
   

2. Aktualisieren Sie die Werte gemäß der folgenden Tabelle.

   Einstellung	Wert
   CLIENT_ID	Die Client-ID Ihrer App-Registrierung
   CLIENT_SECRET	Der geheime Clientschlüssel Ihrer App-Registrierung
   TENANT_ID	Die Mandanten-ID Ihrer Organisation

   Tipp

   Optional können Sie diese Werte in einer separaten Datei mit dem Namen .env.local festlegen.

Entwerfen der App

In diesem Abschnitt erstellen Sie ein einfaches konsolenbasiertes Menü.

1. Erstellen Sie ein neues Verzeichnis im selben Verzeichnis wie go.mod mit dem Namen graphhelper.

2. Fügen Sie im Verzeichnis graphhelper eine neue Datei mit dem Namen graphhelper.go hinzu, und fügen Sie den folgenden Code hinzu.

   package graphhelper
   
   import (
       "context"
       "os"
   
       "github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
       "github.com/Azure/azure-sdk-for-go/sdk/azidentity"
       auth "github.com/microsoft/kiota-authentication-azure-go"
       msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
       "github.com/microsoftgraph/msgraph-sdk-go/models"
       "github.com/microsoftgraph/msgraph-sdk-go/users"
   )
   
   type GraphHelper struct {
       clientSecretCredential *azidentity.ClientSecretCredential
       appClient              *msgraphsdk.GraphServiceClient
   }
   
   func NewGraphHelper() *GraphHelper {
       g := &GraphHelper{}
       return g
   }
   

   Dadurch wird ein grundlegender GraphHelper-Typ erstellt, den Sie in späteren Abschnitten erweitern, um Microsoft Graph zu verwenden.

3. Erstellen Sie eine Datei im selben Verzeichnis wie go.mod mit dem Namen graphapponlytutorial.go. Fügen Sie den folgenden Code hinzu.

   package main
   
   import (
       "fmt"
       "graphapponlytutorial/graphhelper"
       "log"
   
       "github.com/joho/godotenv"
   )
   
   func main() {
       fmt.Println("Go Graph App-Only Tutorial")
       fmt.Println()
   
       // Load .env files
       // .env.local takes precedence (if present)
       godotenv.Load(".env.local")
       err := godotenv.Load()
       if err != nil {
           log.Fatal("Error loading .env")
       }
   
       graphHelper := graphhelper.NewGraphHelper()
   
       initializeGraph(graphHelper)
   
       var choice int64 = -1
   
       for {
           fmt.Println("Please choose one of the following options:")
           fmt.Println("0. Exit")
           fmt.Println("1. Display access token")
           fmt.Println("2. List users")
           fmt.Println("3. Make a Graph call")
   
           _, err = fmt.Scanf("%d", &choice)
           if err != nil {
               choice = -1
           }
   
           switch choice {
           case 0:
               // Exit the program
               fmt.Println("Goodbye...")
           case 1:
               // Display access token
               displayAccessToken(graphHelper)
           case 2:
               // List users
               listUsers(graphHelper)
           case 3:
               // Run any Graph code
               makeGraphCall(graphHelper)
           default:
               fmt.Println("Invalid choice! Please try again.")
           }
   
           if choice == 0 {
               break
           }
       }
   }
   

4. Fügen Sie am Ende der Datei die folgenden Platzhaltermethoden hinzu. Sie implementieren sie in späteren Schritten.

   func initializeGraph(graphHelper *graphhelper.GraphHelper) {
       // TODO
   }
   
   func displayAccessToken(graphHelper *graphhelper.GraphHelper) {
       // TODO
   }
   
   func listUsers(graphHelper *graphhelper.GraphHelper) {
       // TODO
   }
   
   func makeGraphCall(graphHelper *graphhelper.GraphHelper) {
       // TODO
   }
   

Dadurch wird ein einfaches Menü implementiert und die Auswahl des Benutzers aus der Befehlszeile gelesen.

Hinzufügen einer reinen App-Authentifizierung

• 10 Minuten verbleibend

In diesem Abschnitt fügen Sie der Anwendung die reine App-Authentifizierung hinzu. er ist erforderlich, um das erforderliche OAuth-Zugriffstoken zum Aufrufen von Microsoft Graph abzurufen. In diesem Schritt integrieren Sie das Azure Identity Client Module for Go in die Anwendung und konfigurieren die Authentifizierung für das Microsoft Graph SDK für Go.

Die Azure Identity-Bibliothek bietet eine Reihe von TokenCredential Klassen, die OAuth2-Tokenflows implementieren. Das Microsoft Graph SDK verwendet diese Klassen, um Aufrufe von Microsoft Graph zu authentifizieren.

Konfigurieren des Graph-Clients für die reine App-Authentifizierung

In diesem Abschnitt verwenden Sie die ClientSecretCredential -Klasse, um mithilfe des Clientanmeldeinformationsflows ein Zugriffstoken anzufordern.

1. Fügen Sie . /graphhelper/graphhelper.go die folgende Funktion hinzu.

   func (g *GraphHelper) InitializeGraphForAppAuth() error {
       clientId := os.Getenv("CLIENT_ID")
       tenantId := os.Getenv("TENANT_ID")
       clientSecret := os.Getenv("CLIENT_SECRET")
       credential, err := azidentity.NewClientSecretCredential(tenantId, clientId, clientSecret, nil)
       if err != nil {
           return err
       }
   
       g.clientSecretCredential = credential
   
       // Create an auth provider using the credential
       authProvider, err := auth.NewAzureIdentityAuthenticationProviderWithScopes(g.clientSecretCredential, []string{
           "https://graph.microsoft.com/.default",
       })
       if err != nil {
           return err
       }
   
       // Create a request adapter using the auth provider
       adapter, err := msgraphsdk.NewGraphRequestAdapter(authProvider)
       if err != nil {
           return err
       }
   
       // Create a Graph client using request adapter
       client := msgraphsdk.NewGraphServiceClient(adapter)
       g.appClient = client
   
       return nil
   }
   

   Tipp

   Wenn Sie goimports verwenden, wurden einige Module möglicherweise automatisch aus Ihrer import Anweisung in graphhelper.go beim Speichern entfernt. Möglicherweise müssen Sie die zu erstellenden Module erneut hinzufügen.

2. Ersetzen Sie die leere initializeGraph Funktion in graphapponlytutorial.go durch Folgendes.

   func initializeGraph(graphHelper *graphhelper.GraphHelper) {
       err := graphHelper.InitializeGraphForAppAuth()
       if err != nil {
           log.Panicf("Error initializing Graph for app auth: %v\n", err)
       }
   }
   

Dieser Code initialisiert zwei Eigenschaften, ein DeviceCodeCredential -Objekt und ein GraphServiceClient -Objekt. Die InitializeGraphForUserAuth -Funktion erstellt eine neue Instanz von DeviceCodeCredentialund verwendet diese Instanz dann, um eine neue Instanz von GraphServiceClientzu erstellen. Jedes Mal, wenn ein API-Aufruf an Microsoft Graph über userClienterfolgt, werden die bereitgestellten Anmeldeinformationen verwendet, um ein Zugriffstoken abzurufen.

Testen von ClientSecretCredential

Fügen Sie als Nächstes Code hinzu, um ein Zugriffstoken ClientSecretCredentialvon abzurufen.

1. Fügen Sie . /graphhelper/graphhelper.go die folgende Funktion hinzu.

   func (g *GraphHelper) GetAppToken() (*string, error) {
       token, err := g.clientSecretCredential.GetToken(context.Background(), policy.TokenRequestOptions{
           Scopes: []string{
               "https://graph.microsoft.com/.default",
           },
       })
       if err != nil {
           return nil, err
       }
   
       return &token.Token, nil
   }
   

2. Ersetzen Sie die leere displayAccessToken Funktion in graphapponlytutorial.go durch Folgendes.

   func displayAccessToken(graphHelper *graphhelper.GraphHelper) {
       token, err := graphHelper.GetAppToken()
       if err != nil {
           log.Panicf("Error getting user token: %v\n", err)
       }
   
       fmt.Printf("App-only token: %s", *token)
       fmt.Println()
   }
   

3. Erstellen Sie die App, und führen Sie sie aus, indem Sie ausführen go run graphapponlytutorial. Geben Sie ein 1 , wenn Sie zur Eingabe einer Option aufgefordert werden. Die Anwendung zeigt ein Zugriffstoken an.

   Go Graph App-Only Tutorial
   
   Please choose one of the following options:
   0. Exit
   1. Display access token
   2. List users
   3. Make a Graph call
   1
   App-only token: eyJ0eXAiOiJKV1QiLCJub25jZSI6IlVDTzRYOWtKYlNLVjVkRzJGenJqd2xvVUcwWS...
   

   Tipp

   Nur zu Validierungs- und Debugzwecken können Sie Nur-App-Zugriffstoken mithilfe des Onlinetokenparsers von Microsoft unter https://jwt.msdecodieren. Dies kann nützlich sein, wenn beim Aufrufen von Microsoft Graph Tokenfehler auftreten. Beispielsweise wird überprüft, ob der role Anspruch im Token die erwarteten Microsoft Graph-Berechtigungsbereiche enthält.

Benutzer auflisten

• 7 Minuten verbleibend

In diesem Abschnitt fügen Sie die Möglichkeit hinzu, alle Benutzer in Ihrer Azure Active Directory-Instanz mithilfe der reinen App-Authentifizierung aufzulisten.

1. Fügen Sie . /graphhelper/graphhelper.go die folgende Funktion hinzu.

   func (g *GraphHelper) GetUsers() (models.UserCollectionResponseable, error) {
       var topValue int32 = 25
       query := users.UsersRequestBuilderGetQueryParameters{
           // Only request specific properties
           Select: []string{"displayName", "id", "mail"},
           // Get at most 25 results
           Top: &topValue,
           // Sort by display name
           Orderby: []string{"displayName"},
       }
   
       return g.appClient.Users().
           Get(context.Background(),
               &users.UsersRequestBuilderGetRequestConfiguration{
                   QueryParameters: &query,
               })
   }
   

2. Ersetzen Sie die leere listUsers Funktion in graphapponlytutorial.go durch Folgendes.

   func listUsers(graphHelper *graphhelper.GraphHelper) {
       users, err := graphHelper.GetUsers()
       if err != nil {
           log.Panicf("Error getting users: %v", err)
       }
   
       // Output each user's details
       for _, user := range users.GetValue() {
           fmt.Printf("User: %s\n", *user.GetDisplayName())
           fmt.Printf("  ID: %s\n", *user.GetId())
   
           noEmail := "NO EMAIL"
           email := user.GetMail()
           if email == nil {
               email = &noEmail
           }
           fmt.Printf("  Email: %s\n", *email)
       }
   
       // If GetOdataNextLink does not return nil,
       // there are more users available on the server
       nextLink := users.GetOdataNextLink()
   
       fmt.Println()
       fmt.Printf("More users available? %t\n", nextLink != nil)
       fmt.Println()
   }
   

3. Führen Sie die App aus, melden Sie sich an, und wählen Sie Option 2 aus, um Benutzer aufzulisten.

   Please choose one of the following options:
   0. Exit
   1. Display access token
   2. List users
   3. Make a Graph call
   2
   User: Adele Vance
     ID: 05fb57bf-2653-4396-846d-2f210a91d9cf
     Email: AdeleV@contoso.com
   User: Alex Wilber
     ID: a36fe267-a437-4d24-b39e-7344774d606c
     Email: AlexW@contoso.com
   User: Allan Deyoung
     ID: 54cebbaa-2c56-47ec-b878-c8ff309746b0
     Email: AllanD@contoso.com
   User: Bianca Pisani
     ID: 9a7dcbd0-72f0-48a9-a9fa-03cd46641d49
     Email: NO EMAIL
   User: Brian Johnson (TAILSPIN)
     ID: a8989e40-be57-4c2e-bf0b-7cdc471e9cc4
     Email: BrianJ@contoso.com
   
   ...
   
   More users available? true
   

Code erläutert

Betrachten Sie den Code in der GetUsers Funktion.

• Es ruft eine Sammlung von Benutzern ab.
• Wird verwendet Select , um bestimmte Eigenschaften anzufordern.
• Wird verwendet Top , um die Anzahl der zurückgegebenen Benutzer zu begrenzen.
• OrderBy Verwendet, um die Antwort zu sortieren.

Optional: Fügen Sie Ihren eigenen Code hinzu.

• 5 Minuten verbleibend

In diesem Abschnitt fügen Sie der Anwendung Ihre eigenen Microsoft Graph-Funktionen hinzu. Dies kann ein Codeausschnitt aus der Microsoft Graph-Dokumentation oder graph-Explorer oder code sein, den Sie erstellt haben. Dieser Abschnitt ist optional.

Aktualisieren der App

1. Fügen Sie . /graphhelper/graphhelper.go die folgende Funktion hinzu.

   func (g *GraphHelper) MakeGraphCall() error {
       // INSERT YOUR CODE HERE
       return nil
   }
   

2. Ersetzen Sie die leere makeGraphCall Funktion in graphapponlytutorial.go durch Folgendes.

   func makeGraphCall(graphHelper *graphhelper.GraphHelper) {
       err := graphHelper.MakeGraphCall()
       if err != nil {
           log.Panicf("Error making Graph call: %v", err)
       }
   }
   

Auswählen einer API

Suchen Sie eine API in Microsoft Graph, die Sie ausprobieren möchten. Beispiel: Die Api zum Erstellen eines Ereignisses . Sie können eines der Beispiele in der API-Dokumentation verwenden, oder Sie können eine API-Anforderung im Graph-Explorer anpassen und den generierten Codeausschnitt verwenden.

Konfigurieren von Berechtigungen

Überprüfen Sie den Abschnitt Berechtigungen der Referenzdokumentation für Die ausgewählte API, um zu sehen, welche Authentifizierungsmethoden unterstützt werden. Einige APIs unterstützen z. B. keine reinen Apps oder persönlichen Microsoft-Konten.

• Informationen zum Aufrufen einer API mit Benutzerauthentifizierung (wenn die API die (delegierte) Benutzerauthentifizierung unterstützt), finden Sie im Tutorial zur benutzerseitig (delegierten) Authentifizierung .
• Um eine API mit nur app-Authentifizierung aufzurufen (sofern die API dies unterstützt), fügen Sie den erforderlichen Berechtigungsbereich im Azure AD Admin Center hinzu.

Fügen Sie Ihren Code hinzu

Kopieren Sie Ihren Code in die MakeGraphCall Funktion in graphhelper.go. Wenn Sie einen Codeausschnitt aus der Dokumentation oder dem Graph-Explorer kopieren, müssen Sie den GraphServiceClientappClientin umbenennen.

Herzlichen Glückwunsch!

• 100 % abgeschlossen!

Sie haben das Microsoft Graph-Tutorial go abgeschlossen. Nachdem Sie nun über eine funktionierende App verfügen, die Microsoft Graph aufruft, können Sie experimentieren und neue Features hinzufügen.

• Erfahren Sie, wie Sie die (delegierte) Benutzerauthentifizierung mit dem Microsoft Graph Go SDK verwenden.
• Besuchen Sie die Übersicht über Microsoft Graph , um alle Daten anzuzeigen, auf die Sie mit Microsoft Graph zugreifen können.