Skip to content

Commit

Permalink
Merge pull request #3215 from Opetushallitus/tor-2210-datan-palautus
Browse files Browse the repository at this point in the history
TOR-2210: Palauta scopen mukainen data
  • Loading branch information
AleksiAhtiainen authored Nov 28, 2024
2 parents 36ffe4a + 79fe5e6 commit d80b1c9
Show file tree
Hide file tree
Showing 231 changed files with 2,679 additions and 3,990 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ test("OAuth2 data access from KOSKI using openid-client works", async ({

// Check that oppija data containing ssn is displayed
await page.waitForURL("**/api/openid-api-test/form-post-response-cb**")
await expect(page.locator("html")).toContainText("210281-9988")
await expect(page.locator("html")).toContainText("280618-402H")
})

test("Standard error from server is displayed when user declines", async ({
Expand Down
15 changes: 10 additions & 5 deletions src/main/resources/documentation/omadata_oauth2.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ OAuth2-rajapinnassa on käytössä:
<dt>(7) Toive suostumuksen voimassaoloajasta</dt>
<dd>
Aika sekunteina.
<br/>Tämä riippuu kumppanin käyttötapauksesta: esim. tarvitaanko kansalaisen tiedot vain yhden kerran, jolloin lyhyt voimassaoloaika riittää, vai tarvitseeko tietoihin päästä käsiksi pidemmän aikaa ilman,
<br/>Tämä riippuu kumppanin käyttötapauksesta: esim. tarvitaanko kansalaisen tiedot vain yhden kerran, jolloin lyhyt voimassaoloaika riittää, vai tarvitseeko tietoihin päästä käsiksi pidemmän aikaa ilman,
että kansalaiselta tarvitsee pyytää suostumusta uudestaan.
</dd>
</dl>
Expand All @@ -70,7 +70,7 @@ Rajapinnan kutsumista varten kumppanin toteuttama palvelu tarvitsee seuraavat ti
<dd>Access token endpoint palauttaa aina Bearer-tokeneita.</dd>

<dt>Authorization code:n ja access token:in voimassaoloaika</dt>
<dd>Näiden käsittely ja määrittely on vielä työn alla.
<dd>Näiden käsittely ja määrittely on vielä työn alla.
<br/>Todennäköisimmin ensimmäisessä versiossa authorization code:sta tehdään lyhytaikainen ja kertakäyttöinen ja access tokenista pidempiaikainen, minkä ajan voi määritellä kullekin clientille erikseen, eikä erillisiä refresh token:eita aluksi tueta.
</dd>

Expand All @@ -95,17 +95,18 @@ Toistaiseksi **OPISKELUOIKEUDET_**-scopeja ei voi käyttää kuin yhtä kerralla
<dl>
<dt>OPISKELUOIKEUDET_SUORITETUT_TUTKINNOT</dt>
<dd>
opiskeluoikeudet-taulukossa palautetaan oppijan suoritetut tutkinnot. Skeema: <a href="{{var:virkailijaBaseUrl}}/json-schema-viewer/?schema=suoritetut-tutkinnot-oppija-schema.json">{{var:virkailijaBaseUrl}}/json-schema-viewer/?schema=suoritetut-tutkinnot-oppija-schema.json</a>
opiskeluoikeudet-taulukossa palautetaan oppijan suoritetut tutkinnot. Skeema: <a href="{{var:virkailijaBaseUrl}}/json-schema-viewer/?schema=omadata-oauth2-suoritetut-tutkinnot-oppija-schema.json">{{var:virkailijaBaseUrl}}/json-schema-viewer/?schema=omadata-oauth2-suoritetut-tutkinnot-oppija-schema.json</a>
Lisätietoja, ks. <a href="https://wiki.eduuni.fi/pages/viewpage.action?pageId=371305841">https://wiki.eduuni.fi/pages/viewpage.action?pageId=371305841</a>.
</dd>
<dt>OPISKELUOIKEUDET_AKTIIVISET_JA_PAATTYNEET_OPINNOT</dt>
<dd>
opiskeluoikeudet-taulukossa palautetaan oppijan aktiiviset ja päättyneet opinnot. Skeema: <a href="{{var:virkailijaBaseUrl}}/json-schema-viewer/?schema=aktiiviset-ja-paattyneet-opinnot-oppija-schema.json">{{var:virkailijaBaseUrl}}/json-schema-viewer/?schema=aktiiviset-ja-paattyneet-opinnot-oppija-schema.json</a>
opiskeluoikeudet-taulukossa palautetaan oppijan aktiiviset ja päättyneet opinnot. Skeema: <a href="{{var:virkailijaBaseUrl}}/json-schema-viewer/?schema=omadata-oauth2-aktiiviset-ja-paattyneet-opinnot-oppija-schema.json">{{var:virkailijaBaseUrl}}/json-schema-viewer/?schema=omadata-oauth2-aktiiviset-ja-paattyneet-opinnot-oppija-schema.json</a>
Lisätietoja, ks. <a href="https://wiki.eduuni.fi/pages/viewpage.action?pageId=371305841">https://wiki.eduuni.fi/pages/viewpage.action?pageId=371305841</a>.
</dd>
<dt>OPISKELUOIKEUDET_KAIKKI_TIEDOT</dt>
<dd>
opiskeluoikeudet-taulukossa palautetaan kaikki oppijan opiskeluoikeustiedot, skeema: <a href="{{var:virkailijaBaseUrl}}/json-schema-viewer#koski-oppija-schema.json">{{var:virkailijaBaseUrl}}/json-schema-viewer#koski-oppija-schema.json</a>
opiskeluoikeudet-taulukossa palautetaan kaikki oppijan opiskeluoikeustiedot, mutta ilman luottamuksellisiksi määriteltyjä tietoja. Skeema: <a href="{{var:virkailijaBaseUrl}}/json-schema-viewer/?schema=omadata-oauth2-kaikki-tiedot-oppija-schema.json">{{var:virkailijaBaseUrl}}/json-schema-viewer/?schema=omadata-oauth2-kaikki-tiedot-oppija-schema.json</a>.
Luottamukselliseksi määritellyt tiedot on merkitty tekstimuotoiseen skeemaan, ks. <a href="{{var:virkailijaBaseUrl}}/dokumentaatio/koski-oppija-schema.html">{{var:virkailijaBaseUrl}}/dokumentaatio/koski-oppija-schema.html</a>
</dd>
<dt>HENKILOTIEDOT_HETU</dt>
<dd>
Expand All @@ -119,6 +120,10 @@ Toistaiseksi **OPISKELUOIKEUDET_**-scopeja ei voi käyttää kuin yhtä kerralla
<dd>
Palautettavassa json-objektissa on henkilö.syntymäaika, muodossa YYYY-MM-DD
</dd>
<dt>HENKILOTIEDOT_OPPIJANUMERO</dt>
<dd>
Palautettavassa json-objektissa on henkilö.oid, joka sisältää oppijanumeron
</dd>
<dt>HENKILOTIEDOT_KAIKKI_TIEDOT</dt>
<dd>
Palautettavassa json-objektissa on kaikki em. henkilötiedot.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,33 @@
"koodiUri": "omadataoauth2client_oauth2client",
"versio": 1,
"koodiArvo": "oauth2client"
},
{
"metadata": [
{
"nimi": "OAuth2 debug client 2 (fi)",
"kuvaus": "",
"lyhytNimi": "",
"kieli": "FI"
},
{
"nimi": "OAuth2 debug client 2 (sv)",
"kuvaus": "",
"lyhytNimi": "",
"kieli": "SV"
},
{
"nimi": "OAuth2 debug client 2 (en)",
"kuvaus": "",
"lyhytNimi": "",
"kieli": "EN"
}
],
"withinCodeElements": [],
"includesCodeElements": [],
"levelsWithCodeElements": [],
"koodiUri": "omadataoauth2client_oauth2kaikkiclient",
"versio": 1,
"koodiArvo": "oauth2kaikkiclient"
}
]
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,34 @@
"versio": 1,
"koodiArvo": "henkilotiedot_hetu"
},
{
"metadata": [
{
"nimi": "Oppijanumero",
"kuvaus": "",
"lyhytNimi": "",
"kieli": "FI"
},
{
"nimi": "Studentnummer",
"kuvaus": "",
"lyhytNimi": "",
"kieli": "SV"
},
{
"nimi": "Student number",
"kuvaus": "",
"lyhytNimi": "",
"kieli": "EN"
}
],
"withinCodeElements": [],
"includesCodeElements": [],
"levelsWithCodeElements": [],
"koodiUri": "omadataoauth2scope_henkilotiedotoppijanumero",
"versio": 1,
"koodiArvo": "henkilotiedot_oppijanumero"
},
{
"metadata": [
{
Expand Down
Loading

0 comments on commit d80b1c9

Please sign in to comment.