Brug af SCIM med Ideanote

Automatiser klargøring af brugere med SCIM-integration i Ideanote.

Brug af SCIM med Ideanote

Bemærk: Denne vejledning er beregnet til workspaceejere

SCIM (System for Cross-domain Identity Management) er en åben standard, der muliggør automatisering af klargøring af brugere mellem softwaresystemer, f.eks. mellem din IT-infrastruktur og Ideanote-platformen. Den gør det muligt at oprette, opdatere, deaktivere og slette brugere og teams fra dit eget system, f.eks. fra en Microsoft Entra ID/Azure AD-applikation, som du har konfigureret internt til brug med Ideanote.

Med SCIM kan du klargøre alle dine brugere, teams og deres medlemskaber i disse teams fra dit eget system, så alt synkroniseres med Ideanote og er klar, når du vil starte en kampagne – uden at skulle bede dine brugere om at tilmelde sig platformen på forhånd.

Hvis du kombinerer SCIM med SAML- eller OIDC-baseret godkendelse, styres både klargøring af brugere og brugergodkendelse fuldt ud af din egen IT-infrastruktur.

Ideanote overholder fuldt ud SCIM-standarden og understøtter alle påkrævede samt mange af de valgfrie SCIM-attributter for både brugere og grupper. Alle disse kan findes via vores offentlige API gennem standardiserede endpoints samt direkte fra Ideanote-platformen.

Denne vejledning hjælper dig med at komme så nemt som muligt i gang med SCIM i Ideanote.

I eksemplerne i denne vejledning bruger vi Microsoft Entra ID (tidligere kendt som Azure Active Directory) og Okta, men principperne bør gælde for alle identitetsudbydere, der er SCIM-kompatible.

Brug af SCIM med Ideanote og Entra ID

1. Gå først til dit Ideanote-workspace.

1.1. Klik på 'Indstillinger' i hovedmenuen i sidepanelet

1.2. Klik på 'Integrationer'

1.3. Klik på 'SCIM'

2. Der vises nu et dialogvindue på skærmen med oplysninger om din SCIM-konfiguration. Den er straks klar til brug.

2.1. Øverst i dialogvinduet kan du se, om Ideanote endnu har modtaget en API-anmodning ved hjælp af denne konfiguration (se 1 på billedet ovenfor).

2.1.1. Når alt er konfigureret korrekt, og der er modtaget en API-anmodning, ser teksten og indikatorens farve anderledes ud, som vist på billedet nedenfor:

{IMAGE: SCIM status indicator showing green status with text "Ideanote received an API-request using this configuration at 03/22/2024, 12:25 AM."}

2.2. 'Tenant-URL' er roden til Ideanotes SCIM-endpoints. Du skal føje den til den applikation, du senere konfigurerer til Ideanote hos din identitetsudbyder.

2.3. 'Hemmelig token' er det token, der kræves for at godkende kald til Ideanotes SCIM-endpoints. Du skal føje det til den applikation, du senere konfigurerer til Ideanote hos din identitetsudbyder.

2.4. Menuen 'Understøttede brugerattributter' kan foldes ud og viser en tabel med alle de SCIM-attributter, Ideanote understøtter for SCIM-brugere, herunder vores egne skemaudvidelser. Disse data hentes direkte fra vores API under kørslen og er derfor altid 100 % opdaterede.

2.5. Menuen 'Understøttede gruppeattributter' kan foldes ud og viser en tabel med alle de SCIM-attributter, Ideanote understøtter for SCIM-grupper. Som beskrevet i trin 2.4 er disse data altid 100 % opdaterede.

2.6. Bemærk: Hvis du vil slette en SCIM-konfiguration, skal du klikke på 'Slet SCIM-konfiguration'.

3. Du har nu konfigureret dit workspace til SCIM. Gå derefter til det sted, hvor du administrerer brugerne og/eller IT-infrastrukturen i din organisation, f.eks. Microsoft Entra ID.

4. Klik på 'Virksomhedsapplikationer' i Microsoft Entra ID eller Azure Portal.

5. Hvis du tidligere har oprettet en virksomhedsapplikation til Ideanote, f.eks. til SAML-/OIDC-baseret godkendelse, skal du finde den på listen, klikke på den og gå direkte til trin 7. Ellers skal du klikke på 'Ny applikation'.

6. Du kommer nu til et galleri med eksisterende apps, men skal oprette en ny:

6.1. Klik på 'Opret din egen applikation'

6.2. Under 'Hvad hedder din app?' skal du give den et passende navn, f.eks. 'Ideanote SCIM-klargøring'.

6.3. Under 'Hvad vil du bruge din applikation til?' skal du vælge 'Integrer en anden applikation, som du ikke finder i galleriet (ikke fra galleriet)'.

6.4. Klik på 'Opret' for at fortsætte. Du kommer nu til din nye virksomhedsapplikation.

7. Klik på 'Klargøring' i sidepanelet under 'Administrer'

8. Klik på 'Kom godt i gang'

9. Nu skal vi forbinde oplysningerne fra den SCIM-konfiguration, du har oprettet i dit Ideanote-workspace, med din virksomhedsapplikation:

9.1. Under 'Klargøringstilstand' skal du vælge 'Automatisk'. 'Administratoroplysninger' vises nu nedenfor. Sørg for, at afsnittet er foldet ud.

9.2. Under 'Tenant-URL' skal du indsætte den URL, du modtog i trin 2.2, i dialogboksen SCIM Integration i dit Ideanote-workspace.

9.3. Under 'Hemmelig token' skal du indsætte den token, du modtog i trin 2.3, i dialogboksen SCIM Integration i dit Ideanote-workspace.

9.4. Klik til sidst på 'Test forbindelsen' for at sikre, at den fungerer korrekt.

9.4.1. Hvis alt går som det skal, bør du se følgende meddelelse.

9.4.2. Du bør nu også kunne se i SCIM-konfigurationen i dit Ideanote-workspace, at teksten og farven på indikatoren, der er beskrevet i trin 2.1, er ændret til noget i retning af det, der vises på følgende billede:

9.5. Klik på 'Gem' for at gemme legitimationsoplysningerne.

9.6. Nu bør du gennemgå og eventuelt tilpasse, hvordan dine bruger- og gruppedata knyttes til de tilsvarende SCIM-attributter:

9.6.1. Sørg for, at den sammenklappelige menu 'Tilknytninger' er foldet ud

9.6.2. Klik på 'Klargør Microsoft Entra ID-brugere'

9.7. Du kommer nu til 'Attributtilknytning'. Azure leveres med standardtilknytninger, der fungerer med det samme, men du kan tilpasse dem, som du ønsker. Du kan for eksempel knytte de specifikke roller, du tildeler dine brugere i Entra ID, til tilsvarende Ideanote-niveauer, og/eller knytte noget andet end mailNickname til externalId, f.eks. userPrincipalName. Du kan bruge tabellen over 'Understøttede brugerattributter', der er beskrevet i trin 2.4, til at få et overblik over de brugerattributter, Ideanote understøtter.

9.7.1. Hvis du vil knytte en attribut til en af Ideanotes udvidede brugerattributter i skemaet, f.eks. teamPath, skal du føje den til attributlisten for Enterprise-programmet:

9.7.1.1. Sørg for, at 'Show advanced options' er markeret

9.7.1.2. Klik på 'Edit attribute list for customappsso' (eller hvad appen nu hedder)

9.7.1.3. Rul ned, og indtast navnet på den attribut, du vil knytte til, f.eks. urn:ietf:params:scim:schemas:extension:ideanote:2.0:User:teamPath

9.7.1.4. Klik på 'Save' for at gemme dine ændringer

9.7.2. Hvis du vil tilføje en ekstra tilknytning, skal du klikke på 'Add new mapping'. Du kan finde Microsofts fulde dokumentation om attributtilknytning her.

9.8. Du er nu klar til at tilføje de brugere og grupper, du vil knytte til Ideanote og klargøre med SCIM.

9.8.1. Klik på 'Users and groups'

9.8.2. Klik på 'Add user/group'

9.8.2.1. Klik på 'Users and groups' under 'None selected'

9.8.2.2. Søg efter de brugere og/eller grupper, du vil tilføje.

9.8.2.3. Klik på 'Select' for at føje de valgte brugere til programmet.

9.9. Du har nu konfigureret SCIM-klargøring! Microsoft Entra ID klargør automatisk dine brugere og grupper med faste intervaller. Hvis du vil teste klargøringen først, kan du klargøre en bruger eller gruppe efter behov:

9.9.1. Klik på 'Provision on demand'

9.9.2. Søg efter den bruger eller gruppe, du vil klargøre, under 'Selected user'

9.9.3. Klik på 'Provision' for at klargøre brugeren

9.9.4. Hvis du valgte en bruger, bør vedkommende nu vises på siden med indstillingerne for "People" i dit Ideanote-workspace. Hvis du valgte en gruppe, bør den nu vises som et team under fanen "Teams".

9.10. Du har nu konfigureret SCIM og klargjort din første bruger!

9.11. På siden med indstillingerne for "People" i dit Ideanote-workspace kan du se, hvornår en bruger sidst blev synkroniseret med SCIM, samt brugerens eksterne ID:

9.11.1. Rul til kolonnen længst til højre, der er synlig i tabellen, og klik på de tre vandrette prikker (...)

9.11.2. Sørg for, at 'SCIM-Synced at' og/eller 'SCIM External ID' er markeret, så de vises i tabellen.

9.12. Microsoft Entra ID sørger for at synkronisere ændringer til Ideanote med faste intervaller. Når du sletter en bruger fra Entra ID, bliver brugeren også slettet fra dit Ideanote-workspace. Når du fjerner tildelingen af en bruger fra den Enterprise-applikation, du har oprettet til SCIM-provisionering, bliver brugeren i stedet deaktiveret i Ideanote. Dette styres af regler, som Microsoft beskriver i denne artikel under afsnittet "Hændelser ved fjernelse af adgang".

Brug af SCIM med Ideanote og Okta

De grundlæggende trin og principper i hovedvejledningen til opsætning af SCIM-provisionering i Ideanote med Microsoft Entra ID er meget ens, når du bruger Okta. Dette tillæg til vejledningen fokuserer specifikt på, hvordan du gør det med Okta. Du kan altid se den officielle Okta-dokumentation om opsætning af SCIM-provisionering til en appintegration, som denne vejledning i store træk er baseret på.

1. Først og fremmest kræver opsætning af SCIM med Okta, at du allerede har en SSO-integrationsapp i Okta, der bruger enten SAML 2.0 eller SWA. Ideanote understøtter SAML af disse to muligheder. Bemærk, at du ikke behøver at konfigurere en SAML-loginløsning i dit Ideanote-workspace, for at det kan fungere. Hvis du allerede har konfigureret en SAML-integrationsapp til Ideanote i Okta Admin Console, skal du gå direkte til trin 7. Ellers skal du fortsætte med næste trin.

2. Gå først til din Okta-administrationskonsol.

2.1. Gå til fanen 'Programmer' i sidepanelet

2.2. Klik på 'Opret appintegration'

3. Der vises en modal med titlen 'Opret en ny appintegration'.

3.1. Vælg 'SAML 2.0' på listen

3.2. Klik på 'Næste'

3.2.1. Bemærk: Hvis du allerede har en Okta SSO-appintegration til Ideanote, der bruger OIDC (OpenID Connect), skal du konfigurere en ny, separat integration med SAML 2.0, da Okta ikke understøtter SCIM sammen med OIDC. Du kan konfigurere en SSO-integrationsapp i Okta med SAML uden at gøre den til en loginmetode i Ideanote.

4. Du bliver omdirigeret til en guide til opsætning af en ny SAML-integration.

{IMAGE: Screenshot of Okta "Create SAML Integration" wizard on step 1 "General Settings". A progress indicator shows steps: 1 General Settings (active), 2 Configure SAML. The form shows fields for "App name" (filled with "Ideanote"), "App logo (optional)" with a gear icon placeholder and upload/delete buttons, and "App visibility" with an unchecked checkbox "Do not display application icon to users". Cancel and Next buttons appear at bottom. Numbered indicators (1, 2) point to the App name field and Next button.}

4.1. Under 'App name' skal du give den et passende navn, f.eks. 'Ideanote'

4.2. Klik på 'Næste'

5. Du får nu vist siden 'Konfigurer SAML'. Nu skal du beslutte, om du samtidig vil konfigurere SAML som loginmetode på dit Ideanote-workspace. Du kan blot udfylde felterne her, hvis du kun vil konfigurere SCIM og fortsætte med at bruge dine eksisterende loginmetoder på dit Ideanote-workspace. Hvis du derimod vil bruge SAML til godkendelse sammen med SCIM-provisionering, skal du gå til dit Ideanote-workspace og følge vores vejledning til opsætning af en SAML-loginudbyder med SSO.

5.1. Under 'URL til enkeltlogon', skal du indtaste https://api.ideanote.io/sso/saml/callback

5.2. Under 'Målgruppe-URI (SP-entitets-ID)', skal du indtaste https://api.ideanote.io/sso/saml/metadata.xml

5.3. Under 'Navne-ID-format', skal du vælge 'EmailAddress'

5.4. Klik på 'Næste' for at fortsætte

6. På guidens sidste side skal du markere applikationen som intern

6.1. Slå 'Dette er en intern app, som vi har oprettet' til, og klik på 'Afslut'. Du bliver nu omdirigeret til din nye applikation.

7. Klik på 'Rediger'

8. I den modal, der vises, kan du se sektionen 'Klargøring'.

8.1. Under 'Klargøring' skal du vælge 'SCIM'

8.2. Klik på 'Gem'

9. Når du har gemt, kommer du tilbage til din SSO-integrationsapp.

9.1. Sørg for, at du er på fanen 'Klargøring'.

9.2. Klik på 'Rediger'

10. Du er nu klar til at udfylde oplysningerne om SCIM-forbindelsen. Men først skal du sikre dig, at du har konfigureret en SCIM-integration i dit Ideanote-workspace. Følg den grundlæggende vejledning 'Brug af SCIM med Ideanote' fra trin 1 til 3 for at konfigurere en SCIM-integration i dit Ideanote-workspace. Når det er gjort, kan du vende tilbage til Okta for at udfylde oplysningerne om SCIM-forbindelsen.

10.1. Under 'Basis-URL for SCIM-forbindelse' skal du indtaste https://api.ideanote.io/scim/v2

10.2. Under 'Unikt identifikationsfelt for brugere' skal du indtaste 'userName'

10.3. Under 'Understøttede klargøringshandlinger' skal du vælge, hvilke typer handlinger Okta skal synkronisere via SCIM. Hvis du vil sikre, at brugere og grupper/teams altid er opdaterede i dit Ideanote-workspace, skal du slå alle indstillinger til, der begynder med ordet 'Push'

10.3.1. Bemærk: Okta understøtter også import af data fra dit Ideanote-workspace til Okta. Vi anbefaler dog generelt kun at bruge push, så bruger-/gruppemappen i Okta er den eneste pålidelige kilde

10.4. I rullemenuen 'Godkendelsestilstand' skal du vælge 'HTTP-header'

10.5. Gå tilbage til dit Ideanote-workspace, find indstillingerne for din SCIM-integration, og kopiér din 'Hemmelig token' til udklipsholderen.

10.6. Gå nu tilbage til Okta, og indsæt den i tekstfeltet til headeren 'Autorisation' lige ved siden af teksten 'Bearer'.

10.7. Klik på 'Test forbindelseskonfiguration' for at kontrollere, at Okta kan kommunikere korrekt med dit workspace.

10.8. Hvis alt gik godt, skal du klikke på 'Gem' for at fortsætte. Hvis ikke, skal du kontrollere alle dine indtastninger og følge trinnene i denne vejledning igen.

11. Du kommer tilbage til fanen 'Klargøring' i din SSO-integrationsapp, men denne gang kan du se og tilpasse meget mere.

11.1. Klik på 'Rediger' for at aktivere til/fra-knapperne igen.

11.2. Aktivér 'Opret brugere', hvis du vil have, at brugere fra dit Okta Directory oprettes i (eller synkroniseres med) dit Ideanote-workspace, når de tildeles din Okta SSO-integrationsapp

11.3. Aktivér 'Opdater brugerattributter', hvis du løbende vil synkronisere attributterne for tildelte brugere i dit Ideanote-workspace baseret på deres aktuelle tilstand i dit Okta-katalog, efterhånden som den ændres

11.4. Aktivér 'Deaktivér brugere', hvis du vil deaktivere en bruger i dit Ideanote-workspace, når vedkommende fjernes fra din Okta SSO-integrationsapp

11.5. Muligheden 'Synkronisér adgangskode' understøttes ikke.

12. Under 'Attributtilknytninger' kan du se og tilpasse, hvordan brugerattributter, der er defineret i dit Okta-katalog, knyttes til brugere i dit Ideanote-workspace. Du kan bruge knappen 'Gennemtving synkronisering' til at gennemtvinge en synkronisering af alle brugere og brugerattributværdier fra dit Okta-katalog til Ideanote for alle brugere, der aktuelt er tilknyttet den SSO-integrationsapp, du har konfigureret.

13. For at teste og verificere klargøringen skal du sørge for at tildele de brugere og grupper, du ønsker, til den SSO-integrationsapp, du har oprettet til Ideanote. Det gør du sådan:

13.1. Gå til siden 'Personer' (eller 'Grupper') i dit Okta-bibliotek

13.2. Klik på en bruger (eller gruppe) på listen

13.3. Klik på 'Tildel applikationer' for at knytte brugeren/gruppen til en applikation. Vælg den SSO-integrationsapp, du har oprettet til Ideanote.

14. Okta SCIM-klargøring går ret hurtigt og udføres typisk kort efter, at du foretager en ændring i dit Okta-bibliotek. Hvis du vil se klargøringsloggene, kan du gøre det direkte fra den SSO-integrationsapp, du har oprettet i Okta til SCIM, ved at klikke på 'Vis logfiler'

15. Du har nu konfigureret SCIM!

16. Du kan se, hvornår en bruger senest blev synkroniseret med SCIM, samt vedkommendes eksterne ID, på siden med indstillinger for "Personer" i dit Ideanote-workspace:

16.1. Rul til den kolonne længst til højre, der er synlig i tabellen, og klik på de tre vandrette prikker (...)

16.2. Sørg for, at 'SCIM-synkroniseret den' og/eller 'Eksternt SCIM-ID' er markeret, så de vises i tabellen.

17. Okta sørger for at synkronisere ændringer til Ideanote med faste intervaller. Afhængigt af hvilke indstillinger du aktiverede under trin 10.3, bliver brugere også deaktiveret i dit Ideanote-workspace, når de fjernes fra din Okta SSO-integrationsapp.

‍