DocumentatieAdobe PassAdobe Pass-verificatie

Verificatiesessie maken create-authentication-session

Last update: Tue Oct 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
IMPORTANT
De inhoud op deze pagina wordt alleen ter informatie verstrekt. Voor het gebruik van deze API is een huidige licentie van Adobe vereist. Ongeautoriseerd gebruik is niet toegestaan.
IMPORTANT
De implementatie van REST API V2 wordt begrensd door de Throttling mechanismedocumentatie.

Verzoek request

HTTP
pad
/api/v2/{serviceProvider}/sessies
methode
POST
Padparameters
serviceProvider
De interne unieke id die tijdens het instapproces aan de Serviceleverancier is gekoppeld.
vereist
Bodyparameters
mvpd
De interne unieke id die tijdens het instapproces aan de identiteitsprovider is gekoppeld.

Als het streamingapparaatplatform beperkingen heeft op het opgeven van een waarde, moet een toepassing de verificatiesessie hervatten en een geldige waarde opgeven.
vereist
domainName
Het oorspronkelijke domein van de toepassing die MVPD-aanmelding uitvoert.

Als het streamingapparaatplatform beperkingen heeft op het opgeven van een waarde, moet een toepassing de verificatiesessie hervatten en een geldige waarde opgeven.
vereist
redirectUrl
De laatste omleiding URL waaraan de gebruikersagent navigeert wanneer de authentificatiestroom voor MVPD wordt voltooid.

De waarde moet URL-gecodeerd zijn.

Als het streamingapparaatplatform beperkingen heeft op het opgeven van een waarde, moet een toepassing de verificatiesessie hervatten en een geldige waarde opgeven.
vereist
Kopteksten
Toestemming
De generatie van de toonder symbolische nuttige lading wordt beschreven in de 1} kopbaldocumentatie van de Toestemming {.
vereist
Inhoudstype
Het geaccepteerde mediatype voor de bronnen die worden verzonden.

Het moet application/x-www-form-urlencoded zijn.
vereist
AP-apparaat-id
De generatie van de apparatenherkenningstekenlading wordt beschreven in AP-apparaat-Identifierkopbaldocumentatie.
vereist
X-Apparaat-Info
De generatie van de lading van de apparateninformatie wordt beschreven in x-apparaat-Infokopbaldocumentatie.

Het wordt ten zeerste aanbevolen deze altijd te gebruiken wanneer het apparaatplatform van de toepassing expliciet geldige waarden biedt.

Als deze optie is opgegeven, worden waarden met geëxtraheerde waarden expliciet samengevoegd met de Adobe Pass-verificatieachterkant (standaard).

Als deze optie niet is opgegeven, gebruikt de Adobe Pass Authentication-backend impliciet geëxtraheerde waarden (standaard).
vereist
X-Forwarded-For
Het IP-adres van het streamingapparaat.

Het wordt sterk geadviseerd om het voor server aan serverimplementaties altijd te gebruiken, vooral wanneer de vraag door de programmeerdienst eerder dan het het stromen apparaat wordt gemaakt.

Voor client-naar-server-implementaties wordt het IP-adres van het streamingapparaat impliciet verzonden.
optioneel
Adobe-Onderwerptoken
De generatie van enige sign-on lading voor de methode van de Identiteit van het Platform wordt beschreven in Adobe-Onderwerp-Symbolischekopbaldocumentatie.

Voor meer details over enige sign-on toegelaten stromen die een platformidentiteit gebruiken, verwijs naar Enige sign-on gebruikend de stromen van de platformidentiteitdocumentatie.
optioneel
AD-Service-Token
De generatie van enige sign-on lading voor de Symbolische methode van de Dienst wordt beschreven in de AD-dienst-Symbolischekopbaldocumentatie.

Voor meer details over enige sign-on toegelaten stromen gebruikend een de dienstteken, verwijs naar Enige sign-on gebruikend de stromen van het de diensttekendocumentatie.
optioneel
Accepteren
Het mediatype dat door de clienttoepassing wordt geaccepteerd.

Indien gespecificeerd, moet het application/json zijn.
optioneel
Gebruikersagent
De gebruikersagent van de clienttoepassing.
optioneel

Antwoord response

Code
Tekst
Beschrijving
200
OK
De reactieinstantie bevat informatie over de volgende acties nodig om authentificatie uit te voeren.
400
Ongeldig verzoek
De aanvraag is ongeldig, de client moet de aanvraag corrigeren en het opnieuw proberen. Het reactielichaam kan fouteninformatie bevatten die aan de Verbeterde documentatie van de Codes van de Foutvolgt.
401
Ongeautoriseerd
Het toegangstoken is ongeldig, moet de cliënt een nieuw toegangstoken verkrijgen en opnieuw proberen. Voor meer details verwijs naar de Dynamische documentatie van de Registratie van de Cliënt van het Overzicht.
405
Methode niet toegestaan
De HTTP-methode is ongeldig, de client moet een HTTP-methode gebruiken die is toegestaan voor de aangevraagde resource en het opnieuw proberen. Voor meer details verwijs naar de 1} sectie van het Verzoek {.
500
Interne serverfout
Er is een probleem opgetreden op de server. Het reactielichaam kan fouteninformatie bevatten die aan de Verbeterde documentatie van de Codes van de Foutvolgt.

Succes success

Kopteksten
Status
200
vereist
Inhoudstype
application/json
vereist
Lichaam

JSON-object met de volgende kenmerken:

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff 9-bgcolor-deebff 13-bgcolor-deebff 17-bgcolor-deebff 21-bgcolor-deebff 25-bgcolor-deebff 29-bgcolor-deebff 33-bgcolor-deebff layout-auto html-authored
Kenmerk
actionName

De handeling die het streamingapparaat moet uitvoeren om de verificatiestroom te voltooien.

De mogelijke waarden zijn:

  • verklaart
    voor authentiek het stromen apparaat of een ander apparaat moet verstrekte URL in een gebruikersagent openen.
  • hervat
    het stromen apparaat of een ander apparaat moet de ontbrekende parameters verstrekken en de authentificatiesessie hervatten gebruikend de code.
  • machtigt
    het stromen apparaat kan met besluitvormingsstromen direct te werk gaan.
 vereist
actionType

Het type interactie dat het streamingapparaat moet uitvoeren om door te gaan met de handeling die is opgegeven door het kenmerk 'actionName'.

De mogelijke waarden zijn:

  • interactief
    De stroom gaat met een navigatie aan verstrekte URL voort gebruikend een gebruikersagent.
  • direct
    de stroom gaat met een directe vraag aan verstrekte URL voort gebruikend een cliënt van HTTP beschikbaar voor de cliëntimplementatie.
 vereist
missingParameters De ontbrekende parameters die moeten worden verstrekt om de basisauthentificatiestroom te voltooien. optioneel
url De URL waar de clienttoepassing moet navigeren. optioneel
code De authentificatiecode die op een secundaire toepassing kan worden gebruikt om de authentificatiesessie te hervatten. vereist
sessionId De dekkende id die kan worden gebruikt voor het bijhouden van de gebruikersactiviteit. vereist
mvpd De interne unieke id die tijdens het instapproces aan de identiteitsprovider is gekoppeld. optioneel
serviceProvider De interne unieke id die tijdens het instapproces aan de Serviceleverancier is gekoppeld. vereist
vereist

Fout error

Kopteksten
Status
400, 401, 405, 500
vereist
Inhoudstype
application/json
vereist
Lichaam
Het reactielichaam kan extra fouteninformatie verstrekken die aan de Verbeterde documentatie van de Codes van de Foutvolgt.
vereist

Voorbeelden samples

1. Maak een verificatiesessie zonder ontbrekende parameters

Verzoek
code language-https 
POST /api/v2/REF30/sessions HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=Cablevision&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com
Reactie
code language-https 
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "actionName": "authenticate",
    "actionType": "interactive",
    "url": "/api/v2/authenticate/REF30/8ER640M",
    "code": "8ER640M",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "Cablevision",
    "serviceProvider": "REF30"
}

2. Maak een verificatiesessie met ontbrekende parameters

Verzoek
code language-https 
POST /api/v2/REF30/sessions HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:
Reactie
code language-https 
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "actionName": "resume",
    "actionType": "direct",
    "url": "/api/v2/REF30/sessions/8ER640M",
    "missingParameters": ["mvpd", "domain", "redirectUrl"],
    "code": "8ER640M",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "serviceProvider": "REF30"
}

3. Maak een verificatiesessie terwijl er al een geldig profiel bestaat

Verzoek
code language-https 
POST /api/v2/REF30/sessions HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=TempPass_TEST40&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com
Reactie
code language-https 
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "actionName": "authorize",
    "actionType": "direct",
    "url": "/api/v2/REF30/decisions/authorize/TempPass_TEST40",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "TempPass_TEST40",
    "serviceProvider": "REF30"
}

5. Maak een verificatiesessie terwijl de degradatie wordt toegepast

Verzoek
code language-https 
POST /api/v2/REF30/sessions HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    Content-Type: application/x-www-form-urlencoded
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

Body:

mvpd=Cablevision&domainName=adobe.com&redirectUrl=https%3A%2F%2Fadobe.com
Reactie
code language-https 
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "actionName": "authorize",
    "actionType": "direct",
    "url": "/api/v2/REF30/decisions/authorize/Cablevision",
    "sessionId": "1b614390-6610-4d14-9421-6565f6e75958",
    "mvpd": "Cablevision",
    "serviceProvider": "REF30"
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b