Verbesserte Fehler-Codes enhanced-error-codes

Erweiterte Fehler-Codes stellen eine Adobe Pass-Authentifizierungsfunktion dar, die zusätzliche Fehlerinformationen für in integrierte Client-Anwendungen bereitstellt:

Darstellung enhanced-error-codes-representation

Erweiterte Fehler-Codes können je nach integrierter Adobe Pass-Authentifizierungs-API und dem verwendeten Kopfzeilenwert „Accept“ (d. h. JSON oder XML) im application/json- oder application/xml-Format dargestellt werden:

REST API v2

Siehe die folgenden HTTP-Antworten mit Beispielen für erweiterte Fehler-Codes, die JSON für die REST-API v2 gelten.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "decisions": [
    {
      "resource": "REF30",
      "serviceProvider": "REF30",
      "mvpd": "Cablevision",
      "source": "mvpd",
      "authorized": true,
      "token": {
        "issuedAt": 1697094207324,
        "notBefore": 1697094207324,
        "notAfter": 1697094802367,
        "serializedToken": "PHNpZ25hdHVyZUluZm8..."
      }
    },
    {
      "resource": "REF40",
      "serviceProvider": "REF40",
      "mvpd": "Cablevision",
      "source": "mvpd",
      "authorized": false,
      "error" : {
        "action": "none",
        "status": 403,
        "code": "authorization_denied_by_mvpd",
        "message": "The MVPD has returned a \"Deny\" decision when requesting authorization for the specified resource",
        "details": "Your subscription package does not include the \"Live\" channel",
        "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=de",
        "trace": "12f6fef9-d2e0-422b-a9d7-60d799abe353"
      }
    }
  ]
}

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "action": "none",
  "status": 400,
  "code": "invalid_parameter_service_provider",
  "message": "The service provider parameter value is missing or invalid.",
  "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=de",
  "trace": "12f6fef9-d2e0-422b-a9d7-60d799abe353"
}

REST-API v1

Siehe die folgenden HTTP-Antworten mit Beispielen für erweiterte Fehler-Codes, die als JSON oder XML für die REST-API v1 dargestellt werden.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "resources": [
    {
      "id": "TestStream1",
      "authorized": true
    },
    {
      "id": "TestStream2",
      "authorized": false,
      "error": {
        "action": "none",
        "status": 403,
        "code": "authorization_denied_by_mvpd",
        "message": "The MVPD has returned a \"Deny\" decision when requesting authorization for the specified resource",
        "details": "Your subscription package does not include the \"Live\" channel",
        "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=de",
        "trace": "12f6fef9-d2e0-422b-a9d7-60d799abe353"
      }
    }
  ]
}

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "action": "none",
  "status": 400,
  "code": "invalid_requestor",
  "message": "The requestor parameter is missing or invalid.",
  "helpUrl": "https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=de",
  "trace": "8bcb17f9-b172-47d2-86d9-3eb146eba85e"
}

HTTP/1.1 400 Bad Request
Content-Type: application/xml

<error>
  <action>none</action>
  <status>400</status>
  <code>invalid_requestor</code>
  <message>The requestor parameter is missing or invalid.</message>
  <helpUrl>https://experienceleague.adobe.com/docs/pass/authentication/auth-features/error-reportn/enhanced-error-codes.html?lang=de</helpUrl>
  <trace>8bcb17f9-b172-47d2-86d9-3eb146eba85e</trace>
</error>

Struktur enhanced-error-codes-representation-structure

Erweiterte Fehler-Codes enthalten die folgenden JSON Felder oder XML Attribute mit Beispielen:

Aktion enhanced-error-codes-representation-action

Erweiterte Fehler-Codes enthalten ein Feld „Aktion“, das eine empfohlene Aktion bereitstellt, mit der die Situation behoben werden kann.

Zu den möglichen Werten für das Feld „Aktion“ gehören:

(*) Bei einigen Fehlern können mehrere Aktionen mögliche Lösungen sein, aber das Feld „Aktion“ zeigt die Aktion mit der höchsten Wahrscheinlichkeit an, den Fehler zu beheben.

Status enhanced-error-codes-representation-status

Erweiterte Fehler-Codes enthalten ein Feld „Status“, das den mit dem Fehler verknüpften HTTP-Status-Code angibt.

Zu den möglichen Werten für das Feld „Status“ gehören:

Erweiterte Fehler-Codes mit einem 4xx „Status“ erscheinen in der Regel, wenn der Fehler vom Client erzeugt wird und in den meisten Fällen bedeutet dies, dass der Client zusätzliche Arbeit benötigt, um ihn zu beheben.

Erweiterte Fehler-Codes mit einem 5xx „Status“ erscheinen normalerweise, wenn der Fehler vom Server erzeugt wird, und in den meisten Fällen bedeutet dies, dass der Server zusätzliche Arbeit benötigt, um ihn zu beheben.

Code enhanced-error-codes-representation-code

Erweiterte Fehler-Codes enthalten ein Feld „Code“, das eine eindeutige Kennung für die Adobe Pass-Authentifizierung bereitstellt, die mit dem Fehler verknüpft ist.

Die möglichen Werte für das Feld „Code“ werden ( unten)zwei Listen aggregiert, die auf der integrierten Adobe Pass-Authentifizierungs-API basieren.

Listen enhanced-error-codes-lists

REST API v2 enhanced-error-codes-lists-rest-api-v2

In der folgenden Tabelle sind mögliche erweiterte Fehler-Codes aufgeführt, auf die eine Client-Anwendung stoßen kann, wenn sie in die Adobe Pass Authentication REST API v2 integriert ist.

(Legacy) REST-API v1 enhanced-error-codes-lists-rest-api-v1

In der folgenden Tabelle sind mögliche erweiterte Fehler-Codes aufgeführt, auf die eine Client-Anwendung stoßen kann, wenn sie in die Adobe Pass Authentication REST API v1 integriert ist.

(Ältere) SDKs autorisieren die API vorab enhanced-error-codes-lists-sdks-preauthorize-api

Im vorherigen finden Siemöglichen erweiterten Fehler-Codes, auf die eine Client-Anwendung stoßen könnte, wenn sie mit Adobe Pass Authentication SDKs integriert wird, die die API vorautorisieren.

Umgang mit Antworten enhanced-error-codes-response-handling

Zusammenfassend sollten Sie beim Umgang mit Antworten mit erweiterten Fehler-Codes Folgendes beachten: