Dokumentasjon av ulike meldingstyper

Dokumentasjon av format og variable i de forskjellige meldinger.

1   Generelt

Alle hendelser har et predefinert sett attributter, disse er enkodet i JSON format.

Nøkkel Type Beskrivelse
change streng endringstype, f.eks. add, del eller mod
category streng hva endringen er relatert til, for eksempel karantener eller systemangivelse
meta_object_type streng spesifisering av hva change og category opererer på
context streng kontekst (spread) gitt til / fjernet fra entiteten som refereres til av subjectid
subjectid heltall numerisk identifikator som kan brukes til REST-oppslag
subjecttype streng subject-entitetens type, eksempelvis «account», «group» eller lignende
objectid heltall numerisk identifikator som kan brukes til REST-oppslag
objecttype streng object-entitetens type, eksempelvis «account», «group» eller lignende
data ordbok metadata om hva som er endret for entiteten

1.1   Utfyllende om subject og object

Begrepene subject og object betegner hvilke entiteter som blir berørt av en hendelse. Et godt eksempel på dette er innmelding i grupper. I dette tilfellet vil subject være gruppen det meldes en entitet inn i, mens object er entiteten som meldes inn i gruppen.

1.2   Karantene-hendelser

Følgende er eksempler på henholdsvis tilslag, modifikasjon og sletting av karantener:

{"category": "quarantine",
 "subjectid": 2,
 "context": null,
 "objectid": null,
 "subjecttype": "account",
 "data": {"type": "auto_no_aff"},
 "change": "del",
 "objecttype": null}

{"category": "quarantine",
 "subjectid": 2,
 "context": null,
 "objectid": null,
 "subjecttype": "account",
 "data": {"type": "auto_no_aff"},
 "change": "add",
 "objecttype": null}

{"category": "quarantine",
 "subjectid": 2,
 "context": null,
 "objectid": null,
 "subjecttype": "account",
 "data": {"type": "auto_no_aff"},
 "change": "mod",
 "objecttype": null}

1.3   Kontekst-hendelser

Følgende eksempler viser tilslag og fjerning av kontekst (spreads):

{"category": "context",
 "subjectid": 2,
 "context": "guest_account@ad",
 "objectid": null,
 "subjecttype": "account",
 "data": {},
 "change": "delete",
 "objecttype": null}

{"category": "context",
 "subjectid": 2,
 "context": "guest_account@ad",
 "objectid": null,
 "subjecttype": "account",
 "data": {},
 "change": "add",
 "objecttype": null}

2   Fremtiden

  • Oppfyller eller lett konverterbar til draft-hunt-idevent-scim? (https://tools.ietf.org/html/draft-hunt-idevent-scim-00). Dette er jo enda et utkast.
  • Generaliserte hendelser finspisset for eksterne konsumenter?
  • Spesialiserte hendelser for intern bruk i Cerebrum?
  • Hendelser er ikke en endringslogg. Logg for dette.
Av uait
Publisert 9. sep. 2015 15:48 - Sist endret 26. juli 2016 09:07