OAuth2

Prenly tukee OAuth2:ta OpenID Connect -laajennuksen (OIDC) kanssa tai ilman sitä, kunhan valtuutuspalvelin noudattaa OAuth2-määrittelyä RFC 6749. Tarvitset todennäköisesti valtuutuspalvelimen, joka tukee OIDC:tä.

Prenly tukee vain valtuutuksen myöntämistä Authorization Code.

Asiakas, jota Prenly käyttää OAuth2-virrassa, on e-paperin sovellusviranomainen (tekninen toteutus, joka päättää, miten e-paperisovellus käsittelee todennuksen ja valtuutuksen Prenlyn backendissä).

Prenlyn on tiedettävä muutama asia voidakseen toimia asiakkaana valtuutusvirrassa:

- Valinnainen*. Valittu liikkeeseenlaskija.
Tämä on pakollinen vain, jos haluat käyttää OpenID Connect -laajennuksen ID-tunnisteen vaatimusta.

- Pakollinen. Asiakastunnus, jota haluat Prenly-valtuutuksen käyttävän.

- Pakollinen. Asiakassalaisuus, jota haluat Prenly-viranomaisen käyttävän vaihtaessaan annettua valtuutuslupaa käyttöoikeustunnisteeseen Prenly-viranomaisen (asiakkaan) todentamisen yhteydessä.

- Valinnainen. Laajuus. Voit valita, että Prenly käyttää välilyönnillä erotettua luetteloa laajuuksista, jotka määrittelevät myönnetyn tokenin käyttöoikeuden. Laajuusaluetta (laajuuksia) käytetään valtuutuksen päätepisteen kanssa.

- Valinnainen. Tila. Prenly tukee tilan tuottamista valtuutuspyynnössä. Voit joko antaa Prenlyn luoda tilan tai antaa viranomaisen ohittaa sen.

- Pakollinen. Valtuutuksen päätepiste. Prenly-viranomainen ohjaa käyttäjäagentin tähän päätepisteeseen aloittaakseen valtuutusvirran valtuutuspalvelimen kanssa kirjautumalla sisään käyttäjälle valtuutuskoodin myöntämistä varten.

- Pakollinen. Token-päätepiste. Prenly-viranomainen yrittää vaihtaa käyttäjän valtuutuskoodin käyttöoikeustunnisteeseen tai, jos valtuutuspalvelin tukee sitä (mikä on erittäin suositeltavaa), vaihtaa käyttäjän päivitystunnisteen uuteen käyttöoikeustunnisteeseen.

Tunnistusmenetelmä. Oletusarvoisesti Prenly käyttää OIDC:n asiakkaan todennusmenetelmää client_secret_basic todennettaessa valtuutuspalvelimen token-päätepisteen kanssa. Prenly tukee myös asiakkaan todennusmenetelmää client_secret_post. Ilmoita Prenlylle, jos tarvitset jälkimmäistä, muuten käytetään oletustodennusmenetelmää.

- Suositellaan. Ulkoinen URL-osoite käyttäjän uloskirjautumista varten. Prenly-valtuutus käyttää nykyisen käyttäjän valitsemaa käyttäjäagenttia kirjautuakseen käyttäjän ulos etänä valtuutuspalvelimella.
Prenly pystyy käyttämään URL-osoitteessa paikannussääntöjä, kun se luo valtuutuspyyntöä käyttäjän uloskirjautumista varten, antamalla seuraavat tiedot:

◦ Asiakastunnus;
◦ uloskirjautumisen palautus-URI;
◦ uloskirjautumisvirheen URI;

Huomaa, että tilaa ei voi käyttää.
Esimerkki paluu-URI-kyselyparametrista on "post_logout_redirect_uri".

Tällä hetkellä uloskirjautumis-URL:ssa tuetaan vain HTTP-menetelmää GET.

Käyttäjätunnus

Prenly-viranomaisen on tiedettävä, miten yksilöllinen käyttäjätunnus voidaan poimia sen jälkeen, kun valtuutuspalvelin on onnistuneesti valtuuttanut käyttäjän.

Jos käytät Prenly Remote authority API:ta, tämä yksilöllinen käyttäjätunnus on `uid`-pyyntöparametri, kun pyydät käyttäjän yhteenvetotietoja.

Voit valita jonkin seuraavista menetelmistä:

- JSON-tokenin päätepisteen vastauksessa olevasta ominaisuudesta. Jos valitset tämän, sinun on ilmoitettava meille valitsemasi ominaisuuden nimi, joka sisältää käyttäjätunnuksen.

- Allekirjoitetun ID-tunnisteen OpenID Connectin "sub"-väitteestä (joka palautetaan tunnisteen "id_token"-vastausominaisuudella.
Jotta käyttäjätunnus voidaan poimia, sinun on myös annettava seuraavat tiedot:

◦ Pakollinen. Ulkoinen URL-osoite julkisiin avaimiin ID-tunnisteiden validointia varten. Tämän URL-osoitteen on sisällettävä JWT-standardien mukainen JSON Web Key Set, johon voidaan viitata joko nimellä JKU tai JWKS.
◦ Valinnainen. Asiakasnumeron sisältävän ominaisuuden nimi käyttäjätietovastauksessa.

- UserInfo-päätepisteen "sub"-ominaisuusvastauksesta.
Tämän menetelmän käyttämiseksi sinun on myös annettava:

◦ Pakollinen. UserInfo-päätepisteen URL-osoite. Päätepistettä käytetään hakemaan perustietoja käyttäjästä käyttämällä käyttäjän käyttöoikeustunnusta pyynnön hyväksymiseksi.
◦ Valinnainen. Asiakasnumeron sisältävän ominaisuuden nimi käyttäjätietovastauksessa.

Resurssipalvelin

Voit valita resurssipalvelimen, jota Prenly tukee, tai voit ottaa meihin yhteyttä osoitteessa hello@prenly.com ja esittää Prenlylle pyynnön tukea juuri sinun resurssipalvelimesi integrointitehtävänä, jota Prenly saattaa tukea maksullisen kehitystehtävän perusteella.

Prenly tukee resurssipalvelimena Prenly Remote authority API:n versiota 1.4 tai uudempaa versiota. Katso tämän API:n käsite Prenly Remote authority API:ta koskevista yleisistä tiedoistamme. Jos haluat toteuttaa Prenly Remote authority API:n resurssipalvelimena, tutustu päätepisteen /oauth2/getUser API-määrittelyyn.

Resurssi, jota Prenly pyytää resurssipalvelimelta, on luettelo käyttäjään liittyvistä tilaustuotteista. Tuotekoodin muodossa olevat tuotteet ilmaisevat käyttäjän tilaustilan, jossa kukin koodi on määritetty antamaan lukuoikeus julkaisuihin e-paperisovelluksessasi.

Jotta voit myöntää oikean lukuoikeuden tilaustuotteesta riippuen, sinun on myös ilmoitettava Prenlylle, mihin julkaisuihin tuotekoodi oikeuttaa lukuoikeuden. Kaikki tuntemattomat tuotteet jätetään huomiotta.

Et ehkä tarvitse omaa resurssipalvelinta...

Prenly voi ohittaa perinteisen resurssipalvelimen kokonaan, jos UserInfo-päätepisteesi pystyy paljastamaan resurssin omistajan - käyttäjän - tilaustilanteen.

Jos UserInfo-päätepisteesi kykenee siihen, sinun tarvitsee vain antaa väite (ominaisuuden nimi) UserInfo-päätepisteen JSON-vastauksen tiedoissa.

Väitteen arvon on oltava merkkijonojen JSON-luettelo (array). Kukin luettelon kohde edustaa tilaustuotekoodia.

Anna tiedot

Kun sinulla on kaikki vaaditut tiedot, ota yhteyttä Prenlyn asiakaspalveluun osoitteessa hello@prenly.com ja ilmoita tiedot. Tiimi määrittää sitten valitsemasi e-paperisovelluksen Prenly-valtuutuksen käyttämään OAuth2:ta puolestasi.