Een desktop-app die web-API's aanroept: codeconfiguratie

Nu u de toepassing hebt gemaakt, leert u hoe u de code configureert met de coördinaten van de toepassing.

Microsoft-bibliotheken die desktop-apps ondersteunen

De volgende Microsoft-bibliotheken ondersteunen desktop-apps:

Taal/framework	Project over GitHub	Pakket	Aan de slag	Gebruikers aanmelden	Toegang krijgen tot web-API's	Algemeen beschikbaar (GA) of Openbare preview1
Electron	MSAL Node.js	msal-node	—			Openbare preview
Java	MSAL4J	msal4j	—			GA
macOS (Swift/Obj-C)	MSAL voor iOS en macOS	MSAL	Zelfstudie			GA
UWP	MSAL.NET	Microsoft.Identity.Client	Zelfstudie			GA
WPF	MSAL.NET	Microsoft.Identity.Client	Zelfstudie			GA

¹Universele licentievoorwaarden voor onlineservices zijn van toepassing op bibliotheken in openbare preview.

Openbare clienttoepassing

Vanuit het oogpunt van code zijn desktoptoepassingen openbare clienttoepassingen. De configuratie verschilt enigszins afhankelijke van of u interactieve verificatie gebruikt of niet.

.NET

U moet MSAL.NET IPublicClientApplication bouwen en aanpassen.

Exclusief per code

Met de volgende code wordt een openbare clienttoepassing gestart, en gebruikers aangemeld in de openbare cloud van Microsoft Azure, met een werk- of schoolaccount, of met hun persoonlijke Microsoft-account.

IPublicClientApplication app = PublicClientApplicationBuilder.Create(clientId)
    .Build();

Als u van plan bent om interactieve verificatie of apparaatcodestroom te gebruiken, gebruikt u de wijzigingsfunctie .WithRedirectUri, zoals eerder getoond.

IPublicClientApplication app;
app = PublicClientApplicationBuilder.Create(clientId)
        .WithDefaultRedirectUri()
        .Build();

Configuratiebestanden gebruiken

Met de volgende code wordt een openbare clienttoepassing gestart vanuit een configuratieobject. Dit kan programmatisch kan worden ingevuld of uit een configuratiebestand worden gelezen.

PublicClientApplicationOptions options = GetOptions(); // your own method
IPublicClientApplication app = PublicClientApplicationBuilder.CreateWithApplicationOptions(options)
        .WithDefaultRedirectUri()
        .Build();

Uitgebreidere configuratie

U kunt de toepassing uitbouwen door een aantal wijzigingsfuncties toe te voegen. Als u bijvoorbeeld wilt dat uw toepassing een toepassing met meerdere tenants is in een nationale cloud (zoals de Amerikaanse overheid in dit voorbeeld), kunt u het volgende schrijven:

IPublicClientApplication app;
app = PublicClientApplicationBuilder.Create(clientId)
        .WithDefaultRedirectUri()
        .WithAadAuthority(AzureCloudInstance.AzureUsGovernment,
                         AadAuthorityAudience.AzureAdMultipleOrgs)
        .Build();

MSAL.NET bevat ook een wijzigingsfunctie voor Active Directory Federation Services 2019:

IPublicClientApplication app;
app = PublicClientApplicationBuilder.Create(clientId)
        .WithAdfsAuthority("https://consoso.com/adfs")
        .Build();

Als u ten slotte tokens wilt verkrijgen voor een Azure AD B2C-tenant (Azure Active Directory), geeft u uw tenant op zoals wordt weergegeven in het volgende codefragment:

IPublicClientApplication app;
app = PublicClientApplicationBuilder.Create(clientId)
        .WithB2CAuthority("https://fabrikamb2c.b2clogin.com/tfp/{tenant}/{PolicySignInSignUp}")
        .Build();

Meer informatie

Voor meer informatie over het configureren van een MSAL.NET desktoptoepassing:

• Zie de referentiedocumentatie PublicClientApplicationBuilderPublicClientApplicationBuilder voor een lijst met alle beschikbare wijzigingsfuncties.
• Zie PublicClientApplicationOptions in de referentiedocumentatie voor een beschrijving van alle opties die worden weergegeven in PublicClientApplicationOptions.

Volledig voorbeeld met configuratieopties

Stel u een .NET-consoletoepassing voor met het volgende appsettings.json configuratiebestand:

{
  "Authentication": {
    "AzureCloudInstance": "AzurePublic",
    "AadAuthorityAudience": "AzureAdMultipleOrgs",
    "ClientId": "00001111-aaaa-2222-bbbb-3333cccc4444"
  },

  "WebAPI": {
    "MicrosoftGraphBaseEndpoint": "https://graph.microsoft.com"
  }
}

U hebt weinig code om in dit bestand te lezen met behulp van het via .NET geleverde configuratieframework:

public class SampleConfiguration
{
 /// <summary>
 /// Authentication options
 /// </summary>
 public PublicClientApplicationOptions PublicClientApplicationOptions { get; set; }

 /// <summary>
 /// Base URL for Microsoft Graph (it varies depending on whether the application runs
 /// in Microsoft Azure public clouds or national or sovereign clouds)
 /// </summary>
 public string MicrosoftGraphBaseEndpoint { get; set; }

 /// <summary>
 /// Reads the configuration from a JSON file
 /// </summary>
 /// <param name="path">Path to the configuration json file</param>
 /// <returns>SampleConfiguration as read from the json file</returns>
 public static SampleConfiguration ReadFromJsonFile(string path)
 {
  // .NET configuration
  IConfigurationRoot Configuration;
  var builder = new ConfigurationBuilder()
                    .SetBasePath(Directory.GetCurrentDirectory())
                    .AddJsonFile(path);
  Configuration = builder.Build();

  // Read the auth and graph endpoint configuration
  SampleConfiguration config = new SampleConfiguration()
  {
   PublicClientApplicationOptions = new PublicClientApplicationOptions()
  };
  Configuration.Bind("Authentication", config.PublicClientApplicationOptions);
  config.MicrosoftGraphBaseEndpoint =
  Configuration.GetValue<string>("WebAPI:MicrosoftGraphBaseEndpoint");
  return config;
 }
}

Schrijf nu de volgende code om uw toepassing te maken:

SampleConfiguration config = SampleConfiguration.ReadFromJsonFile("appsettings.json");
var app = PublicClientApplicationBuilder.CreateWithApplicationOptions(config.PublicClientApplicationOptions)
           .WithDefaultRedirectUri()
           .Build();

Voordat de aanroep bij de .Build() methode wordt uitgevoerd, kunt u de configuratie overschrijven met aanroepen naar .WithXXX methoden, zoals eerder getoond.

Java

Hier volgt de klasse die wordt gebruikt in MSAL Java-ontwikkelvoorbeelden om de voorbeelden te configureren: TestData.

PublicClientApplication pca = PublicClientApplication.builder(CLIENT_ID)
        .authority(AUTHORITY)
        .build();

macOS

Met de volgende code wordt een openbare clienttoepassing gestart, en gebruikers aangemeld in de openbare cloud van Microsoft Azure, met een werk- of schoolaccount, of met hun persoonlijke Microsoft-account.

Snelle configuratie

Objective-C:

NSError *msalError = nil;

MSALPublicClientApplicationConfig *config = [[MSALPublicClientApplicationConfig alloc] initWithClientId:@"<your-client-id-here>"];
MSALPublicClientApplication *application = [[MSALPublicClientApplication alloc] initWithConfiguration:config error:&msalError];

Swift:

let config = MSALPublicClientApplicationConfig(clientId: "<your-client-id-here>")
if let application = try? MSALPublicClientApplication(configuration: config){ /* Use application */}

Uitgebreidere configuratie

U kunt de toepassing uitbouwen door een aantal wijzigingsfuncties toe te voegen. Als u bijvoorbeeld wilt dat uw toepassing een toepassing met meerdere tenants is in een nationale cloud (zoals de Amerikaanse overheid in dit voorbeeld), kunt u het volgende schrijven:

Objective-C:

MSALAADAuthority *aadAuthority =
                [[MSALAADAuthority alloc] initWithCloudInstance:MSALAzureUsGovernmentCloudInstance
                                                   audienceType:MSALAzureADMultipleOrgsAudience
                                                      rawTenant:nil
                                                          error:nil];

MSALPublicClientApplicationConfig *config =
                [[MSALPublicClientApplicationConfig alloc] initWithClientId:@"<your-client-id-here>"
                                                                redirectUri:@"<your-redirect-uri-here>"
                                                                  authority:aadAuthority];

NSError *applicationError = nil;
MSALPublicClientApplication *application =
                [[MSALPublicClientApplication alloc] initWithConfiguration:config error:&applicationError];

Swift:

let authority = try? MSALAADAuthority(cloudInstance: .usGovernmentCloudInstance, audienceType: .azureADMultipleOrgsAudience, rawTenant: nil)

let config = MSALPublicClientApplicationConfig(clientId: "<your-client-id-here>", redirectUri: "<your-redirect-uri-here>", authority: authority)
if let application = try? MSALPublicClientApplication(configuration: config) { /* Use application */}

Node.js

Configuratieparameters kunnen uit veel bronnen worden geladen, zoals een JavaScript-bestand of vanuit omgevingsvariabelen. Hieronder wordt een bestand authConfig.js gebruikt.

/*
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */

const { LogLevel } = require("@azure/msal-node");

/**
 * Configuration object to be passed to MSAL instance on creation.
 * For a full list of MSAL.js configuration parameters, visit:
 * https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/configuration.md
 */
const AAD_ENDPOINT_HOST = "Enter_the_Cloud_Instance_Id_Here"; // include the trailing slash

const msalConfig = {
    auth: {
        clientId: "Enter_the_Application_Id_Here",
        authority: `${AAD_ENDPOINT_HOST}Enter_the_Tenant_Info_Here`,
    },
    system: {
        loggerOptions: {
            loggerCallback(loglevel, message, containsPii) {
                console.log(message);
            },
            piiLoggingEnabled: false,
            logLevel: LogLevel.Verbose,
        },
    },
};

/**
 * Add here the endpoints and scopes when obtaining an access token for protected web APIs. For more information, see:
 * https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/resources-and-scopes.md
 */
const GRAPH_ENDPOINT_HOST = "Enter_the_Graph_Endpoint_Here"; // include the trailing slash

const protectedResources = {
    graphMe: {
        endpoint: `${GRAPH_ENDPOINT_HOST}v1.0/me`,
        scopes: ["User.Read"],
    }
};


module.exports = {
    msalConfig: msalConfig,
    protectedResources: protectedResources,
};

Importeer het configuratieobject uit het bestand authConfig.js. MSAL Node kan minimaal worden geïnitialiseerd zoals hieronder. Bekijk de beschikbare configuratieopties.

const { PublicClientApplication } = require('@azure/msal-node');
const { msalConfig } = require('./authConfig')

/**
* Initialize a public client application. For more information, visit:
* https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/initialize-public-client-application.md
*/
clientApplication = new PublicClientApplication(msalConfig);

Python

config = json.load(open(sys.argv[1]))

app = msal.PublicClientApplication(
    config["client_id"], authority=config["authority"],
    # token_cache=...  # Default cache is in memory only.
                       # You can learn how to use SerializableTokenCache from
                       # https://msal-python.rtfd.io/en/latest/#msal.SerializableTokenCache
    )

Volgende stappen

Ga verder met het volgende artikel in dit scenario: Een token ophalen voor de desktop-app.