DokumentationJourney OptimizerHandbuch für Journey Optimizer

Konfigurieren der OAuth 2.0-Authentifizierung custom-channel-oauth2

Letzte Aktualisierung: 13. Oktober 2026

Erstellt für:

  • Experienced
  • Admin

Auf dieser Seite Erfahren Sie, wie Sie die OAuth 2.0-Authentifizierung für benutzerdefinierte Kanäle in Adobe Journey Optimizer konfigurieren, einschließlich der Payload der Token-Anfrage, der Anmeldedatenpfade, der Token-Extraktion und des Token-Speicherorts in Versandanfragen.

style
shade-box

Wenn Sie OAuth 2.0 als Authentifizierungstyp beim Erstellen eines benutzerdefinierten Kanals auswählen, konfigurieren Sie die Token-Anforderung, die Adobe Journey Optimizer verwendet, um ein Zugriffs-Token von Ihrem Autorisierungsserver abzurufen.

Journey Optimizer sendet die Token-Anfrage mit der endpoint-, method-, request- und policy. Anschließend extrahiert er das Zugriffs-Token mithilfe von tokenPath aus der Antwort und fügt es mithilfe von locationConfig zur Versandanfrage hinzu.

Die OAuth 2.0-Authentifizierungs-Payload konfiguriert die Anfrage an den Token-Endpunkt. Sie ist getrennt von der Nachrichten-Payload die an Ihren benutzerdefinierten Kanalversand-Endpunkt gesendet wird.

Konfigurieren der Token-Anfrage token-request

Verwenden Sie die folgenden Beispiele, um Ihre Token-Anfrage zu konfigurieren. Ersetzen Sie den Beispielendpunkt und die Werte der Anmeldeinformationen durch die von Ihrem Autorisierungs-Server erforderlichen Werte. Die headers- und queryParams-Einträge in den Beispielen sind optional: Entfernen Sie sie, wenn Ihr Token-Endpunkt sie nicht benötigt, und entfernen Sie die entsprechenden Einträge aus credentialPaths.

Beispiel für einen Formularhauptteil form-body-example

Verwenden Sie eine form Payload, wenn der Token-Endpunkt Formularfelder wie grant_type, client_id oder client_secret erwartet.

{
  "type": "oauth2",
  "endpoint": {
    "uri": "https://auth.example.com/oauth/token"
  },
  "method": "post",
  "request": {
    "headers": [
      {
        "key": "sampleHeaderKey",
        "value": "sampleHeaderValue"
      }
    ],
    "queryParams": [
      {
        "key": "sampleQueryParamKey",
        "value": "sampleQueryParamValue"
      }
    ],
    "payload": {
      "type": "form",
      "content": [
        {
          "key": "grant_type",
          "value": "client_credentials"
        },
        {
          "key": "client_id",
          "value": "your-client-id"
        },
        {
          "key": "client_secret",
          "value": "your-client-secret"
        }
      ],
      "includeNullValues": false
    }
  },
  "response": {
    "type": "json"
  },
  "policy": {
    "timeoutInMilliseconds": 30000,
    "cache": {
      "enabled": true,
      "ttlInSeconds": 300
    },
    "retry": {
      "enabled": false,
      "maxRetryCount": 3
    }
  },
  "credentialPaths": [
    "header.sampleHeaderKey",
    "queryParam.sampleQueryParamKey",
    "payload.client_id",
    "payload.client_secret"
  ],
  "tokenPath": "access_token",
  "locationConfig": {
    "key": "Authorization",
    "location": "header"
  }
}

Für eine form Payload verwendet jeder Pfad für die Berechtigung den Formularfeldschlüssel, z. B. payload.client_secret. Schließen Sie keine content- oder Array-Indizes in den Pfad der Berechtigung ein.

JSON-Textbeispiel json-body-example

Verwenden Sie eine json Payload, wenn der Token-Endpunkt einen JSON-Anfragetext erwartet.

{
  "type": "oauth2",
  "endpoint": {
    "uri": "https://auth.example.com/oauth/token"
  },
  "method": "post",
  "request": {
    "headers": [
      {
        "key": "sampleHeaderKey",
        "value": "sampleHeaderValue"
      }
    ],
    "queryParams": [
      {
        "key": "sampleQueryParamKey",
        "value": "sampleQueryParamValue"
      }
    ],
    "payload": {
      "type": "json",
      "content": {
        "grant_type": "client_credentials",
        "client_id": "your-client-id",
        "client_secret": "your-client-secret"
      },
      "includeNullValues": false
    }
  },
  "response": {
    "type": "json"
  },
  "policy": {
    "timeoutInMilliseconds": 30000,
    "cache": {
      "enabled": true,
      "ttlInSeconds": 300
    },
    "retry": {
      "enabled": false,
      "maxRetryCount": 3
    }
  },
  "credentialPaths": [
    "header.sampleHeaderKey",
    "queryParam.sampleQueryParamKey",
    "payload.client_id",
    "payload.client_secret"
  ],
  "tokenPath": "access_token",
  "locationConfig": {
    "key": "Authorization",
    "location": "header"
  }
}

OAuth 2.0-Felder oauth2-fields

Feld
Beschreibung
type
Muss oauth2sein.
endpoint.uri
HTTPS-URL des OAuth 2.0-Token-Endpunkts.
method
Zum Aufrufen des Token-Endpunkts verwendete HTTP-Methode. Verwenden Sie post für Token-Anfragen.
request.headers
Optionale Kopfzeilen, die an den Token-Endpunkt gesendet werden.
request.queryParams
Optionale Abfrageparameter, die an die Token-Endpunkt-URL angehängt werden.
request.payload
Textkörper der Token-Anfrage. Unterstützt form und json Payloads.
request.payload.includeNullValues
Definiert, ob Felder mit einem Nullwert im Textkörper der Token-Anfrage enthalten sind.
response.type
Antwortformat. Verwenden Sie json, wenn der Token-Endpunkt eine JSON-Antwort zurückgibt.
policy.timeoutInMilliseconds
Maximale Wartezeit auf die Token-Endpunktantwort.
policy.cache
Definiert, ob und für wie lange das OAuth-Token zwischengespeichert wird.
policy.retry
Optionale Konfiguration für erneute Versuche bei Token-Endpunktfehlern.
credentialPaths
Pfade zu Anfragefeldern mit Anmeldeinformationen. Diese Felder werden als Anmeldeinformationen behandelt und können sicher verwaltet werden.
tokenPath
Durch Punkte getrennter Pfad zum Zugriffstoken in der OAuth-Antwort, z. B. access_token oder data.access_token.
locationConfig
Definiert, wo das abgerufene Token zur Versandanfrage hinzugefügt wird.
locationConfig.key
Name der Kopfzeile oder des Abfrageparameters, die bzw. der das Token enthält, z. B. Authorization.
locationConfig.location
Wobei das Token hinzugefügt wird: header oder queryParam.

Wenn die Token-Zwischenspeicherung aktiviert ist, verwendet Journey Optimizer das OAuth-Token für die konfigurierte Cache-Dauer erneut, anstatt für jede Versandanfrage den Token-Endpunkt aufzurufen.

Identifizieren von Berechtigungsfeldern credential-paths

Verwenden Sie credentialPaths, um zu ermitteln, welche Anfragefelder Anmeldeinformationen enthalten. Wenn eine Kopfzeile oder ein Abfrageparameter eine Berechtigung enthält, geben Sie im Anfragetext deren Pfad sowie etwaige Berechtigungspfade an. Die obigen Beispiele identifizieren die Beispielkopfzeilen- und Abfrageparameterwerte als Anmeldeinformationen. Passen Sie diese Liste an Ihre Anfrage an.

Präfix
Verwendet für
Beispiel
header.
In Anfragekopfzeilen übergebene Anmeldedaten.
header.sampleHeaderKey
queryParam.
In Abfrageparametern übergebene Anmeldedaten.
queryParam.sampleQueryParamKey
payload.
Im Anfragetext übergebene Anmeldedaten.
payload.client_secret

Wenden Sie die folgenden Regeln an:

  • Pfade müssen mit header, queryParam oder payload beginnen und Punkte als Trennzeichen verwenden.
  • Verwenden Sie für form Payloads payload.<formFieldKey>.
  • Verwenden Sie für json Payloads den JSON-Objektpfad, z. B. payload.client_id oder payload.credentials.client_secret. Fügen Sie keine content in den Pfad ein.
  • Leere Pfadsegmente werden nicht unterstützt. Beispielsweise ist payload..client_id ungültig.

Verwenden Sie für einen verschachtelten JSON-Text die Punktnotation, wie in diesem Konfigurationsauszug gezeigt:

{
  "request": {
    "payload": {
      "type": "json",
      "content": {
        "credentials": {
          "client_id": "your-client-id",
          "client_secret": "your-client-secret"
        }
      },
      "includeNullValues": false
    }
  },
  "credentialPaths": [
    "payload.credentials.client_id",
    "payload.credentials.client_secret"
  ]
}

Extrahieren des Zugriffstokens token-path

tokenPath definiert, wo sich das Zugriffstoken in der OAuth 2.0-Token-Antwort befindet.

Legen Sie für die folgende Antwort tokenPath auf access_token fest:

{
  "access_token": "example-access-token",
  "token_type": "Bearer",
  "expires_in": 3600
}

Legen Sie für eine verschachtelte Antwort tokenPath auf data.access_token fest:

{
  "data": {
    "access_token": "example-access-token"
  }
}

Token zu Versandanfragen hinzufügen token-location

locationConfig definiert, wo Journey Optimizer das abgerufene Token hinzufügt, wenn der benutzerdefinierte Kanalbereitstellungs-Endpunkt aufgerufen wird.

Um das Token in der Authorization-Kopfzeile zu senden, verwenden Sie:

{
  "locationConfig": {
    "key": "Authorization",
    "location": "header"
  }
}
Standort
Beschreibung
header
Fügt das Token als HTTP-Kopfzeile hinzu.
queryParam
Fügt das Token als Abfrageparameter hinzu.

Beschränkungen und Validierungsregeln limits

Feld
Limit
endpoint.uri
Muss eine absolute HTTPS-URL mit einem nicht leeren Host sein. Maximale Länge: 2048 Zeichen.
policy.timeoutInMilliseconds
Minimum: 300 ms. Maximal: 60000 ms.
policy.cache.ttlInSeconds
Trifft zu, wenn der Cache aktiviert ist. Minimum: 300 Sekunden. Maximal: 3600 Sekunden.
request.headers
Maximal 50 Kopfzeilen. Länge des Kopfzeilenschlüssels: 1-100 Zeichen. Maximaler Kopfzeilenwert: 8192 Zeichen.
request.queryParams
Maximal 50 Abfrageparameter. Länge des Abfrageparameter-Schlüssels: 1-100 Zeichen. Maximaler Abfrageparameterwert: 8192 Zeichen.
request.payload.type=form
Maximal 50 Formularfelder. Länge des Formularschlüssels: 1-100 Zeichen. Doppelte Formularschlüssel sind nicht zulässig.
Werte der Berechtigung
1-1024 Zeichen.
tokenPath
Muss ein gültiger punktgetrennter Pfad sein. Ein leerer Wert ist nur zulässig, wenn die gesamte Antwort das Token ist.
credentialPaths
Muss mit header, queryParam oder payload beginnen und Punkte als Trennzeichen verwenden.

Nächste Schritte next-steps

AI Knowledge Reference

This section contains structured knowledge intended to support interpretation, retrieval, and question answering related to this topic.

For complete understanding, this information should be combined with the documentation on this page. Neither source is intended to stand alone; the page describes the feature, while this section provides additional context that helps disambiguate terminology, intent, applicability, and constraints.

  • TL;DR: Configure OAuth 2.0 authentication for a custom channel by defining the token endpoint request, identifying credential fields, extracting the access token from the response, and specifying where to add it to delivery requests.

Intents:

  • Configure OAuth 2.0 authentication when creating a custom channel or managing API credentials
  • Choose a form or JSON body for the token endpoint request
  • Identify credential fields in headers, query parameters, and request bodies
  • Extract an access token from a top-level or nested response field
  • Add the retrieved token to a delivery request header or query parameter
  • Understand token caching and authentication configuration limits

Glossary:

  • Token endpoint: The authorization server endpoint that Journey Optimizer calls to retrieve an access token
  • Authentication payload: The configuration of the OAuth 2.0 token request, separate from the message payload sent to the delivery endpoint (product-specific)
  • Credential paths: The paths identifying request fields that contain credentials, configured through credentialPaths (product-specific)
  • Token path: The dot-separated path to the access token in the token endpoint response, configured through tokenPath (product-specific)
  • Token location configuration: The delivery request header or query parameter to which the retrieved token is added, configured through locationConfig (product-specific)

Guardrails:

  • Set the authentication configuration type to oauth2 and use post for token requests.
  • The token endpoint must be an absolute HTTPS URL with a non-empty host and a maximum length of 2048 characters.
  • Token request bodies support form and json payloads; choose the format expected by your authorization server.
  • Credential paths must start with header, queryParam, or payload, use dots as separators, and contain no empty path segments.
  • Form credential paths use the form field key. JSON credential paths use the JSON object path. Do not include content or form array indexes in credential paths.
  • Supported token locations are header and queryParam.
  • The token endpoint timeout must be between 300 and 60000 milliseconds.
  • When token caching is enabled, the cache duration must be between 300 and 3600 seconds. Journey Optimizer reuses the token for the configured duration instead of retrieving a token for every delivery request.
  • Credential values must contain between 1 and 1024 characters.
  • An empty tokenPath is allowed only when the entire response is the token.

Terminology:

  • Canonical name: OAuth 2.0 authentication - variants: OAuth 2.0 authentication payload, OAuth token request configuration
  • Do not confuse: “authentication payload” (configuration for retrieving an access token) with “message payload” (content sent to the custom channel delivery endpoint)
  • Do not confuse: credentialPaths (credential fields in the token request) with tokenPath (access token field in the token response)
  • Do not confuse: request.headers and request.queryParams (values sent to the token endpoint) with locationConfig (where the retrieved token is added to delivery requests)

FAQ:

  • Q: When should I use a form or JSON payload? - Use form when the token endpoint expects form fields, and json when it expects a JSON request body.
  • Q: How do I identify a client secret in a form body? - Use the form field key, for example, payload.client_secret, without content or an array index.
  • Q: How do I identify credentials in a nested JSON body? - Use dot notation, for example, payload.credentials.client_secret.
  • Q: How do I extract a token from a nested response? - Set tokenPath to the response field path, for example, data.access_token.
  • Q: Where can Journey Optimizer add the token to delivery requests? - Set locationConfig.location to header or queryParam and locationConfig.key to the header or query parameter name.
  • Q: Does Journey Optimizer retrieve a token for every delivery request? - When caching is enabled, it reuses the token for the configured cache duration.
recommendation-more-help
journey-optimizer-help