DokumentationAdobe PassAdobe Pass-autentisering

REST API-referens rest-api-reference

Last update: Mon Aug 26 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
Innehållet på den här sidan tillhandahålls endast i informationssyfte. Användning av denna API kräver en aktuell licens från Adobe. Ingen obehörig användning är tillåten.

Begränsningsmekanism

REST-API:t för Adobe Pass-autentisering styrs av en begränsningsmekanism.

Svarsformat response-formats

NOTE
De API:er som tillhandahålls i dessa tjänster kan returnera svar i antingen XML eller JSON (för API:er som returnerar ett svar). Det finns tre olika sätt att ange svarsformatet i begäran:
  • Ange HTTP Accept Header till application/xml eller application/json.
  • Ange parametern format=xml eller format=json i nyttolasten för begäran.
  • Anropa webbtjänstens slutpunkt med tillägget .xml eller .json. Till exempel /regcode.xml eller /regcode.json
Du kan ange en ENDA av ovanstående metoder. Om du anger flera metoder med olika format kan det leda till fel eller oönskade utdata.

REST API-slutpunkter clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

Sammanfattning av webbtjänster web_srvs_summary

Tabellen nedan visar de tillgängliga webbtjänsterna för kundlösa metoder. Klicka på webbtjänstens slutpunkter om du vill ha mer information (exempelbegäran och svar, indataparametrar, HTTP-metoder osv.)

Sr
Slutpunkt för webbtjänst
Beskrivning
.
Hosted At
Anropat av
1.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode
Returnerar slumpmässigt genererad registreringskod och inloggningssidans URI
2
Adobe
Reg Code Service
Smart enhet
2.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
Returnerar registreringskodposten som innehåller registreringskoden UUID, registreringskoden och hash-enhets-ID
8
Adobe
Reg Code Service
Adobe Pass-autentisering
3.
<SP_FQDN>/api/v1/config/
{requestorId}
Returnerar en lista över konfigurerade MVPD-filer för den som gjorde begäran
5
Adobe
Adobe Pass
authentication
Service
Logga in
på webben
4.
<SP_FQDN>/api/v1/authenticate
Initierar AuthN-processen genom att informera MVPD-markeringshändelsen. Skapar en post i autentiseringsdatabasen som är avstämd när ett godkänt svar tas emot från MVPD (steg 13)
7
Adobe
Adobe Pass
authentication
Service
Logga in
på webben
5.
SAML Assertion Consumer
Befintligt SAML-arbetsflöde mellan Adobe Pass Authentication och MVPD
13
Tjänsten Adobe Pass
authentication
Service
Adobe Pass-autentisering
6.
<SP_FQDN>/api/v1/checkauthn/
{registrationCode}
Inloggningswebbappen kan kontrollera om inloggningsflödet lyckades
Adobe Pass
autentisering
Service
Inloggning
Webben
App
7.
<SP_FQDN>/api/v1/tokens/authn
Hämtar AuthN-tokenrelaterade metadata
15
Tjänsten Adobe Pass
authentication
Service
Smart enhet
8.
<REGGIE_FQDN>/reggie/v1/
{requestorId}/regcode/
{registrationCode}
Tar bort reg.kodposten och släpper reg.koden för återanvändning
16
Adobe
Reg Code Service
Adobe Pass-autentisering
9.
<SP_FQDN>/api/v1/authorized
Hämtar auktoriseringssvar.
17
Tjänsten Adobe Pass
authentication
Service
Smart enhet
10.
<SP_FQDN>/api/v1/checkauthn
Anger om enheten har en AuthN-token som inte har gått ut.
Tjänsten Adobe Pass
authentication
Service
Smart enhet
11.
<SP_FQDN>/api/v1/tokens/authn
Returnerar AuthN-token om den hittas.
Tjänsten Adobe Pass
authentication
Service
Smart enhet
12.
<SP_FQDN>/api/v1/tokens/authz
Returnerar AuthZ-token om den hittas.
Tjänsten Adobe Pass
authentication
Service
Smart enhet
13.
<SP_FQDN>/api/v1/tokens/media
Returnerar Short Media Token om den hittas - samma som /api/v1/mediatoken
Tjänsten Adobe Pass
authentication
Service
Smart enhet
14.
<SP_FQDN>/api/v1/mediatoken
Hämtar kort mediatoken
Tjänsten Adobe Pass
authentication
Service
Smart enhet
15.
<SP_FQDN>/api/v1/preauthorized
Hämtar listan över förauktoriserade resurser
Tjänsten Adobe Pass
authentication
Service
Smart enhet
16.
<SP_FQDN>/api/v1/preauthorized/{code}
Hämtar listan över förauktoriserade resurser
Tjänsten Adobe Pass
authentication
Service
Inloggningswebbapp
17.
<SP_FQDN>/api/v1/log
Ta bort AuthN- och AuthZ-tokens från lagring
Adobe Pass
autentisering
Service
Smart enhet
18.
<SP_FQDN>/api/v1/tokens/usermetadata
Hämtar användarmetadata när autentiseringsflödet har slutförts
Ej tillämpligt
Ej tillämpligt
Smart enhet
19.
<SP_FQDN>/api/v1/authenticate/freepreview
Skapa en autentiseringstoken för tillfälligt pass eller tillfälligt kampanjpass
Ej tillämpligt
Tjänsten Adobe Pass
authentication
Service
Smart enhet

REST API-säkerhet security

Alla Adobe Pass Authentication REST API:er måste anropas med HTTPS-protokollet för säker kommunikation. Dessutom bör de flesta API:er som anropas innehålla en åtkomsttoken som hämtas enligt beskrivningen i API-dokumentationen för Hämta åtkomsttoken.

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b