JWT SSO instellen

Plannen die single sign on (SSO) ondersteunen

Wat is een JWT?

Een JSON Web Token (JWT) is een versleuteld tokenformaat dat gegevens zoals inloggegevens (verificatie en autorisatie) veilig overdraagt tussen twee toepassingen. JWT wordt specifiek gebruikt om aanmeldingen van lezers in Document360 te verifiëren. Klik hier om meer te lezen over JWT.

Eenmalige aanmelding voor ondernemingen met behulp vanJWT

Document360 gebruikt een aanpak die vergelijkbaar is met PKCE (Proof Key for Code Exchange, een veilige OAuth-methode) om het JWT-token te genereren.

Het onderstaande diagram op hoog niveau laat zien hoe uJWT authenticatiestroom in Document360 kunt bereiken.

Stappen in de JWT authenticatiestroom

1. Wanneer de eindgebruiker toegang probeert te krijgen tot de kennisbank die is geconfigureerd met JWT, zal de Document360-kennisbank de eindgebruiker omleiden naar de inlog-URL die het teamaccount heeft geconfigureerd in de instellingen van Document360 JWT.

   Ervan uitgaande dat de geconfigureerde aanmeldings-URL zich in de klanttoepassing bevindt, waarvoor verificatie is vereist.

2. Door het inlogeindpunt in de klanttoepassing aan te roepen, wordt de inloglogica aangeroepen, die een verzoek verzendt met:

   • Gegevens van de gebruiker

   • Client-ID en clientgeheim naar de URL voor het genereren van de identiteitsservercode om de authenticatiecode op te halen

     Dit proces gebeurt via het backchannel.

3. De URL voor het genereren van code accepteert de POST-verzoeken met de JSON-payload die hieronder wordt weergegeven:

   De client-ID en het geheim moeten worden verzonden als een basisautorisatieheader.

Volg deze link om erachter te komen hoe de header moet worden gevormd voor basisauthenticatie.

JSON-lading

{
"username": "firstname + lastname",
"firstName": "firstname",
"lastName": "lastname",
"emailId": "user emailId",
"readerGroupIds": ["Obtain from Reader groups overview page in the Document360 portal (Optional)"],
"tokenValidity": 15 //minutes *()*
}

NOTITIE

Zorg voor de juiste JSON-syntaxis om configuratiefouten te voorkomen.

4. De identiteitsserver genereert de code op basis van de gebruikersgegevens, client-ID en clientgeheim en stuurt de gegenereerde code terug naar de klanttoepassing.

   Dit gebeurt via het backchannel.

5. Zodra de klanttoepassing de verificatiecode van de identiteitsserver heeft ontvangen,

   • De klant-app voegt de code toe aan de callback-URL die te vinden is in de JWT-instellingen en leidt de gebruiker om naar de callback-URL met de code.

   • Bijvoorbeeld: HTTPS://{project_name}.document360.io/jwt/authorize?code={code}

NOTITIE

De authenticatiecode is een code voor eenmalig gebruik en kan niet opnieuw worden gebruikt.

4. Zodra de knowledge base de verificatiecode in de queryparameter heeft ontvangen, wordt de code via een backchannel naar de identiteitsserver verzonden voor het ID-token en het toegangstoken.

5. Zodra de kennisbank het ID-token heeft ontvangen, wordt er een sessie gemaakt namens de gebruiker die in de eerdere gebruikersgegevens wordt genoemd.

   • Standaard is deze sessie 15 minuten geldig. Zodra de sessiecookie is verlopen, wordt de eindgebruiker doorgestuurd naar de inlog-URL (gehost in de klanttoepassing) om een nieuwe code te krijgen en wordt de stroom herhaald.

   • De vernieuwing van de sessie zal naadloos verlopen omdat de gebruiker al is geverifieerd bij de klanttoepassing

Geldigheid van tokens

De minimale waarde die kan worden ingesteld is 5 minuten en de maximale waarde die kan worden ingesteld is 1440 minuten (1 dag).

krul

Na het inschakelen van de JWT-login kan de lezer de clienttoepassing gebruiken om in te loggen als lezersaccount op de Document360-kennisbanksite.

SSO configuratie

Een JWT aanmaken

Als u een JSON Web Token (JWT) wilt maken,

1. Log in op het Document360 portaal.

2. Ga naar ()> Users & security > JWT.

3. Maak vanaf hier een JWT (Client secret) aan door op de knop JWT maken te klikken.

4. Kopieer het gegenereerde clientgeheim door op het kopieerpictogram te klikken en op Sluiten te klikken.

NOTITIE

Hetzelfde gegenereerde clientgeheim is niet beschikbaar wanneer u deze sectie opnieuw bezoekt. Indien nodig moet het geheim van de klant worden geregenereerd.

De JWT-configuratiepagina met alle gegevens is nu beschikbaar.

JWT-configuratie

Nadat een JWT is aangemaakt, is de JWT-configuratiepagina zichtbaar.

• Stel uw applicatie in: Kopieer de client-id, callback-URL, URL voor het genereren van code, clientgeheim en plak deze in de juiste velden in de clienttoepassing

• JWT-status: Schakel de JWT SSO-aanmelding voor lezers in of uit met deze schakelaar. Als de wisselknop is uitgeschakeld, kunnen lezers zich niet aanmelden bij de kennisbanksite met de inloggegevens van hun client-app.

• JWT verwijderen: Klik op de knop Verwijderen om de geconfigureerde JWT te verwijderen. U kunt deze actie niet ongedaan maken.

• JWT-basisconfiguratie: Plak de inlog-URL die is verkregen uit de applicatie van de client.

  • Lezers komen terecht op de speciale afmeldpagina voor JWT SSO-lezers als er geen aangepaste afmeldlink is opgegeven.

Omleiding naar andere pagina's in plaats van de startpagina

Standaard worden gebruikers na het inloggen doorgestuurd naar de startpagina van uw kennisbank.

• Als de publicatie van uw homepage ongewijzigd is, worden gebruikers omgeleid naar de pagina /docs .

• Als u gebruikers wilt omleiden naar een andere pagina in uw Knowledge Base (anders dan de pagina's Start of /docs ), configureert u de omleiding tijdens de JWT-installatie met behulp van de volgende code.

URL-patroon

https://<Knowledge base URL>/jwt/authorize?code=<code>&redirectUrl=<redirect path>

Parameters

• Kennisbank-URL: de hoofd-URL van uw kennisbanksite.

• Code: De client-ID.

• Omleidings-URL: de nieuwe URL waar u wilt dat gebruikers terechtkomen nadat ze zijn ingelogd.

Voorbeeld

https://example.document360.io/jwt/authorize?code=FOTaS_SW6dLGytQXvrG_rRFGhyPvrDDrgxJAZzYvJcY&redirectUrl=/docs/5-basic-things-to-get-started

NOTITIE

Document360 stuurt de omleidings-URL naar RedirectPath het inlogeindpunt. Wanneer het aanmeldingseindpunt met de verificatiecode terugverwijst naar de knowledge base, moet het de omleidings-URL als RedirectUrl parameter retourneren.

Probleemoplossing

Als u problemen ondervindt tijdens de installatie van JWT SSO, raadpleegt u de volgende veelvoorkomende fout en de oplossing:

401-niet-geautoriseerde fout bij het testen van JWT in Postman

Fout: 401 Ongeautoriseerde fout

Als u een 401-ongeautoriseerde fout tegenkomt tijdens het testen van JWT (JSON Web Token) met Postman, gebeurt dit meestal omdat de autorisatie-instellingen niet correct zijn geconfigureerd.

Stappen om op te lossen:

Om deze fout op te lossen,

1. Open in Postman de aanvraag die u aan het testen bent.

2. Navigeer naar het tabblad Autorisatie .

3. Stel het autorisatietype in op Basic Auth.

4. Voer in het veld Gebruikersnaam de client-ID in.

5. Voer in het veld Wachtwoord het Client Secret in.

6. Ga naar het tabblad Body .

7. Selecteer de onbewerkte optie in de vervolgkeuzelijst en zorg ervoor dat de indeling is ingesteld op JSON.

8. Voeg de vereiste JSON-payload toe voor de API-aanvraag.

9. Klik op Verzenden om de aanvraag uit te voeren.

Controleer de reactie op de verwachte resultaten. Als de aanvraag is geslaagd, ontvangt u een verificatiecode of token in het antwoord.