Samouczek: Wyodrębnianie danych użytkownika za pomocą Angular SPA

Dotyczy: Najemcy pracowników Najemcy zewnętrzni (dowiedz się więcej)

Ten samouczek jest ostatnią częścią serii, która demonstruje tworzenie jednostronicowej aplikacji angular (SPA) i dodawanie uwierzytelniania przy użyciu platformy tożsamości firmy Microsoft. W części 2 tej serii utworzono SPA Angular i przygotowano je do uwierzytelniania z dzierżawcą dla zespołu.

W tym samouczku nauczysz się

• Dodaj przetwarzanie danych do swojej aplikacji Angular.
• Przetestuj aplikację i wyodrębnij dane użytkownika.

Warunki wstępne

• Samouczek: dodawanie logowania i wylogowywanie się w aplikacji jednostronicowej platformy Angular

Wyodrębnianie danych do wyświetlenia w interfejsie użytkownika aplikacji

dzierżawca zasobów ludzkich

Aby skonfigurować aplikację Angular do interakcji z interfejsem API programu Microsoft Graph, wykonaj następujące kroki:

1. Otwórz plik src/app/profile/profile.component.ts i zastąp zawartość następującym fragmentem kodu:

   // Required for Angular
   import { Component, OnInit } from '@angular/core';
   
   // Required for the HTTP GET request to Graph
   import { HttpClient } from '@angular/common/http';
   
   type ProfileType = {
     businessPhones?: string,
     displayName?: string,
     givenName?: string,
     jobTitle?: string,
     mail?: string,
     mobilePhone?: string,
     officeLocation?: string,
     preferredLanguage?: string,
     surname?: string,
     userPrincipalName?: string,
     id?: string
   }
   
   @Component({
     selector: 'app-profile',
     templateUrl: './profile.component.html'
   })
   export class ProfileComponent implements OnInit {
     profile!: ProfileType;
     tokenExpiration!: string;
   
     constructor(
       private http: HttpClient
     ) { }
   
     // When the page loads, perform an HTTP GET request from the Graph /me endpoint
     ngOnInit() {
       this.http.get('https://graph.microsoft.com/v1.0/me')
         .subscribe(profile => {
           this.profile = profile;
         });
   
       this.tokenExpiration = localStorage.getItem('tokenExpiration')!;
     }
   }
   

   W ramach Angulara ProfileComponent pobiera dane profilu użytkownika z punktu końcowego /me usługi Microsoft Graph. Definiuje ProfileType, aby zdefiniować właściwości struktury, takie jak displayName i mail. W ngOnInitużywa HttpClient do wysyłania żądania GET, przypisując odpowiedź do profile. Pobiera również i przechowuje czas wygaśnięcia tokenu z localStorage w tokenExpiration.

2. Otwórz plik src/app/profile/profile.component.html i zastąp zawartość następującym fragmentem kodu:

   <div class="profile">
       <p><strong>Business Phones:</strong> {{profile?.businessPhones}}</p>
       <p><strong>Display Name:</strong> {{profile?.displayName}}</p>
       <p><strong>Given Name:</strong> {{profile?.givenName}}</p>
       <p><strong>Job Title:</strong> {{profile?.jobTitle}}</p>
       <p><strong>Mail:</strong> {{profile?.mail}}</p>
       <p><strong>Mobile Phone:</strong> {{profile?.mobilePhone}}</p>
       <p><strong>Office Location:</strong> {{profile?.officeLocation}}</p>
       <p><strong>Preferred Language:</strong> {{profile?.preferredLanguage}}</p>
       <p><strong>Surname:</strong> {{profile?.surname}}</p>
       <p><strong>User Principal Name:</strong> {{profile?.userPrincipalName}}</p>
       <p><strong>Profile Id:</strong> {{profile?.id}}</p>
       <br><br>
       <p><strong>Token Expiration:</strong> {{tokenExpiration}}</p>
       <br><br>
       <p>Refreshing this page will continue to use the cached access token until it nears expiration, at which point a new access token will be requested.</p>
   </div>
   

   Ten kod definiuje szablon HTML, który wyświetla informacje o profilu użytkownika przy użyciu składni interpolacji platformy Angular w celu powiązania właściwości z obiektu profile (na przykład businessPhones, displayName, jobTitle). Pokazuje również wartość tokenExpiration i zawiera notatkę z informacją, że odświeżanie strony będzie używać buforowanego tokenu dostępu do momentu zbliżania się do wygaśnięcia, po którym zostanie zażądany nowy token.

zewnętrzny najemca

Skonfigurujesz aplikację Angular tak, aby wyświetlała twierdzenia w ID tokenie przy logowaniu.

1. Utwórz plik o nazwie claim-utils.ts w folderze src/app/ i wklej do niego następujący fragment kodu.

   /**
    * Populate claims table with appropriate description
    * @param {Record} claims ID token claims
    * @returns claimsTable
    */
   export const createClaimsTable = (claims: Record<string, string>): any[] => {
     const claimsTable: any[] = [];
   
     Object.keys(claims).map((key) => {
       switch (key) {
         case 'aud':
           populateClaim(
             key,
             claims[key],
             "Identifies the intended recipient of the token. In ID tokens, the audience is your app's Application ID, assigned to your app in the Azure portal.",
             claimsTable
           );
           break;
         case 'iss':
           populateClaim(
             key,
             claims[key],
             'Identifies the issuer, or authorization server that constructs and returns the token. It also identifies the Azure AD tenant for which the user was authenticated. If the token was issued by the v2.0 endpoint, the URI will end in /v2.0.',
             claimsTable
           );
           break;
         case 'iat':
           populateClaim(
             key,
             changeDateFormat(+claims[key]),
             '"Issued At" indicates the timestamp (UNIX timestamp) when the authentication for this user occurred.',
             claimsTable
           );
           break;
         case 'nbf':
           populateClaim(
             key,
             changeDateFormat(+claims[key]),
             'The nbf (not before) claim dictates the time (as UNIX timestamp) before which the JWT must not be accepted for processing.',
             claimsTable
           );
           break;
         case 'exp':
           populateClaim(
             key,
             changeDateFormat(+claims[key]),
             "The exp (expiration time) claim dictates the expiration time (as UNIX timestamp) on or after which the JWT must not be accepted for processing. It's important to note that in certain circumstances, a resource may reject the token before this time. For example, if a change in authentication is required or a token revocation has been detected.",
             claimsTable
           );
           break;
         case 'name':
           populateClaim(
             key,
             claims[key],
             "The name claim provides a human-readable value that identifies the subject of the token. The value isn't guaranteed to be unique, it can be changed, and it's designed to be used only for display purposes. The 'profile' scope is required to receive this claim.",
             claimsTable
           );
           break;
         case 'preferred_username':
           populateClaim(
             key,
             claims[key],
             'The primary username that represents the user. It could be an email address, phone number, or a generic username without a specified format. Its value is mutable and might change over time. Since it is mutable, this value must not be used to make authorization decisions. It can be used for username hints, however, and in human-readable UI as a username. The profile scope is required in order to receive this claim.',
             claimsTable
           );
           break;
         case 'nonce':
           populateClaim(
             key,
             claims[key],
             'The nonce matches the parameter included in the original /authorize request to the IDP.',
             claimsTable
           );
           break;
         case 'oid':
           populateClaim(
             key,
             claims[key],
             'The oid (user object id) is the only claim that should be used to uniquely identify a user in an Azure AD tenant.',
             claimsTable
           );
           break;
         case 'tid':
           populateClaim(
             key,
             claims[key],
             'The id of the tenant where this application resides. You can use this claim to ensure that only users from the current Azure AD tenant can access this app.',
             claimsTable
           );
           break;
         case 'upn':
           populateClaim(
             key,
             claims[key],
             'upn (user principal name) might be unique amongst the active set of users in a tenant but tend to get reassigned to new employees as employees leave the organization and others take their place or might change to reflect a personal change like marriage.',
             claimsTable
           );
           break;
         case 'email':
           populateClaim(
             key,
             claims[key],
             'Email might be unique amongst the active set of users in a tenant but tend to get reassigned to new employees as employees leave the organization and others take their place.',
             claimsTable
           );
           break;
         case 'acct':
           populateClaim(
             key,
             claims[key],
             'Available as an optional claim, it lets you know what the type of user (homed, guest) is. For example, for an individuals access to their data you might not care for this claim, but you would use this along with tenant id (tid) to control access to say a company-wide dashboard to just employees (homed users) and not contractors (guest users).',
             claimsTable
           );
           break;
         case 'sid':
           populateClaim(
             key,
             claims[key],
             'Session ID, used for per-session user sign-out.',
             claimsTable
           );
           break;
         case 'sub':
           populateClaim(
             key,
             claims[key],
             'The sub claim is a pairwise identifier - it is unique to a particular application ID. If a single user signs into two different apps using two different client IDs, those apps will receive two different values for the subject claim.',
             claimsTable
           );
           break;
         case 'ver':
           populateClaim(
             key,
             claims[key],
             'Version of the token issued by the Microsoft identity platform',
             claimsTable
           );
           break;
         case 'login_hint':
           populateClaim(
             key,
             claims[key],
             'An opaque, reliable login hint claim. This claim is the best value to use for the login_hint OAuth parameter in all flows to get SSO.',
             claimsTable
           );
           break;
         case 'idtyp':
           populateClaim(
             key,
             claims[key],
             'Value is app when the token is an app-only token. This is the most accurate way for an API to determine if a token is an app token or an app+user token',
             claimsTable
           );
           break;
         case 'uti':
         case 'rh':
           break;
         default:
           populateClaim(key, claims[key], '', claimsTable);
       }
     });
   
     return claimsTable;
   };
   
   /**
    * Populates claim, description, and value into an claimsObject
    * @param {String} claim
    * @param {String} value
    * @param {String} description
    * @param {Array} claimsObject
    */
   const populateClaim = (
     claim: string,
     value: string,
     description: string,
     claimsTable: any[]
   ): void => {
     claimsTable.push({
       claim: claim,
       value: value,
       description: description,
     });
   };
   
   /**
    * Transforms Unix timestamp to date and returns a string value of that date
    * @param {number} date Unix timestamp
    * @returns
    */
   const changeDateFormat = (date: number) => {
     let dateObj = new Date(date * 1000);
     return `${date} - [${dateObj.toString()}]`;
   };
   

2. Otwórz src/index.html i zastąp kod poniższym fragmentem kodu.

   <!doctype html>
   <html lang="en">
   <head>
     <meta charset="utf-8">
     <title>Microsoft identity platform</title>
     <base href="/">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <link rel="icon" type="image/x-icon" href="favicon.svg">
     <link rel="preconnect" href="https://fonts.gstatic.com">
     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
     <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
   </head>
   <body class="mat-typography">
     <app-root></app-root>
     <app-redirect></app-redirect>
   </body>
   </html>
   

3. Otwórz plik src/app/guarded/guarded.component.ts i zastąp istniejący kod poniższym fragmentem kodu.

   import { Component, OnInit } from '@angular/core';
   
   @Component({
     selector: 'app-guarded',
     templateUrl: './guarded.component.html',
     styleUrls: ['./guarded.component.css']
   })
   export class GuardedComponent implements OnInit {
   
     constructor() { }
   
     ngOnInit(): void {
     }
   
   }
   

Testowanie aplikacji

Aby aplikacja działała, musisz uruchomić aplikację Angular i zalogować się, aby uwierzytelnić się za pomocą dzierżawy Microsoft Entra i wyodrębnić dane użytkowników.

dzierżawca zasobów ludzkich

Aby przetestować aplikację, wykonaj następujące kroki:

1. Uruchom aplikację Angular, wykonując następujące polecenie w terminalu:

   ng serve --open
   

2. Wybierz przycisk Zaloguj się do, aby uwierzytelnić się w dzierżawie Microsoft Entra.

3. Po zalogowaniu się, wybierz link Wyświetl profil, aby przejść do strony profilu. Sprawdź, czy są wyświetlane informacje o profilu użytkownika, w tym imię i nazwisko użytkownika, adres e-mail, stanowisko i inne szczegóły.

   

4. Wybierz przycisk Wyloguj się, aby wylogować się z aplikacji.

zewnętrzny najemca

1. Uruchom serwer internetowy, uruchamiając następujące polecenia w wierszu polecenia z folderu aplikacji:

   npm install
   npm start
   

2. W przeglądarce wprowadź http://localhost:4200, aby otworzyć aplikację.

   

3. Wybierz przycisk Zaloguj się w prawym górnym rogu ekranu.

4. Po zalogowaniu na stronie zostaną wyświetlone informacje o profilu.

   

5. Wybierz przycisk Wyloguj w prawym górnym rogu ekranu, aby się wylogować.

Następne kroki

Dowiedz się, jak używać platformy tożsamości firmy Microsoft, korzystając z poniższej serii samouczków, aby dowiedzieć się, jak utworzyć internetowy interfejs API.

samouczek : rejestrowanie internetowego interfejsu API za pomocą platformy tożsamości firmy Microsoft