10. Appendiks 4 - Registrering av gruppe-IDer i eduPersonEntitlement

For å kunne hente ut alle medlemmer i en gruppe må gruppe-IDer registreres på personobjektene til alle som er medlemmer i gruppen. I Feide er det valgt å bruke feltet eduPersonEntitlement for gruppe-IDer.

Gruppe-IDene ligner innholdsmessig mye på gruppene en person er medlem av, men er like for alle medlemmer uavhengig av rolle i gruppen. De har mye sterkere krav til utforming som gjør det mulig å benytte de som unike identifikatorer.

Personens informasjon om gruppe-IDer er bygd opp slik at at den er knyttet til hver skole personen tilhører.

10.1. Alle som er tilknyttet gruppen skal ha identifikatoren registrert

Alle personer som er tilknyttet en gruppe skal ha den tilsvarende gruppe-IDen registrert på sitt personobjekt. Dette vil som regel være elever og lærere, men kan også være andre personer som har en formell knytning til det daglige arbeidet i gruppen.

Gruppeindentifikatorene skal inneholde gruppene en person er tilknyttet på nåværende tidspunkt. Det er ikke forventet at informasjon om historiske gruppe-IDer beholdes.

10.2. Relasjon til gruppeinformasjon

De skal være samsvar mellom listen med grupper registrert på en person og den tilsvarende listen med gruppe-IDer. Et personobjekt skal ikke ha registrert en gruppe uten en tilsvarende gruppe-ID, og skal heller ikke ha en gruppe-ID uten en tilsvarende gruppe.

10.3. Oppbygning av gruppe-IDer

Gruppe-IDer i Feide er globale i scope og unike over tid. De inneholder derfor mer informasjon enn det som vanligvis er nødvendig for intern bruk hos en skoleeier.

Hver gruppe-ID som registreres for en person inneholder 5 informasjonselementer:

Informasjonselement Beskrivelse
Gruppetype Viser hvilken type gruppe dette er. Gyldige verdier er ’b’, ’u’ og ’a’
for henholdsvis basisgruppe/klasse, undervisningsgruppe og annen gruppe.
Organisasjonsnummer/
bedriftsnummer
Organisasjonsnummer/bedriftsnummer til skolen/skoleeieren gruppen tilhører.
For de aller fleste grupper vil den være knyttet til skolen, men det kan være
grupper som er knyttet direkte til skoleeieren.
Lokal gruppe-ID En identifikaktor på gruppen der navnestandard er definert ved
skolen/skoleeieren. Skal være unik innenfor skolen/skoleeieren
gruppen tilhører.
Starttidspunkt Starttidspunkt gruppen blir aktiv/gyldig. ISO 8601 extended format
for date, YYYY-MM-DD.
Sluttidspunkt Sluttidspunkt når gruppen ikke lenger er aktiv/gyldig. ISO 8601 extended
format for date, YYYY-MM-DD.

10.4. Formatering av gruppe-IDer

Hver gruppeidentinfikator registreres som en egen linje i eduPersonEntitlement. Formatet på identifikatorene er strengere enn for gruppetilhørigheten beskrevet i Appendix 3 for å unikt kunne identifisiere grupper.

Linjen skal starte med prefikset ’urn:mace:feide.no:go:groupid:’ etterfulgt av hvert av informasjonselementene i samme rekkefølge som tabellen over. Hvert informasjonselement skilles fra hverandre med et kolon, ’:’.

For å kunne overføre verdiene fra en system til et annet definerer RFC 8141 og RFC 3986 hvilke verdier som er gyldige, hvilke som benyttes direkte og hvilke som må prosent-kodes. URN-er er begrenset til ASCII så de fleste spesialtegn og særnorske tegn må prosent-kodes i overføringen. Man benytter UTF-8 oversetting først og så til US-ASCII (RFC 8141 2. Syntax). Dette gjøres ved å oversette disse tegnene til %<hex><hex>. De hexadesimale bokstavene A-F skal skrives med store bokstaver. For eksempel vil det særnorske tegnet ’å’ oversettes fra UTF-8 til to oktetter som så kodes og blir %C3%A5.

Alle tegn som er “unreserved” i 2.3 i RFC 3986 skal skrives ut direkte, mens alle andre tegn skal prosent-kodes.

De tegnene som skal skrives direkte er:

  • a-zA-Z (ALPHA)
  • 0-9 (DIGIT)
  • - (minus)
  • . (punktum)
  • _ (understrek)
  • ~ (tilde)

<Space>/mellomrom er et spesialtilfelle som må kontrolleres nøye. Mange funksjoner for prosent-koding koder dette om til + som bryter med RFC 3986. Det korrekte for URN-er er %20. Vertsorganisasjoner må påse at dette blir riktig.

For gruppe-IDer benyttes kolon (:) som separator mellom informasjonselementer. Om dette tegnet benyttes inne i informasjonselementene, for eksempel i den lokale gruppe-IDen, må dette kodes, som %3A.

Informasjonselementene i gruppe-IDen har forskjellige krav til bruk av store og små bokstaver:

  • Gruppetype: Skal bare inneholde én liten bokstav.
    Eksempel: b
  • Organisasjonsnummer/bedriftsnummer: Skal bare inneholde store bokstaver og tall.
    Eksempel: NO975278964
  • Lokal gruppe-ID: Skal skrives med små bokstaver før prosent-koding. Alle hexadesimale bokstaver i prosent-kodede verdier skal være store, A-F.
    Eksempel: 6a-kr%C3%B8 (6a-krø)
  • Starttidspunkt: Skal bare inneholde tall og -.
    Eksempel: 2014-08-01
  • Sluttidspunkt: Skal bare inneholde tall og -.
    Eksempel: 2015-06-15

10.5. Eksempler med gruppe-IDer i eduPersonEntitlement

Disse eksemplene samsvarer med eksemplene for gruppeinformasjon i Appendix 3.

10.5.1. Elev i basisgruppe/klasse 6A ved Berg skole (Trondheim kommune)

Gruppetype: b
Organisasjonsnummer: NO975278964
Lokal gruppe-ID: 6A
Starttidspunkt: 1. aug 2014
Sluttidspunkt: 15. juni 2015

eduPersonEntitlement:
urn:mace:feide.no:go:groupid:b:NO975278964:6a:2014-08-01:2015-06-15

10.5.2. Lærer i undervisningsgruppe 2kja ved Tiller vgs

Gruppetype: u
Organisasjonsnummer: NO974558386
Lokal gruppe-ID: 2kja
Starttidspunkt: 1. aug 2014
Sluttidspunkt: 15. juni 2015

eduPersonEntitlement:
urn:mace:feide.no:go:groupid:u:NO974558386:3kja:2014-08-01:2015-06-15

10.5.3. Elev i undervisningsgruppe Norsk VG3 ved Tiller vgs

Gruppetype: u
Organisasjonsnummer: NO974558386
Lokal gruppe-ID: 3aaa/3nh
Starttidspunkt: 1. aug 2014
Sluttidspunkt: 15. juni 2015

eduPersonEntitlement:
urn:mace:feide.no:go:groupid:u:NO974558386:3aaa%2F3nh:2014-08-01:2015-06-15

10.5.4. Elev i labgruppe 3 Fysikk VG3 ved Tiller vgs

Gruppetype: a – andre grupper
Organisasjonsnummer: NO974558386
Gruppe-ID: 3fysa/lb3
Starttidspunkt: 1. aug 2014
Sluttidspunkt: 31. des 2014

eduPersonEntitlement:
urn:mace:feide.no:go:groupid:a:NO974558386:3fysa%2Flb3:2014-08-01:2014-12-31