Webes API-kat hívó asztali alkalmazás: Kódkonfiguráció

Most, hogy létrehozta az alkalmazást, megtudhatja, hogyan konfigurálhatja a kódot az alkalmazás koordinátáival.

Asztali alkalmazásokat támogató Microsoft-kódtárak

A következő Microsoft-kódtárak támogatják az asztali alkalmazásokat:

Nyelv/ keretrendszer	Projekt bekapcsolva GitHub	Csomag	Megszerzés közül	Felhasználók bejelentkezése	Webes API-k elérése	Általánosan elérhető (GA) vagy 1. nyilvános előzetes verzió
Electron	MSAL Node.js	msal-node	—			Nyilvános előzetes verzió
Java	MSAL4J	msal4j	—			FE
macOS (Swift/Obj-C)	MSAL iOS-hez és macOS-hez	MSAL	Oktatóanyag			FE
UWP	MSAL.NET	Microsoft.Identity.Client	Oktatóanyag			FE
WPF	MSAL.NET	Microsoft.Identity.Client	Oktatóanyag			FE

¹ Az online szolgáltatásokra vonatkozó univerzális licencfeltételek nyilvános előzetes verziójú kódtárakra vonatkoznak.

Nyilvános ügyfélalkalmazás

Kód szempontjából az asztali alkalmazások nyilvános ügyfélalkalmazások. A konfiguráció kissé eltérő lesz attól függően, hogy interaktív hitelesítést használ-e.

.NET

Létre kell készítenie és módosítania kell MSAL.NET IPublicClientApplication.

Kizárólag kód alapján

Az alábbi kód létrehoz egy nyilvános ügyfélalkalmazást, és munkahelyi vagy iskolai fiókkal vagy személyes Microsoft-fiókkal jelentkezik be a felhasználókba a Microsoft Azure nyilvános felhőben.

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

Ha interaktív hitelesítést vagy eszközkód-folyamatot szeretne használni, ahogy korábban láttuk, használja a .WithRedirectUri módosítót.

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

Konfigurációs fájlok használata

Az alábbi kód létrehoz egy nyilvános ügyfélalkalmazást egy konfigurációs objektumból, amely programozott módon tölthető ki, vagy egy konfigurációs fájlból olvasható.

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

Részletesebb konfiguráció

Az alkalmazás felépítését több módosító hozzáadásával is kidolgozhatja. Ha például azt szeretné, hogy az alkalmazás több-bérlős alkalmazás legyen egy nemzeti felhőben, például az ITT látható US Government, a következőt írhatja:

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

MSAL.NET a 2019-Active Directory összevonási szolgáltatások (AD FS) módosító is:

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

Végül, ha jogkivonatokat szeretne beszerezni egy Azure Active Directory (Azure AD) B2C-bérlőhöz, adja meg a bérlőt az alábbi kódrészletben látható módon:

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

További információ

További információ az asztali MSAL.NET konfigurálásáról:

• Az összes elérhető módosító PublicClientApplicationBuilderlistáját a PublicClientApplicationBuilder referenciadokumentációjában találja.
• A rendelkezésre álló PublicClientApplicationOptionslehetőségek leírását a referenciadokumentáció PublicClientApplicationOptions című szakaszában találja.

Teljes példa a konfigurációs beállításokkal

Képzeljen el egy .NET-konzolalkalmazást, amely a következő appsettings.json konfigurációs fájllal rendelkezik:

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

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

Kevés kódot kell olvasnia ebben a fájlban a . NET által biztosított konfigurációs keretrendszer:

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;
 }
}

Az alkalmazás létrehozásához írja be a következő kódot:

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

A metódus hívása .Build() előtt felülbírálhatja a konfigurációt metódusokra irányuló .WithXXX hívásokkal, ahogy azt korábban láttuk.

Java

Az alábbiakban az MSAL Java-fejlesztési mintákban használt osztályt használjuk a minták konfigurálásához: TestData.

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

MacOS

Az alábbi kód létrehoz egy nyilvános ügyfélalkalmazást, és munkahelyi vagy iskolai fiókkal vagy személyes Microsoft-fiókkal jelentkezik be a felhasználókba a Microsoft Azure nyilvános felhőben.

Gyorskonfiguráció

Objective-C:

NSError *msalError = nil;

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

Gyors:

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

Részletesebb konfiguráció

Az alkalmazás felépítését több módosító hozzáadásával is kidolgozhatja. Ha például azt szeretné, hogy az alkalmazás több-bérlős alkalmazás legyen egy nemzeti felhőben, például az ITT látható US Government, a következőt írhatja:

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];

Gyors:

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

A konfigurációs paraméterek számos forrásból betölthetők, például JavaScript-fájlból vagy környezeti változókból. Az alábbiakban egy authConfig.js fájlt használunk.

/*
 * 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,
};

Importálja a konfigurációs objektumot authConfig.js fájlból. Az MSAL-csomópont minimálisan inicializálható az alábbiak szerint. Tekintse meg a rendelkezésre álló konfigurációs beállításokat.

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
    )

Következő lépések

Lépjen tovább a következő cikkre ebben a forgatókönyvben, és szerezze be az asztali alkalmazás jogkivonatát.