Tietomallin tarkoitus
Tietoluettelon tarkoituksena on kuvata MPASSid-hallintapalvelun tietosisältöjä ja niiden määrittelyjä sekä tukea MPASSid-tunnistuksenvälityspalvelua käyttäviä organisaatioita. Tietomallin avulla organisaatiot saavat tiedon, mitä tietoja MPASSid-hallintapalveluun tallennetaan organisaatioiden MPASSid-integraatioista.
Hallintapalvelun tietomalliversiossa 2.0 lisäksi kerrotaan, mitä tietoja koulutustoimija voi itse päivittää sallittujen palveluiden valintaa koskien virkailijan Opintopolkuun liitetyssä palvelussa.
Yleiset tiedot
Organisaation tiedot
Versio | Tietokenttä | Esimerkki | Tyyppi | Kuvaus | Lähde |
---|---|---|---|---|---|
1.0 | Nimi | Mansikkalan testi kunta | Teksti | Koulutustoimijan nimi Palveluntarjoajan nimi | OPH:n organisaatiopalvelu |
1.0 | Y-tunnus | 6144468-4 | Teksti | Koulutustoimijan y-tunnus Palveluntarjoajan y-tunnus | OPH:n organisaatiopalvelu |
1.0 | Organisaatio OID | 1.2.246.562.10.XXXXXXXXXXX | Teksti | Organisaatiopalvelun generoima yksilöllinen pysyvä tunniste | OPH:n organisaatiopalvelu |
Koulutustoimijan integraation perustiedot
Versio | Tietokenttä | Esimerkki | Tyyppi | Kuvaus | Lähde |
---|---|---|---|---|---|
1.0 | Hallintapalvelun antama yksilöllinen tunniste integraatiolle | 1000XXX | numero | Tietojärjestelmän yksilöllinen tunniste integraatiolle hallintapalvelussa | Hallintapalvelu |
1.0 | Rooli | Koulutustoimija | teksti | Tietokentän tyypit
| Koulutustoimija |
1.0 | Integraation kirjautumisvuo (flowname) | EsimerkkiTunnistetieto | teksti | Integraatiokohtainen yksilöllinen kirjautumisvuon tunniste | Hallintapalvelu |
1.0 | Integraation yksilöllinen tunniste | Wilma = hostname Entra ID = Entity ID Opinsys = Tenant ID Google = Entity ID ADFS = Entity ID | teksti | Integraation yksilöllinen tunniste | Koulutustoimija |
1.0 | Integraation tyyppi | Opinsys Wilma Adfs Entra ID | teksti | Koulutustoimijan integraation tyyppi riippuen käyttäjähakemistosta | Koulutustoimija |
Oppilaitoksen valintanäkymän tiedot
Tietokenttä | Esimerkki | Tyyppi | Kuvaus | Lähde |
---|---|---|---|---|
Oppilaitostyypit | Lukiot (15) | Koodi | Oppilaitostyypit, joiden avulla loppukäyttäjälle listataan oppilaitosten nimet. Sallitut oppilaitostyypit:
Varhaiskasvatuksen toimipaikkojen nimiä ei näytetä loppukäyttäjille, käyttäjälle näytetään koulutustoimijan nimi. | Koulutustoimija |
Koulutustoimijan logo | Kuva | png-tiedosto | Organisaation logo, joka näytetään loppukäyttäjälle MPASSid-kirjautumisessa (koko 125x36 px) | Koulutustoimija |
Koulutustoimijan näyttönimi (customDisplayName) | Mansikkalan testi kunta | Teksti | Valinnainen: Mahdollisuus päivittää muu kuin koulutustoimijan virallinen nimi organisaatiopalvelussa | Koulutustoimija |
Oppilaitosten näyttäminen (showschools) | Kyllä/Ei | Kytkin (true/false) | Valinnainen: Näytetäänkö oppilaitoslistalla koulutustoimijan alaiset oppilaitokset | Koulutustoimija |
Kirjautujalle näytettävät oppilaitokset (schools) | (Tai jatkossa) | Teksti | Valinnainen: Näytetäänkö oppilaitoslistalla vain tietyt koulutustoimijan oppilaitokset | Koulutustoimija |
Kirjautujalta piilotettavat oppilaitokset (excludeschools) | 00907 (Tai jatkossa) 1.2.246.562.10.72449903722 | Teksti | Valinnainen: Poistetaan näkyvistä tietyt koulutustoimijan alaiset oppilaitokset oppilaitoslistalta | Koulutustoimija |
Oppilaitoksen perässä oleva tarkenne (customTitle) | Mansikkalan testi peruskoulu (Mansikkalan testi kunta) | Teksti | Oppilaitosnimen perään lisättävä Koulutustoimijan tarkenne | Koulutustoimija |
Koulutustoimijan käyttäjähakemiston attribuutit ADFS, Google ja Entra -integraatioissa
Katso ajan tasalla olevat attribuutit tästä Koulutustoimijan attribuutit
Sallitut palvelut
Tietokenttä | Esimerkki | Muokattavissa (Kyllä/ei) | Tyyppi | Kuvaus | Lähde |
---|---|---|---|---|---|
Palvelu | Oppimispalvelun nimi | Ei | teksti | - | Koulutustoimija |
Palvelun tunniste | 3000XXX | Ei | Numero | Hallintapalvelun antama yksilöllinen tunniste palvelulle | Hallintapalvelu |
Palvelun omistava organisaatio | Esimerkki yritys Oy | Ei | teksti | - | Palveluntarjoaja |
Sallittu palvelu | Kyllä | Kyllä | kytkin (true/false) | Tietojärjestelmän kytkin (Kyllä/Ei). Koulutustoimija valitsee palvelukohtaisesti sallitaanko MPASSid-kirjautuminen. | Koulutustoimija |
Muokattu | 1.1.2024 | päivämäärä | pvm | Aikaleima, jolloin palveluun on tallennettu muutos. | Hallintapalvelu |
Koulutustoimijan integraatiotyyppikohtaiset tiedot
Entra ID-integraatio
Tietokenttä | Esimerkki | Tyyppi | Kuvaus | Lähde |
---|---|---|---|---|
Integraation tyyppi | Entra ID | Teksti | - | Koulutustoimijan käyttäjähakemisto |
Palveluympäristön tyyppi | Tuotantoympäristö Tuotannon testiympäristö (tuotanto-testi) | Teksti | Tuotantoympäristö, kun integraatio on loppukäyttäjien käytössä. Tuotannon testiympäristö, kun koulutustoimija testaa integraatiota, eikä integraatiota ole vielä julkaistu loppukäyttäjille. | Koulutustoimijan käyttäjähakemisto |
Integraation testauslinkki | https://testilinkki.. | Teksti | Integraation testauksessa käytettävä linkki, jolla integraatiota testataan MPASSid-testipalvelua vasten. | Koulutustoimijan käyttäjähakemisto |
Application ID | 0aa00f00-00c2-0f0e-d000-000fa000000 | Teksti | - | Koulutustoimijan käyttäjähakemisto |
Directory ID (Tenant ID) | a00000a2-3b00-4e95-0a0b-c0aadc04d00b | Teksti | - | Koulutustoimijan käyttäjähakemisto |
Metadatan url | https://login.microsoftonline.com/a00000a2-3b00-4e95-0a0b-c0aadc04d00b/FederationMetadata/2007-06/FederationMetadata.xml | Teksti | - | Koulutustoimijan käyttäjähakemisto |
Client ID | 0aa00f00-00c2-0f0e-d000-000fa000000 | Teksti | - | Koulutustoimijan käyttäjähakemisto |
Client secret | bd693b6a...XXXX | Teksti | Arvoa ei näytetä kokonaan lisäyksen jälkeen. | Koulutustoimijan käyttäjähakemisto |
Client secret:in voimassaolo | 2024-06-20 | Teksti | - | Koulutustoimijan käyttäjähakemisto |
Application ID URI (api://<guid>) | api://0aa00f00-00c2-0f0e-d000-000fa000000 | Teksti | - | Koulutustoimijan käyttäjähakemisto |
Redirect uri | https://mpass-proxy.csc.fi/EsimerkkiTunnistetieto/Shibboleth.sso/SAML2/POST | Teksti | - | Hallintapalvelu |
Tietolähde | azurev4 | Teksti | - | Hallintapalvelu |
Google-integraatio
Tietokenttä | Esimerkki | Tyyppi | Kuvaus | Lähde |
---|---|---|---|---|
Integraation tyyppi | Google: Gsuite | Teksti | - | Koulutustoimija |
Palveluympäristön tyyppi | Tuotantoympäristö Tuotannon testiympäristö (tuotanto-testi) | Teksti | Tuotantoympäristö, kun integraatio on loppukäyttäjien käytössä. Tuotannon testiympäristö, kun koulutustoimija testaa integraatiota eikä integraatiota ole vielä julkaistu loppukäyttäjille. | Koulutustoimija |
Integraation testauslinkki | https://testilinkki.. | Teksti | Integraation testauksessa käytettävä linkki, jolla integraatiota testataan MPASSid-testipalvelua vasten. | Hallintapalvelu |
SAML-metadata | google-idp-metadata.xml | xml-tiedosto | - | Koulutustoimijan käyttäjähakemisto |
Metadatan voimassaolon päättymispäivämäärä (valid until) | 2024-06-20 | Teksti | - | Koulutustoimijan käyttäjähakemisto |
SAML-allekirjoitusvarmenteen voimassaolon päättymispäivämäärä | 2024-06-20 | Teksti | - | Koulutustoimijan käyttäjähakemisto |
SAML-salausvarmenteen voimassaolon päättymispäivämäärä | 2024-06-20 | Teksti | - | Koulutustoimijan käyttäjähakemisto |
ADFS-integraatio
Tietokenttä | Esimerkki | Tyyppi | Kuvaus | Lähde |
---|---|---|---|---|
Integraation tyyppi | ADFS | Teksti | - | Koulutustoimija |
Palveluympäristön tyyppi | Tuotantoympäristö Tuotannon testiympäristö (tuotanto-testi) | Teksti | Tuotantoympäristö, kun integraatio on loppukäyttäjien käytössä. Tuotannon testiympäristö, kun koulutustoimija testaa integraatiota eikä integraatiota ole vielä julkaistu loppukäyttäjille. | Koulutustoimija |
Integraation testauslinkki | https://testilinkki.. | Teksti | Integraation testauksessa käytettävä linkki, jolla integraatiota testataan MPASSid-testipalvelua vasten. | Hallintapalvleu |
ADFS-metadata Url | https://adfs.esimerkki.fi/FederationMetadata/2007-06/FederationMetadata.xml | Teksti | Osoite, josta ajantasaisen metadatan voi hakea. Joko metadatatiedosto tai osoite on pakollinen. | Koulutustoimijan käyttäjähakemisto |
ADFS-metadata | esimerkki-metadata.xml | xml-tiedosto | Metadatatiedosto, mikäli metadataa ei voida hakea internet-yhteyden kautta. Joko metadatatiedosto tai osoite on pakollinen. | Koulutustoimijan käyttäjähakemisto |
Metadatan voimassaolon päättymispäivämäärä (valid until) | 2024-06-20 | Teksti | - | Koulutustoimijan käyttäjähakemisto |
SAML-allekirjoitusvarmenteen voimassaolon päättymispäivämäärä | 2024-06-20 | Teksti | - | Koulutustoimijan käyttäjähakemisto |
SAML-salausvarmenteen voimassaolon päättymipäivämäärä | 2024-06-20 | Teksti | - | Koulutustoimijan käyttäjähakemisto |
Wilma-integraatio
Tietokenttä | Esimerkki | Tyyppi | Kuvaus | Lähde |
---|---|---|---|---|
Integraation tyyppi | Wilma | Teksti | - | Koulutustoimija |
Integraation testauslinkki | https://testilinkki.. | Teksti | Integraation testauksessa käytettävä linkki, jolla integraatiota testataan MPASSid-testipalvelua vasten. | Hallintapalvelu |
Wilma instanssi | esimerkki.inschool.fi | Teksti | - | Koulutustoimijan käyttäjähakemisto |
Opinsys-integraatio
Tietokenttä | Esimerkki | Tyyppi | Kuvaus | Lähde |
---|---|---|---|---|
Integraation tyyppi | Opinsys | Teksti | - | Koulutustoimija |
Integraation testauslinkki | https://testilinkki.. | Teksti | Integraation testauksessa käytettävä linkki, jolla integraatiota testataan MPASSid-testipalvelua vasten. | Hallintapalvelu |
Opinsys instanssin osoite | esimerkki.opinsys.fi | Tämä on nykyisessä konfiguraatiossa Opinsys:n tenant id. | - | Koulutustoimijan käyttäjähakemisto |
Client ID | uid=aaaaa,ou=xxxx,dc=yyy,dc=zzz,dc=cc | Teksti | - | Koulutustoimijan käyttäjähakemisto |
Client Key | xyxyx...yxyxyxxy | Teksti | - | Koulutustoimijan käyttäjähakemisto |
Palvelun tiedot
Versio | Tietokenttä | Esimerkki | Tyyppi | Kuvaus | Lähde |
---|---|---|---|---|---|
1.0 | Rooli | Palvelu | teksti | Tietokentän tyyppi | Hallintapalvelu |
1.0 | Palvelun tunniste | 3000XXX | numero | - | Hallintapalvelu |
1.0 | Oppimispalvelun nimi | Esimerkkipalvelu | Teksti | - | Palveluntarjoaja |
Palveluntarjoajan integraation perustiedot
Versio | Tietokenttä | Esimerkki | Tyyppi | Kuvaus | Lähde |
---|---|---|---|---|---|
1.0 | Hallintapalvelun antama yksilöllinen tunniste integraatiolle | 2000XXX | numero | - | Hallintapalvelu |
1.0 | Rooli | Palveluintegraatio | teksti | Tietokentän tyyppi
| Palveluntarjoaja |
1.0 | Tunnistetietojen tarjoajan yksilöllinen tunniste integraatiolle | OIDC = Client ID SAML2 = Entity ID | Teksti | - | Hallintapalvelu (OIDC) Palveluntarjoaja (SAML) |
1.0 | Integraation tyyppi | OIDC SAML2 | Teksti | - | Palveluntarjoaja |
1.0 | Testioppijanumero sallittu | Kyllä | Kyllä/Ei | Sallitaanko palveluun testioppijanumerosolmuluokalla kirjautuminen? | Palveluntarjoaja |
Palveluntarjoajan integraatiotyyppikohtaiset tiedot
Palveluntarjoajalla voi olla yksi tai useampi integraatio MPASSid-tunnistuksenvälityspalvelussa.
SAML2-integraatio
Tietokenttä | Esimerkki | Tyyppi | Kuvaus | Lähde |
---|---|---|---|---|
Integraatiotyyppi | SAML | Teksti | - | Palveluntarjoaja |
Palveluympäristön tyyppi | Testiympäristö Tuotantoympäristö | Teksti | Onko palvelu kytketty tuotanto tai testiympäristöön | Palveluntarjoaja |
SAML-metadata | XML-tiedosto | Teksti | Palvelun SAML-metadata. | Palveluntarjoaja |
OIDC-integraatio
Tietokenttä | Esimerkki | Tyyppi | Kuvaus | Lähde |
---|---|---|---|---|
Integraatiotyyppi | OIDC | Teksti | - | Palveluntarjoaja |
Palveluympäristön tyyppi | Testiympäristö Tuotantoympäristö | Teksti | Onko palvelu kytketty tuotanto tai testiympäristöön | Palveluntarjoaja |
Client secret | 201b59aff82c5e3..XXX | teksti | Palvelun client secret. Hallintapalvelussa voi generoida uuden arvon. | Hallintapalvelu |
OIDC-json metadata | { "https://maailmanparaspalvelu.fi/oidc/callback/" ], | Teksti | Palveluntarjoaja voi muuttaa muita tietoja tässä kentässä, paitsi client id ja client secret. | Palveluntarjoaja |