Exemples de code et PowerShell pour Microsoft Entra B2B Collaboration

Exemple PowerShell

Vous pouvez inviter en bloc des utilisateurs externes à une organisation à partir d’adresses e-mail que vous stockez dans un fichier .csv.

1. Préparer le fichier .csv

   Créez un fichier .csv et nommez-le invitations.csv. Dans cet exemple, le fichier est enregistré dans C:\data et contient les informations suivantes :

   Nom	InvitedUserEmailAddress
   Invité B2B Gmail	b2binvitee@gmail.com
   Invité B2B Outlook	b2binvitee@outlook.com

2. Obtenir la dernière version de Microsoft Graph PowerShell

   Pour utiliser les nouvelles applets de commande, vous devez installer le module Microsoft Graph PowerShell mis à jour. Pour plus d’informations, consultez Installer le SDK Microsoft Graph PowerShell

3. Connectez-vous à votre architecture cliente

   Connect-MgGraph -Scopes "User.Invite.All"
   

4. Exécutez l’applet de commande PowerShell

   $invitations = import-csv C:\data\invitations.csv
   $messageInfo = New-Object Microsoft.Open.MSGraph.Model.InvitedUserMessageInfo
   $messageInfo.customizedMessageBody = "Hey there! Check this out. I created an invitation through PowerShell"
   foreach ($email in $invitations) {
      New-MgInvitation -InviteRedirectUrl "https://wingtiptoysonline-dev-ed.my.woodgrove.com" `
         -InvitedUserDisplayName $email.Name -InvitedUserEmailAddress $email.InvitedUserEmailAddress `
         -InvitedUserMessageInfo $messageInfo -SendInvitationMessage:$true
   }
   

Cette applet de commande envoie une invitation aux adresses e-mail stockées dans le fichier invitations.csv. Fonctionnalités supplémentaires de cette cmdlet :

• Texte personnalisé dans le message électronique
• Y compris un nom d’affichage pour l’utilisateur invité
• Envoi de messages aux personnes en copie ou suppression complète des messages électroniques

Exemple de code

L’exemple de code illustre l’appel de l’API d’invitation et l’obtention de l’URL d’échange. Utilisez l’URL d’échange pour envoyer un e-mail d’invitation personnalisé. Vous pouvez composer l’e-mail avec un client HTTP, ce qui vous permet de personnaliser son apparence et de l’envoyer via l’API Graph Microsoft.

HTTP

POST https://graph.microsoft.com/v1.0/invitations
Content-type: application/json
{
  "invitedUserEmailAddress": "david@fabrikam.com",
  "invitedUserDisplayName": "David",
  "inviteRedirectUrl": "https://myapp.contoso.com",
  "sendInvitationMessage": true
}

C#

using System;
using System.Threading.Tasks;
using Microsoft.Graph;
using Azure.Identity;

namespace SampleInviteApp
{
    class Program
    {
        /// <summary>
        /// This is the tenant ID of the tenant you want to invite users to.
        /// </summary>
        private static readonly string TenantID = "";

        /// <summary>
        /// This is the application id of the application that is registered in the above tenant.
        /// </summary>
        private static readonly string TestAppClientId = "";

        /// <summary>
        /// Client secret of the application.
        /// </summary>
        private static readonly string TestAppClientSecret = @"";

        /// <summary>
        /// This is the email address of the user you want to invite.
        /// </summary>
        private static readonly string InvitedUserEmailAddress = @"";

        /// <summary>
        /// This is the display name of the user you want to invite.
        /// </summary>
        private static readonly string InvitedUserDisplayName = @"";

        /// <summary>
        /// Main method.
        /// </summary>
        /// <param name="args">Optional arguments</param>
        static async Task Main(string[] args)
        {
            string InviteRedeemUrl = await SendInvitation();
        }

        /// <summary>
        /// Send the guest user invite request.
        /// </summary>
        private static async string SendInvitation()
        {
            /// Get the access token for our application to talk to Microsoft Graph.
            var scopes = new[] { "https://graph.microsoft.com/.default" };
            var clientSecretCredential = new ClientSecretCredential(TenantID, TestAppClientId, TestAppClientSecret);
            var graphClient = new GraphServiceClient(clientSecretCredential, scopes);

            // Create the invitation object.
            var invitation = new Invitation
            {
                InvitedUserEmailAddress = InvitedUserEmailAddress,
                InvitedUserDisplayName = InvitedUserDisplayName,
                InviteRedirectUrl = "https://www.microsoft.com",
                SendInvitationMessage = true
            };

            // Send the invitation 
            var GraphResponse = await graphClient.Invitations
                .Request()
                .AddAsync(invitation);

            // Return the invite redeem URL
            return GraphResponse.InviteRedeemUrl;
        }
    }
}

JavaScript

Installez les packages npm suivants :

npm install express
npm install isomorphic-fetch
npm install @azure/identity
npm install @microsoft/microsoft-graph-client

const express = require('express')
const app = express()

const { Client } = require("@microsoft/microsoft-graph-client");
const { TokenCredentialAuthenticationProvider } = require("@microsoft/microsoft-graph-client/authProviders/azureTokenCredentials");
const { ClientSecretCredential } = require("@azure/identity");
require("isomorphic-fetch");

// This is the application id of the application that is registered in the above tenant.
const CLIENT_ID = ""

// Client secret of the application.
const CLIENT_SECRET = ""

// This is the tenant ID of the tenant you want to invite users to. For example fabrikam.onmicrosoft.com
const TENANT_ID = ""

async function sendInvite() {

  // Initialize a confidential client application. For more info, visit: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-a-service-principal-with-a-client-secret
  const credential = new ClientSecretCredential(TENANT_ID, CLIENT_ID, CLIENT_SECRET);

  // Initialize the Microsoft Graph authentication provider. For more info, visit: https://learn.microsoft.com/graph/sdks/choose-authentication-providers?tabs=Javascript#using--for-server-side-applications
  const authProvider = new TokenCredentialAuthenticationProvider(credential, { scopes: ['https://graph.microsoft.com/.default'] });

  // Create MS Graph client instance. For more info, visit: https://github.com/microsoftgraph/msgraph-sdk-javascript/blob/dev/docs/CreatingClientInstance.md
  const client = Client.initWithMiddleware({
    debugLogging: true,
    authProvider,
  });

  // Create invitation object
  const invitation = {
    invitedUserEmailAddress: 'david@fabrikam.com',
    invitedUserDisplayName: 'David',
    inviteRedirectUrl: 'https://www.microsoft.com',
    sendInvitationMessage: true
  };
  
  // Execute the MS Graph command. For more information, visit: https://learn.microsoft.com/graph/api/invitation-post
  graphResponse = await client.api('/invitations')
    .post(invitation);
  
  // Return the invite redeem URL
  return graphResponse.inviteRedeemUrl
}

const inviteRedeemUrl = await sendInvite();

Étapes suivantes

• Exemples d’inscription en libre-service pour les utilisateurs invités