DokumentationAdobe PassAdobe Pass-Authentifizierung

Abrufen von Client-Anmeldeinformationen retrieve-client-credentials

Last update: Fri Dec 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
IMPORTANT
Der Inhalt dieser Seite dient nur zu Informationszwecken. Die Verwendung dieser API erfordert eine aktuelle Lizenz von Adobe. Eine unbefugte Nutzung ist nicht zulässig.
IMPORTANT
Die Implementierung der dynamischen Client-Registrierungs-API ist an die Dokumentation Drosselungsmechanismus gebunden.

Anfrage request

HTTP
Pfad
/o/client/register
Methode
POST
Hauptteilparameter
software_statement
Die mit der registrierten Anwendung verknüpfte Softwareanweisung, die vom Adobe Pass TVE Dashboard erstellt und heruntergeladen wurde.

Die Verwaltung registrierter Anwendungen wird in der Dokumentation Übersicht über die Dynamic Client-Registrierung beschrieben.
required
redirect_uri
Der Umleitungs-URI, der mit dem Speicherort verknüpft ist, zu dem der Benutzeragent navigiert, wenn der Authentifizierungsfluss abgeschlossen ist.
fakultativ
Kopfzeilen
content-type
Der akzeptierte Medientyp für die gesendeten Ressourcen.

Es muss application/json sein.
required
x-device-info
Die Erzeugung der Payload mit Geräteinformationen wird in der Dokumentation X-Device-Info beschrieben.

Es wird dringend empfohlen, sie immer dann zu verwenden, wenn die Geräteplattform der Anwendung die explizite Bereitstellung gültiger Werte zulässt.

Wenn angegeben, führt das Backend für die Adobe Pass-Authentifizierung explizit eingestellte Werte mit extrahierten Werten implizit zusammen (standardmäßig).

Wenn keine Angabe gemacht wird, verwendet das Backend für die Adobe Pass-Authentifizierung implizit die extrahierten Werte (standardmäßig).
required
Akzeptieren
Der von der Client-Anwendung akzeptierte Medientyp.

Wenn angegeben, muss es application/json sein.
fakultativ
user-agent
Der Benutzeragent der Client-Anwendung.
fakultativ

Antwort response

Erfolg success

Kopfzeilen
Status
201
required
content-type
application/json
required
Textkörper

JSON-Objekt mit den folgenden Attributen:

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-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 layout-auto html-authored
Attribut
client_id Die Zeichenfolge der Client-Anwendungskennung. required
client_secret Die geheime Zeichenfolge des Client-Programms. required
client_id_issued_at Der Zeitpunkt, zu dem die Client-Anwendungskennung ausgegeben wurde. required
redirect_uris Das Array von Umleitungs-URI-Zeichenfolgen, das die Client-Anwendung in umleitungsbasierten Flüssen verwenden kann. required
grant_types Die Zeichenfolgen vom Typ „grant“, die die Client-Anwendung für den Client-Token-Endpunkt verwenden kann. required
Bereiche Die Bereichszeichenfolgen, die die Adobe Pass-Authentifizierungs-APIs definieren, die die Client-Anwendung verwenden kann. required
required

Fehler error

Kopfzeilen
Status
400
required
content-type
application/json
required
Textkörper
Fehler

Die möglichen Werte sind:

table 0-row-3 1-row-2 2-row-2 3-row-2 4-row-2 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff 8-bgcolor-deebff 11-bgcolor-deebff 14-bgcolor-deebff layout-auto html-authored
Wert
Invalid_request

Die Anfrage ist aus einem der folgenden Gründe ungültig:

  • In der Anfrage fehlt ein erforderlicher Parameter.
  • Die Anfrage enthält einen nicht unterstützten Parameterwert.
  • Die Anfrage wiederholt einen Parameter.
  • Die Anfrage ist fehlerhaft.
invalid_redirect_uri Die Anfrage enthält einen ungültigen Wert für den Umleitungs-URI.
invalid_software_statement Die Anfrage enthält einen Wert für die Software-Anweisung, der ungültig ist.
unauthorized_software_statement Die Anfrage enthält einen -Wert für die Softwareanweisung, der nicht für die Verwendung durch den Adobe Pass-Authentifizierungsserver genehmigt ist.
required

Beispiele samples

Abrufen von Client-Anmeldeinformationen samples-retrieve-client-credentials

Anfrage
code language-https 
POST /o/client/register HTTP/1.1

    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Content-Type: application/json
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)

{
    "software_statement": "eyJhbGciOiJSUzI1NiJ9.
        eyJzb2Z0d2FyZV9pZCI6IjROUkIxLTBYWkFCWkk5RTYtNVNNM1IiLCJjbGll
        bnRfbmFtZSI6IkV4YW1wbGUgU3RhdGVtZW50LWJhc2VkIENsaWVudCIsImNs
        aWVudF91cmkiOiJodHRwczovL2NsaWVudC5leGFtcGxlLm5ldC8ifQ.
        GHfL4QNIrQwL18BSRdE595T9jbzqa06R9BT8w409x9oIcKaZo_mt15riEXHa
        zdISUvDIZhtiyNrSHQ8K4TvqWxH6uJgcmoodZdPwmWRIEYbQDLqPNxREtYn0
        5X3AR7ia4FRjQ2ojZjk5fJqJdQ-JcfxyhK-P8BAWBd6I2LLA77IG32xtbhxY
        fHX7VhuU5ProJO8uvu3Ayv4XRhLZJY4yKfmyjiiKiPNe-Ia4SMy_d_QSWxsk
        U5XIQl5Sa2YRPMbDRXttm2TfnZM1xx70DoYi8g6czz-CPGRi4SW_S2RKHIJf
        IjoI3zTJ0Y2oe0_EJAiXbL6OyF9S5tKxDXV8JIndSA",
    "redirect_uri": "adobepass://com.programmer"
 }
Antwort - Erfolg
code language-https 
HTTP/1.1 201 Created

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

{
    "client_id": "s6BhdRkqt3",
    "client_secret": "t7AkePiru4",
    "redirect_uris": [
        "app://com.programmer.adobe#sdasdsadas"
    ],
    "grant_types": [
        "client_credentials"
    ],
    "scopes": [
        "api:client:v2"
    ],
    "client_id_issued_at": 1723227212
}
Antwort - Fehler
code language-https 
HTTP/1.1 400 Bad Request

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

{ "error": "invalid_request" }
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b