Skapa och hantera OAuth-klienter

OAuth-omfattningar och behörigheter

OAuth-omfattningar definierar den behörighetsnivå som beviljas till OAuth-klientapplikationer. Till exempel kan en åtkomsttoken tillåta full åtkomst till resurser eller begränsa den till skrivskyddad åtkomst. I Qlik Cloud styr omfattningar klientens åtkomst till tillgänglig funktionalitet och resurser. Utan omfattningar kan klienter inte få åtkomst till några resurser.

Tillgängliga OAuth-omfattningar

Tabellen listar tillgängliga omfattningar och deras tillhörande behörigheter:

Skapa OAuth-klienter

Klientorganisationsadministratörer hanterar OAuth-klienter i aktivitetscentret Administration på sidan OAuth. Med en OAuth-klient kan du integrera din klientapplikation med Qlik Cloud för att få åtkomst till resurser på ett säkert sätt.

Steg för att skapa en OAuth-klient

Gör följande:

1. I aktivitetscentret Administration går du till OAuth.

2. Klicka på Skapa ny.

3. Välj en klienttyp:

   • Webb för konfidentiella klienter.

   • Ensidesapp eller Inbyggd för offentliga klienter.

   • Anonym inbäddning för offentliga klienter.

4. I dialogrutan anger du ett namn för OAuth-klienten.

5. Lägg eventuellt till en beskrivning.

6. Välj någon av de tillgängliga omfattningarna genom att antingen rulla eller använda sökfältet.

   Anteckning om tipsAnvänd knapparna Alla och Valda för att visa alla omfattningar eller endast de valda.

7. Ange en eller flera omdirigerings-URL:er för OAuth-klientapplikationen (högst 5). Klicka sedan på Lägg till för att lägga till omdirigerings-URL:en i tillåtelselistan.

   • Omdirigerings-URL:en är dit auktoriseringsservern skickar användarens webbläsare efter att ha autentiserat och beviljat behörighet till klientapplikationen. Till exempel https://www.exampleapp.com/oauth/callback, där /oauth/callback hanterar autentiseringsåteranrop från OAuth-leverantören.

   • Qlik Cloud omdirigerar användaren tillbaka till applikationen efter en framgångsrik auktorisering endast om dess URL finns i tillåtelselistan för omdirigerings-URL:er.

   • URL:er måste börja med https:// såvida inte domänen är localhost, i vilket fall den kan börja med http://. Inbyggda applikationer kan också använda det applikationsspecifika länkformatet, till exempel exampleapp://.

8. För klienttyperna Webb eller Ensidesapp anger du ett eller flera tillåtna ursprung (högst 5).

   • Åtkomst till applikationen beviljas endast om URL:en läggs till i listan över tillåtna ursprung.

9. För klienttypen Webb kan du aktivera ett av följande alternativ för automatiserad systemåtkomst utan användarinteraktion:

   • Tillåt maskin-till-maskin (M2M): Möjliggör system-till-system-kommunikation utan användarinblandning.

   • Tillåt M2M-användarimitation: Tillåter din applikation att autentisera å användares vägnar och agera som dem under autentiseringsprocessen.

10. För klienttypen Webb väljer du ett eller båda alternativen under Autentiseringsmetod:

    • Klienthemlighet (standard)

    • Privat nyckel-JWT, ett säkrare alternativ som autentiserar klienten med hjälp av ett offentligt/privat nyckelpar istället för en delad hemlighet.

      • När du väljer Privat nyckel-JWT visas fältet Offentlig nyckel. Ange din tredjepartsapplikations offentliga nyckel i JSON Web Key-format (JWK). Den privata nyckeln stannar hos din applikation för att signera JWT:er. För mer information om formatet för den offentliga nyckeln, se Create a public/private key pair for signing JWTs på Qlik Developer Portal.

        Anteckning om informationDen offentliga nyckeln beror på din identitetsleverantörs krav. Om din tredjepartsapplikations offentliga nyckel har ett annat format använder du ett tredjepartsverktyg för att konvertera den till JWK.

11. Klicka på Skapa.

12. Klicka på Kopiera till Urklipp för att spara klient-ID:t och klienthemligheten för senare användning. Förvara klienthemligheten på ett säkert sätt.

    Anteckning om informationOffentliga klienter har ingen klienthemlighet.

13. Klicka på Klar.

OAuth-klienter för specifika användningsfall

För användningsfall för OAuth-klienter, se följande resurser:

• OAuth Overview på Qlik Developer Portal: Översikt över OAuth-användningsfall och de olika OAuth-typerna.

• Skapa OAuth-klienter för Qlik-tillägg för Microsoft Office: Konfigurera en OAuth-klient för installation av Qlik-tillägget för Microsoft Excel.

• Skapa en OAuth-klient för anonyma inbäddningar av applikationsinnehåll: Skapa en OAuth-klient för att möjliggöra anonym åtkomst till inbäddat applikationsinnehåll.

För att bädda in applikationsinnehåll för anonym åtkomst med qlik-embed måste du skapa en OAuth-klient med en typ som är specifikt utformad för detta användningsfall.

Gör följande:

1. I aktivitetscentret Administration går du till delavsnittet OAuth.

2. Klicka på Skapa ny.

3. I rullgardinsmenyn Klienttyp väljer du Anonym inbäddning.

4. Ange ett Namn och eventuellt en Beskrivning för OAuth-klienten.

5. Under Tillåtna ursprung anger du varje ursprung som du behöver auktorisera. Dessa är de domäner som kommer att få åtkomst till Qlik Cloud-klientorganisationen för att hämta informationen för den inbäddade analysen.

   Klicka på Lägg till efter att ha infogat varje URL.

6. När du är klar klickar du på Skapa.

7. Klicka på Kopiera till Urklipp för att spara klient-ID:t för senare användning. Det kommer att behövas när applikationsinnehållet bäddas in med qlik-embed.

8. Klicka på Klar.

Redigera OAuth-klienter

Du kan byta namn på en OAuth-klient, uppdatera beskrivningen eller hantera omdirigerings-URL:erna.

Gör följande:

1. I aktivitetscentret Administration går du till OAuth.
2. Leta reda på den OAuth-klient som du vill redigera.
3. Klicka på och välj sedan Redigera.
4. Ändra alternativen för OAuth-klienten efter behov.
5. Klicka på Spara.

Ta bort OAuth-klienter

Du kan ta bort en OAuth-klient när den inte längre behövs eller för att återkalla åtkomst.

Gör följande:

1. I aktivitetscentret Administration går du till OAuth.

2. Välj en eller flera OAuth-klienter som du vill ta bort och klicka sedan på Ta bort.

3. Bekräfta borttagningen.

Publicera OAuth-klienter

OAuth-klienter är initialt bundna till den klientorganisation som skapade dem. Du kan dock konfigurera en OAuth-klient så att den delas mellan flera klientorganisationer inom samma region. Detta gör det möjligt för tredjepartsapplikationer att använda samma klient-ID över olika Qlik Cloud-klientorganisationer.

Applikationsägare kan rotera hemligheter och uppdatera konfigurationen utan interaktion från en klientorganisationsadministratör. Klientorganisationsadministratörer behöver inte hantera inloggningsuppgifter eller vara medvetna om några konfigurationsdetaljer för den publicerade klienten.

För att tillåta andra klientorganisationer att ansluta till en OAuth-klient måste du publicera den.

Gör följande:

1. I aktivitetscentret Administration går du till OAuth.
2. Leta reda på den OAuth-klient som du vill publicera.
3. Klicka på bredvid klienten och välj Publicera.
4. Klicka på Publicera för att bekräfta.

När OAuth-klienten har publicerats blir den tillgänglig för extern användning av andra klientorganisationer. När en användare besöker en extern webbplats som använder denna OAuth-klient kommer de att uppmanas att ange sin klientorganisations värdnamn och användaruppgifter, såvida de inte redan har en aktiv SaaS-session.

Den första inloggningen kräver samtycke från en klientorganisationsadministratör. När den har godkänts kommer OAuth-klienten att visas i aktivitetscentret Administration för klientorganisationen.

Samtyckesmetoder

Som standard uppmanar Qlik Cloud användare om samtycke vid autentisering. För att effektivisera processen, särskilt för betrodda applikationer, kan du ställa in samtyckesmetoden till "Betrodd", vilket hoppar över samtyckesuppmaningen.

Det finns två alternativ för samtycke:

• Krävs: Användaren uppmanas om samtycke varje gång en ny omfattning begärs av OAuth-klienten. Denna metod säkerställer uttryckligt användargodkännande för varje behörighetsnivå.

• Betrodd: Användaren uppmanas inte om samtycke. Detta alternativ är endast tillgängligt för opublicerade klienter. För publicerade klienter är samtyckesmetoden alltid Krävs för att upprätthålla säkerheten över flera klientorganisationer.

Ändra samtyckesmetoden

Gör följande för att ändra samtyckesmetoden för en OAuth-klient:

1. I aktivitetscentret Administration går du till OAuth.
2. På OAuth-klienten klickar du på och väljer Ändra samtyckesmetod.
3. Välj Krävs eller Betrodd och klicka sedan på Ändra samtyckesmetod.

Visa och kopiera OAuth-konfigurationen

I delavsnittet OAuth i aktivitetscentret Administration väljer du Visa OAuth-konfiguration för att visa autentiseringsdetaljer för din Qlik Cloud-klientorganisation. Detta visar ett kodavsnitt med OAuth-slutpunkter och inställningar, samt en URL som du kan kopiera för användning i externa applikationer.

Du kan använda denna konfiguration för att integrera Qlik Cloud med tredjepartsapplikationer, automatisera API-åtkomst eller konfigurera autentisering för inbäddad analys.

Hantera klienthemligheter

Om en klienthemlighet äventyras eller om din säkerhetspolicy kräver regelbundna uppdateringar kan du lägga till eller ta bort hemligheter. För att undvika driftstopp kan du lägga till flera klienthemligheter (högst 5), uppdatera din klientapplikation och sedan ta bort den gamla hemligheten.

Lägga till en klienthemlighet

Gör följande:

1. I aktivitetscentret Administration går du till OAuth.
2. Leta reda på OAuth-klienten.
3. Klicka på och välj Hantera hemligheter.
4. Klicka på Generera en ny klienthemlighet.

5. Kopiera klienthemligheten och klient-ID:t och förvara dem på ett säkert sätt.

   Anteckning om informationDu kommer inte att kunna komma åt klienthemligheten senare.
6. Klicka på Stäng.

Ta bort en klienthemlighet

Gör följande:

1. I aktivitetscentret Administration går du till OAuth.
2. Leta reda på OAuth-klienten.
3. Klicka på och välj Hantera hemligheter.
4. Klicka på bredvid klienthemligheten.
5. Klicka på Stäng.

Efter att ha registrerat en OAuth-klient med Qlik Cloud kan du bygga OAuth-klientapplikationer för att få åtkomst till Qlik Cloud-innehåll. Använd det tillhörande klient-ID:t och klienthemligheten i din applikation.

För steg-för-steg-vägledning, se handledningarna i delavsnittet OAuth Overview på Qlik Developer Portal. Dessa handledningar täcker hur man bygger klientapplikationer med hjälp av populära programmeringsspråk.