Logga in användare och anropa ett API i en Android-exempelmobilapp med inbyggd autentisering

  • Artikel

Den här artikeln visar hur du konfigurerar ett Android-exempelprogram för att anropa ett ASP.NET Core-webb-API.

Förutsättningar

Registrera ett webb-API-program

  1. Logga in på administrationscentret för Microsoft Entra som minst programutvecklare.

  2. Om du har åtkomst till flera klienter använder du ikonen Inställningar på den översta menyn för att växla till din externa klient från menyn Kataloger + prenumerationer.

  3. Bläddra till Identitetsprogram>> Appregistreringar.

  4. Välj + Ny registrering.

  5. På sidan Registrera ett program som visas anger du programmets registreringsinformation:

    1. I avsnittet Namn anger du ett beskrivande programnamn som ska visas för appens användare, till exempel ciam-ToDoList-api.

    2. Under Kontotyper som stöds väljer du Endast Konton i den här organisationskatalogen.

  6. Välj Registrera för att skapa programmet.

  7. Programmets översiktsfönster visas när registreringen är klar. Registrera katalog-ID:t (klient)-ID:t och program-ID:t (klient) som ska användas i programmets källkod.

Konfigurera API-omfång

Ett API måste publicera minst ett omfång, även kallat Delegerad behörighet, för att klientapparna ska få en åtkomsttoken för en användare. Följ dessa steg för att publicera ett omfång:

  1. På sidan Appregistreringar väljer du det API-program som du skapade (ciam-ToDoList-api) för att öppna sidan Översikt.

  2. Under Hantera väljer du Exponera ett API.

  3. Längst upp på sidan bredvid Program-ID-URI väljer du länken Lägg till för att generera en URI som är unik för den här appen.

  4. Acceptera den föreslagna program-ID-URI:n, till exempel api://{clientId}, och välj Spara. När ditt webbprogram begär en åtkomsttoken för webb-API:et läggs URI:n till som prefix för varje omfång som du definierar för API:et.

  5. Under Omfång som definieras av det här API:et väljer du Lägg till ett omfång.

  6. Ange följande värden som definierar läsbehörighet till API:et och välj sedan Lägg till omfång för att spara ändringarna:

    Property Värde
    Omfattningsnamn ToDoList.Read
    Vem kan ge medgivande Endast administratörer
    Visningsnamn för administratörsmedgivande Läsa användarnas ToDo-lista med hjälp av "TodoListApi"
    Beskrivning av administratörsmedgivande Tillåt att appen läser användarens ToDo-lista med hjälp av "TodoListApi".
    Tillstånd Aktiverad

  7. Välj Lägg till ett omfång igen och ange följande värden som definierar ett läs- och skrivåtkomstomfång till API:et. Välj Lägg till omfång för att spara ändringarna:

    Property Värde
    Omfattningsnamn ToDoList.ReadWrite
    Vem kan ge medgivande Endast administratörer
    Visningsnamn för administratörsmedgivande Läsa och skriva användares ToDo-lista med hjälp av "ToDoListApi"
    Beskrivning av administratörsmedgivande Tillåt att appen läser och skriver användarens ToDo-lista med hjälp av ToDoListApi
    Tillstånd Aktiverad

  8. Under Hantera väljer du Manifest för att öppna API-manifestredigeraren.

  9. Ange accessTokenAcceptedVersion egenskapen till 2.

  10. Välj Spara.

Läs mer om principen om lägsta behörighet när du publicerar behörigheter för ett webb-API.

Konfigurera approller

Ett API måste publicera minst en approll för program, även kallat Programbehörighet, för att klientapparna ska få en åtkomsttoken som sig själva. Programbehörigheter är den typ av behörigheter som API:er bör publicera när de vill att klientprogram ska kunna autentiseras som sig själva och inte behöver logga in användare. Följ dessa steg för att publicera en programbehörighet:

  1. På sidan Appregistreringar väljer du det program som du skapade (till exempel ciam-ToDoList-api) för att öppna sidan Översikt.

  2. Under Hantera väljer du Approller.

  3. Välj Skapa approll och ange sedan följande värden och välj sedan Använd för att spara ändringarna:

    Property Värde
    Visningsnamn ToDoList.Read.All
    Tillåtna medlemstyper Appar
    Värde ToDoList.Read.All
    beskrivning Tillåt att appen läser alla användares ToDo-lista med hjälp av TodoListApi

  4. Välj Skapa approll igen och ange sedan följande värden för den andra approllen och välj sedan Använd för att spara ändringarna:

    Property Värde
    Visningsnamn ToDoList.ReadWrite.All
    Tillåtna medlemstyper Appar
    Värde ToDoList.ReadWrite.All
    beskrivning Tillåt att appen läser och skriver alla användares ToDo-lista med hjälp av ToDoListApi

Konfigurera valfria anspråk

Du kan idtypa valfritt anspråk för att hjälpa webb-API:et att avgöra om en token är en apptoken eller en app + användartoken. Även om du kan använda en kombination av scp - och rollanspråk för samma ändamål är det enklaste sättet att skilja en apptoken och en app + användartoken åt med hjälp av idtyp-anspråket . Till exempel är värdet för det här anspråket app när token är en endast apptoken.

Bevilja API-behörigheter till Android-exempelappen

När du har registrerat både klientappen och webb-API:et och du har exponerat API:et genom att skapa omfång kan du konfigurera klientens behörigheter till API:et genom att följa dessa steg:

  1. På sidan Appregistreringar väljer du det program som du skapade (till exempel ciam-client-app) för att öppna sidan Översikt.

  2. Under Hantera väljer du API-behörigheter.

  3. Under Konfigurerade behörigheter väljer du Lägg till en behörighet.

  4. Välj fliken API:er som min organisation använder .

  5. I listan över API:er väljer du API:et, till exempel ciam-ToDoList-api.

  6. Välj alternativet Delegerade behörigheter .

  7. I behörighetslistan väljer du ToDoList.Read, ToDoList.ReadWrite (använd sökrutan om det behövs).

  8. Välj knappen Lägg till behörigheter.

  9. Nu har du tilldelat behörigheterna korrekt. Men eftersom klientorganisationen är en kunds klientorganisation kan konsumentanvändarena själva inte samtycka till dessa behörigheter. För att åtgärda detta måste du som administratör samtycka till dessa behörigheter för alla användare i klientorganisationen:

    1. Välj Bevilja administratörsmedgivande för <ditt klientnamn> och välj sedan Ja.

    2. Välj Uppdatera och kontrollera sedan att Beviljat för <klientorganisationens namn> visas under Status för båda behörigheterna.

  10. I listan Konfigurerade behörigheter väljer du behörigheterna ToDoList.Read och ToDoList.ReadWrite, en i taget, och kopierar sedan behörighetens fullständiga URI för senare användning. Den fullständiga behörighets-URI:n ser ut ungefär api://{clientId}/{ToDoList.Read} som eller api://{clientId}/{ToDoList.ReadWrite}.

Klona eller ladda ned exempelwebb-API

Om du vill hämta exempelprogrammet kan du antingen klona det från GitHub eller ladda ned det som en .zip fil.

  • Om du vill klona exemplet öppnar du en kommandotolk och navigerar till den platsen där du vill skapa projektet och anger följande kommando:

    git clone https://github.com/Azure-Samples/ms-identity-ciam-dotnet-tutorial.git

  • Ladda ned filen .zip. Extrahera den till en filsökväg där namnets längd är färre än 260 tecken.

Konfigurera och köra exempelwebb-API

  1. Öppna 2-Authorization/1-call-own-api-aspnet-core-mvc/ToDoListAPI/appsettings.json filen i kodredigeraren.

  2. Hitta platshållaren:

    • Enter_the_Application_Id_Here och ersätt det med program-ID :t (klient) för webb-API:et som du kopierade tidigare.
    • Enter_the_Tenant_Id_Hereoch ersätt det med katalog-ID:t (klientorganisation) som du kopierade tidigare.
    • Enter_the_Tenant_Subdomain_Here och ersätt den med underdomänen Katalog (klientorganisation). Om din primära klientdomän till exempel är contoso.onmicrosoft.comanvänder du contoso. Om du inte har ditt klientnamn kan du läsa klientinformationen.

Du måste vara värd för ditt webb-API för att Android-exempelappen ska kunna anropa den. Följ snabbstart: Distribuera en ASP.NET webbapp för att distribuera ditt webb-API.

Konfigurera Android-exempelmobilapp för att anropa webb-API

Med exemplet kan du konfigurera flera webb-API URL-slutpunkter och uppsättningar med omfång. I det här fallet konfigurerar du bara en URL-slutpunkt för webb-API:et och dess associerade omfång.

  1. Öppna /app/src/main/java/com/azuresamples/msalnativeauthandroidkotlinsampleapp/AccessApiFragment.kt filen i Android Studio.

  2. Hitta egenskapen med namnet WEB_API_URL_1 och ange URL:en till webb-API:et.

    private const val WEB_API_URL_1 = "" // Developers should set the respective URL of their web API here

  3. Hitta egenskapen med namnet scopesForAPI1 och ange omfången som registrerats i Bevilja API-behörigheter till Android-exempelappen.

    private val scopesForAPI1 = listOf<String>() // Developers should set the respective scopes of their web API here. For example, private val scopes = listOf<String>("api://{clientId}/{ToDoList.Read}", "api://{clientId}/{ToDoList.ReadWrite}")

Kör Android-exempelappen och anropa webb-API

Följ dessa steg för att skapa och köra din app:

  1. I verktygsfältet väljer du din app på menyn Kör konfigurationer.

  2. I målenhetsmenyn väljer du den enhet som du vill köra appen på.

    Om du inte har konfigurerat några enheter måste du antingen skapa en virtuell Android-enhet för att använda Android-emulatorn eller ansluta en fysisk enhet.

  3. Välj knappen Kör . Appen öppnas på skärmen e-post och engångslösenord.

  4. Välj fliken API för att testa API-anropet. Ett lyckat anrop till webb-API:et returnerar HTTP 200, medan HTTP 403 betyder obehörig åtkomst.

Nästa steg