Sökresultat :

×

Steg-för-steg-guide för att ställa in REST API-autentisering vid sammanflöde

Confluence tillhandahåller REST API:er för att utföra ett antal operationer såsom Skapa sida, Ta bort sida, Lägg till kommentar, Skapa utrymme, etc. Det stöder dock bara två autentiseringsmetoder för REST API:er:

  1. Grundläggande autentisering
  2. Använda Confluence som OAuth 1.0-leverantör

REST API Authentication-plugin för Confluence låter dig använda vilken tredjeparts OAuth 2.0-leverantör/OpenID-anslutning som helst för att autentisera REST-API:er.

 

Fördelar med att använda tillägget REST API Authentication:

  1. Säkra: Detta är säkrare än grundläggande autentisering eftersom användarens autentiseringsuppgifter inte skickas med varje API-begäran. Tillägget kräver endast åtkomsttoken som genererats av den tredje partens OAuth 2.0-leverantör/OpenID Connect.
  2. Flexibel:  Det låter dig använda vilken som helst tredjeparts OAuth 2.0-leverantör/OpenID Connect för autentisering och inte bara Confluence.
  3. Övergripande skydd: Insticksprogrammet kan också blockera grundläggande autentiseringsbegäranden så att ingen utan en giltig åtkomsttoken kan använda något REST API.
  4. SSO-kompatibel: Om du använder enkel inloggning för Confluence kan du konfigurera din identitetsleverantör att tillhandahålla autentisering även för REST API:er.

 

REST API-autentiseringsflödet innefattar dessa två enkla steg:

  1. Begär åtkomsttoken från OAuth 2.0/OIDC-leverantör
  2. Ring Confluence REST API med denna åtkomsttoken

Steg för att ställa in OAuth 2.0/OpenID Connect-autentisering med miniOrange REST API Authentication-tillägget för Confluence:

Notera: Jag har använt miniOrange OAuth Provider som ett exempel här. Tillägget stöder alla anpassade OAuth 2.0/OpenID-anslutningsleverantörer som Azure AD, Keycloak, Okta, Gsuite (Google-appar), AWS Cognito, Github, Gitlab, etc.

Steg 1: Ställ in OAuth-flöde mellan din klientapplikation och OAuth 2.0/OpenID Connect-leverantör:

    1. Klientansökan: Det är en tjänst eller användare som vill komma åt Confluence REST API.
    2. Du måste ställa in ett OAuth-flöde mellan miniOrange och din klientapplikation. Klientapplikationen är vilken tjänst eller användare som helst som anropar Confluence REST API.
    3. Den kommer att användas för att auktorisera användaren och få åtkomsttoken.  Anmärkningar: Detta flöde kommer att ställas in mellan din klientapplikation och miniOrange OAuth-leverantör. REST API Authentication-tillägget är inte involverat i denna process. Om din applikation inte stöder OAuth 2.0, skicka oss bara ett e-postmeddelande på info@xecurify.com.
    4. Ställ in miniOrange som OpenID-leverantör med hjälp av steg-för-steg-guiden på denna länk: Ställ in miniOrange som OpenID Connect Provider.
    5. Efter att ha konfigurerat miniOrange som OAuth-leverantör, gå till appar Hantera Apps. Klicka på länken Redigera bredvid appen du skapade i miniOrange.
    6. kopiera Användarinfo Slutpunkt.

Steg 2: Konfigurera Introspection Endpoint i REST API Authentication-tillägget:

    1. Introspektionsslutpunkt: En introspektionsslutpunkt är en slutpunkt för OAuth/OpenID-leverantören som kan anropas med åtkomsttoken och returnerar användarnamn som svar.
    2. Välja Anpassad OAuth-leverantör i OAuth-leverantör Inställningsflik
    3. Ange Användarinfo slutpunkt kopierades i steg 1 i Introspection endpoint-fältet. Det ser ut så här.
      https://login.xecurify.com/moas/rest/oauth/getuserinfo
    4. Användarinformationens slutpunkt för miniOrange returnerar ett svar så här:
      { "sub": "demouser", "firstname": "Demo", "email": "demo@example.com", "username": "demouser", "efternamn": "Användare" }
    5. Användarnamn Attribut: Denna nyckel i introspektionsslutpunktssvar talar om för plugin vilken användare som gör API-anropet.
    6. I ovanstående svar, Användarnamn attributet innehåller Confluence-användarnamnet för den person som gör API-anropet. Därför anges användarnamn som användarnamnsattribut. Så pluginet kommer att veta att Confluence-användaren "demouser" gör ett API-anrop.

Steg 3: Hämta åtkomsttoken från miniOrange OAuth-leverantör:

    1. Initiera OAuth-flöde med miniOrange. Detta OAuth-flöde ser ut så här.

2. I slutet av detta flöde kommer en åtkomsttoken att returneras till din applikationsomdirigerings-URI konfigurerad i miniOrange.

3. Ett exempel på åtkomsttoken från miniOrange OAuth-leverantör ser ut så här.

  A834c0606ba71336423013699db8e971

Steg 4: Använd Confluence REST API med åtkomsttoken:

    1. Ring Confluence vilket REST API som helst. Inkludera åtkomsttoken i auktoriseringshuvudet. Här är ett exempel på hur du skapar Page API.

Begäran:

     curl \ -X POST \ -H "Auktorisering: Bärare " \ -H "Innehållstyp: application/json" \ --data {se nedan} \ http://localhost:8090/confluence/rest/api/content/|phython-mjson.tool \

 

Indata:

     { "type":"sida", "title":"ny sida", "mellanslag":{ "key":"TST" }, "body":{ "lagring":{ "värde":" Detta är en ny sida ", "representation":"lagring" } } }

2. Tillägget kommer att validera åtkomsttoken.
3. Problemet skapas om åtkomsttoken är ogiltig.
4. Om token är ogiltig eller saknas kommer samtalet att returnera ett 401 obehörigt svar.

Här är flödesdiagrammet för REST API-autentisering med miniOrange-plugin.

Hej där!

Behövs hjälp? Vi är här!

stödja
Kontakta miniOrange Support
framgång

Tack för din förfrågan.

Om du inte hör från oss inom 24 timmar, skicka gärna ett uppföljningsmail till info@xecurify.com