Vejledning til rettighedshavere (API brugere med rettighedshaveradgang)
- Morten Rembøl Jacobsen
Introduktion
Der er i KITOS blevet udviklet en særlig rettighed “rettighedshaveradgang” der tillader API brugere fra rettighedshavere at administrere IT-Systemer og Snitfladebeskrivelser via KITOS API V2.
Rettighedshavere har mulighed for:
Hente alle eller enkelte ressourcer, som de er rettighedshaver for
Det er muligt at filtrere på udvalgte parametre i udtrækket. Se nærmere på Swagger dokumentation
Oprette nye ressourcer, som de er rettighedshaver for
Rette eksisterende ressourcer, som de er rettighedshaver for
Deaktivere ressourcer som de er rettighedshaver for.
Bemærk: Ifm. deaktivering kræves der en årsag hertil. Denne årsag formidles direkte til Global Admin. Såfremt ressourcen skal aktiveres igen, kontakt da KITOS-Sekretariatet.
Særlige endpoints til rettighedshavere
API dokumentationen for rettighedshaver API’et er centreret omkring ressourcerne og findes på Swagger dokumentation . Til rettighedshavere er der oprettet en række særlige endpoints, som understøtter deres use cases. Disse findes på følgende form:
https://kitos.dk/api/v2/rightsholder/{ressource_type}Bemærk: Hvis ikke den autentificerede bruger har fået tildelt rettighedshaveradgang, vil forespørgslerne blive afvist.
Organization UUID kræves ift. POST
Da brugere i teorien kan have rettighedshaveradgang til mere end én organisation i KITOS, kræves der et Organization UUID ifm. POST af nye ressourcer. Organization UUID kan hentes via endpointet:
GET https://kitos.dk/api/v2/rightsholder/organizationsOrganization UUID er stabilt og unikt, og derfor skal man typisk kun besøge endpointet én gang ifm. integrationens levetid (når man får oprettet sin API bruger).
Tildeling af rettighedshaveradgang
Rettighedshaveradgang tildeles via den almindelige brugeradministration og giver rettighedshaveradgang på vegne af de organisationer som rettigheden er tildelt i.
Eksempel:
Bruger A skal integrere på vegne af organisation X, som er rettighedshaver til IT-Systemer og snitflader i KITOS.
Global Admin skal oprette bruger A i organisation X i KITOS og tildele rettigheden “API Adgang” samt organisationsrettigheden “Rettighedshaveradgang”.
Bemærk:
Tildeles brugeren rettighedshaveradgang i flere organisationer, udvides brugerens beføjelser tilsvarende til disse.
Brugere med rettighedshaveradgang i én eller flere organisationer kan kun få udstedt token og kan altså ikke logge på KITOS UI. Derudover er store dele af V1 og V2 API blændet af