Documentatie Adobe Pass Adobe Pass-verificatie

Voorvoegsel js-preauthorize

Last update: Mon Oct 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Onderwerpen:
Authenticatie

NOTE

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.

Overzicht preauth-overview

De methode van de preauthorize API moet door toepassingen worden gebruikt om pre-vergunningsbesluiten voor één of meerdere middelen te verkrijgen. De aanvraag van de API voor voorafgaande toestemming moet worden gebruikt voor UI-tips en/of het filteren van inhoud. Een daadwerkelijke vergunning API verzoek moet worden gemaakt alvorens gebruikerstoegang tot de gespecificeerde middelen toe te staan.

Als er een onverwachte fout optreedt (bijvoorbeeld netwerkprobleem en MVPD-autorisatiepunt niet beschikbaar) wanneer een aanvraag voor een voorafgaande API wordt verwerkt door de Adobe Pass-verificatieservices, wordt er een of meer afzonderlijke foutinformatie opgenomen voor de betrokken bronnen als onderdeel van het resultaat van de eerdere API-reactie.

public preauthorize(request: PreauthorizeRequest, callback: AccessEnablerCallback<any>): void preauth-method

Beschrijving: Deze methode moet door toepassingen worden gebruikt om voor authentiek verklaarde gebruiker (informatieve) besluiten van de Dienst van de Authentificatie van Adobe Pass te verkrijgen om specifieke beschermde middelen te bekijken, voor het primaire doel om UI van de toepassing te versieren (b.v. die op toegangsstatus met slot en ontgrendelingspictogrammen wijzen).

Beschikbaarheid: v4.4.0+

Parameters:

PreauthorizeRequest: Object Builder dat wordt gebruikt om de aanvraag te definiëren
AccessEnablerCallback: callback gebruikt om de API-reactie te retourneren
PreauthorizeResponse: Object dat wordt gebruikt om de inhoud van de API-reactie te retourneren

class PreAuthzeRequestBuilder preath-req-builder-class

setResources(resources: string []): PreauthorizeRequestBuilder set-res-preath-req-buildr

Hiermee stelt u de lijst met bronnen in waarvoor u voorafgaande autorisatiebeslissingen wilt verkrijgen.
Het is verplicht deze in te stellen voor het gebruik van de voorafgaande autorisatie-API.
Elk element in de lijst moet een Koord zijn die of de waarde van middelidentiteitskaart of het mediaRSS fragment vertegenwoordigen dat met MVPD moet worden overeengekomen.
Deze methode stelt de informatie alleen in in de context van de huidige objectinstantie PreauthorizeRequestBuilder , die de ontvanger is van deze methodeaanroep.
Als u een werkelijke PreauthorizeRequest wilt maken, kunt u de methode van PreauthorizeRequestBuilder bekijken:

  build(): PreauthorizeRequest

@param {string[]} resources. De lijst van middelen waarvoor u pre-vergunningsbesluiten wilt verkrijgen.
@returns {PreauthorizeRequestBuilder} De verwijzing naar dezelfde PreauthorizeRequestBuilder -objectinstantie, de ontvanger van de methodeaanroep.
Het doet dit om het creëren van methode het ketenen toe te staan.

disableFeatures (…features: string []): PreauthorizeRequestBuilder disabl-featres-preauth-req-buildr

Hiermee stelt u de functies in die u wilt uitschakelen bij het verkrijgen van beslissingen vóór de autorisatie.
Deze functie stelt de informatie alleen in in de context van de huidige objectinstantie PreauthorizeRequestBuilder , die de ontvanger van deze functieaanroep is.
Als u een werkelijke PreauthorizeRequest wilt maken, kunt u de functie van PreauthorizeRequestBuilder bekijken:

public func build() -> PreauthorizeRequest

@param {string[]} -functies. De reeks functies die u wilt uitschakelen.
@returns De verwijzing naar dezelfde PreauthorizeRequestBuilder -objectinstantie, de ontvanger van de functieaanroep.
Het doet dit om het creëren van functie ketting toe te staan.

build(): preAuthzeRequest preauth-req

Maakt en haalt de referentie van een nieuwe objectinstantie PreauthorizeRequest op.
Deze methode instantieert telkens wanneer een nieuw PreauthorizeRequest -object wordt aangeroepen.
Deze methode gebruikt de waarden die vooraf zijn ingesteld in de context van de huidige objectinstantie PreauthorizeRequestBuilder , die de ontvanger is van deze methodeaanroep.
Houd er rekening mee dat deze methode geen bijwerkingen veroorzaakt.
daarom verandert het de status van de SDK of de status van de objectinstantie PreauthorizeRequestBuilder , die de ontvanger is van deze methodeaanroep, niet.
Dit betekent dat opeenvolgende aanroepen van deze methode voor dezelfde ontvanger verschillende nieuwe PreauthorizeRequest -objectinstanties maken, maar dezelfde informatie hebben, voor het geval de waarden die zijn ingesteld op PreauthorizeRequestBuilder waar ze niet tussen de aanroepen zijn gewijzigd.
Als u geen van de verschafte informatie (bronnen en caching) hoeft bij te werken, kunt u de instantie PreauthorizeRequest opnieuw gebruiken voor meerdere toepassingen van de API voor voorafgaande toestemming.
@returns {PreauthorizeRequest}

interface AccessEnablerCallback<T> interface-access-enablr-callback

onResponse(resultaat: T); on-response-result

De callback van de reactie die door SDK wordt geroepen toen de preauthorize API verzoek werd vervuld.
Het resultaat is een geslaagd resultaat of een foutresultaat met een status.
@param {T} result

onFailed(result: T); on-failure-result

De mislukte callback die door SDK wordt geroepen wanneer het preauthorize API verzoek kon niet worden onderhouden.
Het resultaat is een mislukkingsresultaat dat een status bevat.
@param {T} result

klasse PreauthorizeResponse preauth-response-class

status van het publiek: status; public-status

Retourneert: aanvullende status (status) informatie in het geval van een fout.
Plaats mogelijk een null -waarde.

openbare beslissingen: Besluit []; public-decisions

Retourneert: De lijst met voorafgaande autorisatiebeslissingen. Eén besluit voor elke bron.
De lijst kan leeg zijn in het geval van een fout.

klassestatus class-status

status van het publiek: nummer; public-status-numbr

De HTTP-antwoordstatuscode zoals beschreven in RFC 7231.
De waarde 0 kan zijn als de Status afkomstig is van de SDK in plaats van de Adobe Pass-verificatieservices.

openbare code: nummer; public-code-numbr

De standaardfoutcode voor Adobe Pass Authentication-services.
Kan een lege tekenreeks of een null -waarde bevatten.

openbare boodschap: tekenreeks; public-msg-string

Het gedetailleerde bericht dat in sommige gevallen wordt verstrekt door de MVPD toestemmingseindpunten of door de degradatieregels van de Programmer.
Kan een lege tekenreeks of een null -waarde bevatten.

publieke details: tekenreeks; public-details-strng

Bevat een gedetailleerd bericht dat in sommige gevallen wordt verstrekt door de MVPD toestemmingseindpunten of door de degradatieregels van de Programmer.
Kan een lege tekenreeks of een null -waarde bevatten.

public helpUrl: string; public-help-url-string

De URL die een koppeling bevat naar meer informatie over de oorzaak van deze fout en de mogelijke oplossingen.
Kan een lege tekenreeks of een null -waarde bevatten.

public trace: string; public-trace-string

De unieke id voor deze reactie, die kan worden gebruikt wanneer contact wordt opgenomen met ondersteuning om specifieke problemen in complexere scenario's te identificeren.
Kan een lege tekenreeks of een null -waarde bevatten.

public action: string; public-action-string

De aanbevolen maatregelen om de situatie te verhelpen.
- niets: Jammer genoeg is er geen vooraf bepaalde actie om deze kwestie te verhelpen. Dit kan wijzen op een onjuiste aanroep van de openbare API
- configuratie: Een configuratieverandering is nodig door TVE dashboard of door steun te contacteren.
- toepassing-registratie: De toepassing moet zich opnieuw registreren.
- authentificatie: De gebruiker moet voor authentiek verklaren of opnieuw voor authentiek verklaren.
- vergunning: De gebruiker moet vergunning voor het specifieke middel verkrijgen.
- degradatie: Één of andere vorm van degradatie zou moeten worden toegepast.
- herprobeer: Het opnieuw proberen van het verzoek zou de kwestie kunnen oplossen
- retry-after: Het opnieuw proberen van het verzoek na de vermelde periode zou de kwestie kunnen oplossen.
Kan een lege tekenreeks of een null -waarde bevatten.

klasse-besluit class-decision

public id: string; public-id-string

De bron-id waarvoor het besluit is genomen.

publiek toegestaan : Boolean ; public-auth-boolean

De waarde van de markering die aangeeft of de beslissing succesvol is of niet.

openbare fout: status; public-error-status

Aanvullende status (status)-informatie voor het geval er een fout optreedt. Plaats mogelijk een null -waarde.

Voorbeeld van implementatie van client client-imp-example

let accessEnablerApi = new window.AccessEnabler.AccessEnabler("software statement");
let accessEnablerModels = window.AccessEnabler.models;



// Build request
let requestBuilder = new accessEnablerModels.PreauthorizeRequest.getBuilder();
let request = requestBuilder
    .setResources(["RES01", "RES02", "RES03"])
    .disableFeatures("LOCAL_CACHE")
    .build();



// Create callback
let callback = {
    onResponse(response) {
        // Handle onResponse
    },
    onFailure(response) {
        // Handle onFailure
    }
};

// Invoke call
accessEnablerApi.preauthorize(request, callback);

Scenario-voorbeelden scenario-examples

Scenario 1: alle gevraagde middelen zijn goedgekeurd all-req-res-auth

Scenario 2: Sommige gevraagde middelen zijn toegestaan. sm-req-res-auth

Markering voor verbeterde foutcode

Antwoord

Uitgeschakeld

code language-javascript
`{ "decisions": [ { "id": "RES01", "authorized": true }, { "id": "RES02", "authorized": true }, { "id": "RES03", "authorized": true } ] }`

Scenario 3: Geen van de gevraagde middelen werd toegestaan. none-req-res-auth

Markering voor verbeterde foutcode

Antwoord

Uitgeschakeld

code language-none
`"JavaScript { "besluiten": [ "identiteitskaart": "RES01", "geautoriseerd": waar , "identiteitskaart": "RES02", "geautoriseerd": vals , { "identiteitskaart" RES: "03", "geautoriseerd": waar ] "`

Ingeschakeld

code language-none

code language-none
"JavaScript { "besluiten": [ "identiteitskaart": "RES01", "geautoriseerd": waar , "identiteitskaart": "RES02", "geautoriseerd": vals, "fout": "status": 40 3, "code": "preauthentication_deny_by_mvpd", "bericht": "MVPD heeft een "ontkennen\"besluit teruggegeven wanneer het verzoeken van pre-vergunning voor het gespecificeerde middel.", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", "actie": "niets" }, { "identiteitskaart": "RES03", "geautoriseerd": waar , ] "

 &quot;JavaScript
 &lbrace;
 &quot;besluiten&quot;: &lbrack;

 &quot;identiteitskaart&quot;: &quot;RES01&quot;,
 &quot;geautoriseerd&quot;: waar
,

 &quot;identiteitskaart&quot;: &quot;RES02&quot;,
 &quot;geautoriseerd&quot;: vals,
 &quot;fout&quot;:
 &quot;status&quot;: 40 3,
 &quot;code&quot;: &quot;preauthentication_deny_by_mvpd&quot;,
 &quot;bericht&quot;: &quot;MVPD heeft een &quot;ontkennen\&quot;besluit teruggegeven wanneer het verzoeken van pre-vergunning voor het gespecificeerde middel.&quot;,
 &quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
 &quot;actie&quot;: &quot;niets&quot;

&rbrace;,
 &lbrace;
 &quot;identiteitskaart&quot;: &quot;RES03&quot;,
 &quot;geautoriseerd&quot;: waar
,
&rbrack;


&quot;

Scenario 4: Onjuist verzoek van de cliënt - geen gespecificeerde middelen. bad-cl-req-no-res-sp

Markering voor verbeterde foutcode

Antwoord

Uitgeschakeld

code language-none
`"JavaScript { "besluiten": [ "identiteitskaart": "RES01", "geautoriseerd": vals , "identiteitskaart": "RES02", "geautoriseerd": vals , { "identiteitskaart" RES: 03", "geautoriseerd": vals ] "`

Ingeschakeld

code language-none

code language-none
"JavaScript { "besluiten": [ { "identiteitskaart": "RES01", "geautoriseerd": vals, "fout": "status": 403, "code": "preauthentication_deny_by_mvpd", "bericht": "MVPD heeft Keerde een "Weigeren\"besluit terug toen het verzoeken van pre-vergunning voor het gespecificeerde middel.", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", "actie": "niets" , { "id": "RES02", "geautoriseerd": vals, } "error": { "status": 403, "code": "prepermission_by_mvpd", "message": "MVPD heeft een "Weigering\"besluit teruggegeven toen het verzoeken van pre-vergunning voor het gespecificeerde middel.", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", } "actie": "niets" , { "identiteitskaart": "RES03", "toegestaan": vals, "fout": "status": 403, "code": "maximum_executing_time_over", "message": "The request did not complete in the maximum allowed time. Het opnieuw proberen van het verzoek zou de kwestie kunnen oplossen.", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", "actie": "retry" ] "

 &quot;JavaScript

 &lbrace;
 &quot;besluiten&quot;: &lbrack;
 &lbrace;
 &quot;identiteitskaart&quot;: &quot;RES01&quot;,
 &quot;geautoriseerd&quot;: vals,
 &quot;fout&quot;:
 &quot;status&quot;: 403,
 &quot;code&quot;: &quot;preauthentication_deny_by_mvpd&quot;,
 &quot;bericht&quot;: &quot;MVPD heeft Keerde een &quot;Weigeren\&quot;besluit terug toen het verzoeken van pre-vergunning voor het gespecificeerde middel.&quot;,
 &quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
 &quot;actie&quot;: &quot;niets&quot;

,
 &lbrace;
 &quot;id&quot;: &quot;RES02&quot;,
 &quot;geautoriseerd&quot;: vals,
&rbrace; &quot;error&quot;: &lbrace;
 &quot;status&quot;: 403,
 &quot;code&quot;: &quot;prepermission_by_mvpd&quot;,
 &quot;message&quot;: &quot;MVPD heeft een &quot;Weigering\&quot;besluit teruggegeven toen het verzoeken van pre-vergunning voor het gespecificeerde middel.&quot;,
 &quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
&rbrace; &quot;actie&quot;: &quot;niets&quot;

,
 &lbrace;
 &quot;identiteitskaart&quot;: &quot;RES03&quot;,
 &quot;toegestaan&quot;: vals,
 &quot;fout&quot;:
 &quot;status&quot;: 403,
 &quot;code&quot;: &quot;maximum_executing_time_over&quot;,
&quot;message&quot;: &quot;The request did not complete in the maximum allowed time. Het opnieuw proberen van het verzoek zou de kwestie kunnen oplossen.&quot;,
 &quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
 &quot;actie&quot;: &quot;retry&quot;


&rbrack;


&quot;

Markering voor verbeterde foutcode

Antwoord

Uitgeschakeld/Ingeschakeld

code language-none

code language-none
`"JavaScript { "status": "status": 400, "code": "internal_error", "message": "The request failed due to an internal error.", "details": "Required String[] parameter "resource" is not present", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", "actie": "niets" , "besluiten": [] "`

 &quot;JavaScript
 &lbrace;
 &quot;status&quot;:
 &quot;status&quot;: 400,
 &quot;code&quot;: &quot;internal_error&quot;,
 &quot;message&quot;: &quot;The request failed due to an internal error.&quot;,
 &quot;details&quot;: &quot;Required String[] parameter &quot;resource&quot; is not present&quot;,
 &quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
 &quot;actie&quot;: &quot;niets&quot;
,
 &quot;besluiten&quot;: []

&quot;

Scenario 5: Onjuist cliëntverzoek - lege gespecificeerde middelen. bad-cl-req-empt-res-sp

Markering voor verbeterde foutcode

Antwoord

Uitgeschakeld/Ingeschakeld

code language-none

code language-none
`"JavaScript { "status": "status": 412, "code": "missing_resource", "bericht": "De middelparameter mist", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", "actie": "niets" , "decisions": [] } "`

 &quot;JavaScript
 &lbrace;
 &quot;status&quot;:
 &quot;status&quot;: 412,
 &quot;code&quot;: &quot;missing_resource&quot;,
 &quot;bericht&quot;: &quot;De middelparameter mist&quot;,
 &quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
 &quot;actie&quot;: &quot;niets&quot;
,
 &quot;decisions&quot;: []
&rbrace;
&quot;

Scenario 6: De fout van het netwerk. ntwrk-error

Markering voor verbeterde foutcode

Antwoord

Ingeschakeld

code language-none

code language-none
"JavaScript { "besluiten": [ "identiteitskaart": "RES01", "geautoriseerd": vals, "fout": "status": "code": "network_receive_error", "bericht": "Er was een gelezen fout terwijl het terugwinnen van de reactie de bijbehorende partnerdienst. Het opnieuw proberen van het verzoek zou de kwestie kunnen oplossen.", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", "actie": "retry" , "id": "RES02", "toegelaten": vals, "fout": "status": 403, "code": "network_receive_error", "bericht": "Er was een gelezen fout terwijl het terugwinnen van de reactie van de bijbehorende partnerdienst. Het opnieuw proberen van het verzoek zou de kwestie kunnen oplossen.", "helpUrl": "https://experienceleague.adobe.com/docs/primetime/authentication/home.html", "actie": "retry" ] "

 &quot;JavaScript
 &lbrace;
 &quot;besluiten&quot;: &lbrack;

 &quot;identiteitskaart&quot;: &quot;RES01&quot;,
 &quot;geautoriseerd&quot;: vals,
 &quot;fout&quot;:
 &quot;status&quot;:
 &quot;code&quot;: &quot;network_receive_error&quot;,
 &quot;bericht&quot;: &quot;Er was een gelezen fout terwijl het terugwinnen van de reactie de bijbehorende partnerdienst. Het opnieuw proberen van het verzoek zou de kwestie kunnen oplossen.&quot;,
 &quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
 &quot;actie&quot;: &quot;retry&quot;

,

 &quot;id&quot;: &quot;RES02&quot;,
 &quot;toegelaten&quot;: vals,
 &quot;fout&quot;:
 &quot;status&quot;: 403,
 &quot;code&quot;: &quot;network_receive_error&quot;,
 &quot;bericht&quot;: &quot;Er was een gelezen fout terwijl het terugwinnen van de reactie van de bijbehorende partnerdienst. Het opnieuw proberen van het verzoek zou de kwestie kunnen oplossen.&quot;,
 &quot;helpUrl&quot;: &quot;https://experienceleague.adobe.com/docs/primetime/authentication/home.html&quot;,
 &quot;actie&quot;: &quot;retry&quot;


&rbrack;

&quot;

Scenario 7: De stroom van de pre-autorisatie werd aangehaald zonder een geldige zitting AuthN.

Markering voor verbeterde foutcode

Antwoord

Uitgeschakeld/Ingeschakeld

code language-none

code language-none
`"JavaScript { "status": "status": 0, "code": "authentication_session_missing", "bericht": "De authentificatiesessie verbonden aan dit verzoek kon niet worden teruggewonnen. De gebruiker moet met gesteunde MVPD opnieuw voor authentiek verklaren om verder te gaan.", "actie": "authentificatie" , "besluiten": [] "`

 &quot;JavaScript
 &lbrace;
 &quot;status&quot;:
 &quot;status&quot;: 0,
 &quot;code&quot;: &quot;authentication_session_missing&quot;,
 &quot;bericht&quot;: &quot;De authentificatiesessie verbonden aan dit verzoek kon niet worden teruggewonnen. De gebruiker moet met gesteunde MVPD opnieuw voor authentiek verklaren om verder te gaan.&quot;,
 &quot;actie&quot;: &quot;authentificatie&quot;
,
 &quot;besluiten&quot;: []


&quot;

Scenario 8: de stroom van de preAutorisate werd aangehaald alvorens de reeksRequestor vraag werd voltooid

Markering voor verbeterde foutcode

Antwoord

Uitgeschakeld/Ingeschakeld

code language-none

code language-none
`"JavaScript { "status": "status": 0, "code": "requestor_not_configured", "bericht": "De aanvrager is nog niet gevormd die een eerste vereiste voor het gebruiken van om het even welke API behalve setRequestor API." is, "actie": "retry" , "besluiten": [] "`

 &quot;JavaScript
 &lbrace;
 &quot;status&quot;:
 &quot;status&quot;: 0,
 &quot;code&quot;: &quot;requestor_not_configured&quot;,
 &quot;bericht&quot;: &quot;De aanvrager is nog niet gevormd die een eerste vereiste voor het gebruiken van om het even welke API behalve setRequestor API.&quot; is,
 &quot;actie&quot;: &quot;retry&quot;
,
 &quot;besluiten&quot;: []

&quot;

recommendation-more-help

3f5e655c-af63-48cc-9769-2b6803cc5f4b