DQE One API — Authentifizierung & Sitzung

Authentifizierung & Sitzung - DQE One API

Diese drei Endpunkte stellen die Anmeldedaten aus und verwalten sie, mit denen das DQE One-Paket für Salesforce den Rest der One API aufruft: ein kurzlebiges Prozess-Token, einen Organisations-/Benutzer-Abonnement-Ablauf (Onboarding) und ein Sitzungs-Token für die Custom-UI des Pakets.

Verwandte Dokumentation:

DQE One API — Einführung (Überblick über das Authentifizierungsmodell, Verfügbarkeitsprüfung)

Direkt zu getOAuthTokenForProcess subscribe createTokenSession

Prozess-Token - DQE One API

Stellt ein kurzlebiges Token aus, mit dem ein bestimmter, vom Salesforce-Paket initiierter Backend-Prozess authentifiziert wird.

getOAuthTokenForProcess

Direkt zu Parameter Antwort Beispiel Fehler ▶ API testen

Anfrage

Senden Sie an diesen Endpunkt einen JSON-Body mit gesetztem DQE-Authorization-Header.

{DOMAIN} ist die Domain des Servers, auf dem die eigene Instanz des DQE One-Backends Ihrer Organisation installiert ist — da dieses Backend in Ihrer eigenen Infrastruktur läuft, wird dieser Wert durch Ihre Bereitstellung festgelegt und nicht von DQE vergeben. {DQE_AUTHORIZATION_KEY} wird von DQE bei der Konto-/Paketeinrichtung bereitgestellt; wenden Sie sich an Ihren DQE-Kundenbetreuer, um ihn zu erhalten.

POSThttps://{DOMAIN}/getOAuthTokenForProcess

Codebeispiele

Ein Prozess-Token anfordern

cURL JavaScript Python PHP Node.js Java C# Go

curl -X POST "https://{DOMAIN}/getOAuthTokenForProcess" \
  -H "DQE-Authorization: {DQE_AUTHORIZATION_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
  "orgId": "00D5e0000008abcEAA",
  "crt": "2026-10-28T10:15:00Z",
  "sub": "0055e00000AbCnoFAF",
  "aud": "dqe-unify-api",
  "urllogin": "https://login.salesforce.com"
}'

fetch("https://{DOMAIN}/getOAuthTokenForProcess", {
  method: "POST",
  headers: {
    "DQE-Authorization": "{DQE_AUTHORIZATION_KEY}",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    orgId: "00D5e0000008abcEAA",
    crt: "2026-10-28T10:15:00Z",
    sub: "0055e00000AbCnoFAF",
    aud: "dqe-unify-api",
    urllogin: "https://login.salesforce.com"
  })
})
  .then(r => r.json())
  .then(data => console.log(data));

import requests

response = requests.post(
    "https://{DOMAIN}/getOAuthTokenForProcess",
    headers={
        "DQE-Authorization": "{DQE_AUTHORIZATION_KEY}",
    },
    json={
        "orgId": "00D5e0000008abcEAA",
        "crt": "2026-10-28T10:15:00Z",
        "sub": "0055e00000AbCnoFAF",
        "aud": "dqe-unify-api",
        "urllogin": "https://login.salesforce.com",
    },
)
print(response.json())

<?php
$data = [
    'orgId' => '00D5e0000008abcEAA',
    'crt' => '2026-10-28T10:15:00Z',
    'sub' => '0055e00000AbCnoFAF',
    'aud' => 'dqe-unify-api',
    'urllogin' => 'https://login.salesforce.com',
];

$ch = curl_init("https://{DOMAIN}/getOAuthTokenForProcess");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'DQE-Authorization: {DQE_AUTHORIZATION_KEY}',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);

const axios = require('axios');

axios.post('https://{DOMAIN}/getOAuthTokenForProcess', {
  orgId: '00D5e0000008abcEAA',
  crt: '2026-10-28T10:15:00Z',
  sub: '0055e00000AbCnoFAF',
  aud: 'dqe-unify-api',
  urllogin: 'https://login.salesforce.com'
}, {
  headers: {
    'DQE-Authorization': '{DQE_AUTHORIZATION_KEY}',
    'Content-Type': 'application/json'
  }
})
  .then(response => console.log(response.data));

HttpClient client = HttpClient.newHttpClient();

String body = "{\"orgId\":\"00D5e0000008abcEAA\",\"crt\":\"2026-10-28T10:15:00Z\",\"sub\":\"0055e00000AbCnoFAF\",\"aud\":\"dqe-unify-api\",\"urllogin\":\"https://login.salesforce.com\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://{DOMAIN}/getOAuthTokenForProcess"))
    .header("DQE-Authorization", "{DQE_AUTHORIZATION_KEY}")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

using var client = new HttpClient();

var json = "{\"orgId\":\"00D5e0000008abcEAA\",\"crt\":\"2026-10-28T10:15:00Z\",\"sub\":\"0055e00000AbCnoFAF\",\"aud\":\"dqe-unify-api\",\"urllogin\":\"https://login.salesforce.com\"}";
var content = new StringContent(json, Encoding.UTF8, "application/json");

using var request = new HttpRequestMessage(HttpMethod.Post, "https://{DOMAIN}/getOAuthTokenForProcess");
request.Headers.Add("DQE-Authorization", "{DQE_AUTHORIZATION_KEY}");
request.Content = content;

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

func main() {
    body := []byte(`{"orgId":"00D5e0000008abcEAA","crt":"2026-10-28T10:15:00Z","sub":"0055e00000AbCnoFAF","aud":"dqe-unify-api","urllogin":"https://login.salesforce.com"}`)

    req, _ := http.NewRequest("POST", "https://{DOMAIN}/getOAuthTokenForProcess", bytes.NewBuffer(body))
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("DQE-Authorization", "{DQE_AUTHORIZATION_KEY}")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    respBody, _ := io.ReadAll(resp.Body)
    fmt.Println(string(respBody))
}

Parameter

Alle Felder werden als ein einzelner JSON-Request-Body gesendet.

Hinweis zu Pflicht/Optional: Die Quell-OpenAPI-Spezifikation deklariert für diesen Request-Body kein required-Array (nur der Body als Ganzes ist als erforderlich markiert). Alle unten stehenden Felder werden gemäß der Dokumentationskonvention dieses Projekts als Pflicht angezeigt, da jedes von ihnen eine definierte Rolle im Token-Ausstellungsablauf spielt — die tatsächliche Optionalität vor der Veröffentlichung mit dem DQE-Engineering-Team bestätigen.

Feld	Beschreibung	Typ	Pflicht/Opt.
orgId	Die Salesforce-Organisations-ID, die die Anfrage stellt.	String	Pflicht
crt	Der Erstellungs-/Ausstellungszeitstempel-Claim für diese signierte Anfrage.	String	Pflicht
sub	Der Subject-Claim — die Salesforce-Benutzer- oder Sitzungs-ID, die die Anfrage ausstellt.	String	Pflicht
aud	Der Audience-Claim — der vorgesehene Empfänger-/Zieldienst für diese signierte Anfrage.	String	Pflicht
urllogin	Die Login-URL der Salesforce-Organisation.	String	Pflicht

Antwort

Gibt ein JSON-Objekt zurück, das das Prozess-Token enthält.

Schlüssel	Beschreibung	Typ
Token	Das generierte Token, mit dem der nachfolgende Prozessaufruf authentifiziert wird.	String

Antwortbeispiel

Beispiel einer Token-Antwort

{
  "Token": "token"
}

Der einzige Beispielwert der Quellspezifikation für Token ist die wörtliche Platzhalter-Zeichenfolge "token" — oben unverändert dargestellt, statt durch einen erfunden wirkenden Wert ersetzt.

Fehler

Die Quellspezifikation definiert für diesen Endpunkt keine Fehlerantworten (4xx/5xx) — nur die Erfolgsantwort 200 ist dokumentiert. Das tatsächliche Fehlerverhalten vor der Veröffentlichung mit dem DQE-Engineering-Team bestätigen.

API testen

Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.

Konsole öffnen

Abonnement - DQE One API

Registriert eine Salesforce-Organisation oder einen Benutzer und gibt die für nachfolgende authentifizierte Aufrufe benötigten Anmeldedaten zurück. Dies wirkt eher wie ein Organisations-Onboarding-/Registrierungsablauf als wie ein Authentifizierungsschritt pro Aufruf.

Direkt zu Parameter Antwort Beispiel Fehler ▶ API testen

Anfrage

Senden Sie an diesen Endpunkt einen JSON-Body. Es ist kein Authentifizierungs-Header erforderlich — die Quellspezifikation deklariert für diesen Pfad eine leere Sicherheitsanforderung.

POSThttps://{DOMAIN}/subscribe

Codebeispiele

Eine Organisation registrieren und Anmeldedaten erhalten

cURL JavaScript Python PHP Node.js Java C# Go

curl -X POST "https://{DOMAIN}/subscribe" \
  -H "Content-Type: application/json" \
  -d '{
  "orgId": "00D5e0000008abcEAA",
  "groupId": "GRP-00123",
  "licence": "123456",
  "region": "EU",
  "key": "a1b2c3d4e5f6"
}'

fetch("https://{DOMAIN}/subscribe", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    orgId: "00D5e0000008abcEAA",
    groupId: "GRP-00123",
    licence: "123456",
    region: "EU",
    key: "a1b2c3d4e5f6"
  })
})
  .then(r => r.json())
  .then(data => console.log(data));

import requests

response = requests.post(
    "https://{DOMAIN}/subscribe",
    json={
        "orgId": "00D5e0000008abcEAA",
        "groupId": "GRP-00123",
        "licence": "123456",
        "region": "EU",
        "key": "a1b2c3d4e5f6",
    },
)
print(response.json())

<?php
$data = [
    'orgId' => '00D5e0000008abcEAA',
    'groupId' => 'GRP-00123',
    'licence' => '123456',
    'region' => 'EU',
    'key' => 'a1b2c3d4e5f6',
];

$ch = curl_init("https://{DOMAIN}/subscribe");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);

const axios = require('axios');

axios.post('https://{DOMAIN}/subscribe', {
  orgId: '00D5e0000008abcEAA',
  groupId: 'GRP-00123',
  licence: '123456',
  region: 'EU',
  key: 'a1b2c3d4e5f6'
})
  .then(response => console.log(response.data));

HttpClient client = HttpClient.newHttpClient();

String body = "{\"orgId\":\"00D5e0000008abcEAA\",\"groupId\":\"GRP-00123\",\"licence\":\"123456\",\"region\":\"EU\",\"key\":\"a1b2c3d4e5f6\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://{DOMAIN}/subscribe"))
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

using var client = new HttpClient();

var json = "{\"orgId\":\"00D5e0000008abcEAA\",\"groupId\":\"GRP-00123\",\"licence\":\"123456\",\"region\":\"EU\",\"key\":\"a1b2c3d4e5f6\"}";
var content = new StringContent(json, Encoding.UTF8, "application/json");

var response = await client.PostAsync("https://{DOMAIN}/subscribe", content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

func main() {
    body := []byte(`{"orgId":"00D5e0000008abcEAA","groupId":"GRP-00123","licence":"123456","region":"EU","key":"a1b2c3d4e5f6"}`)

    req, _ := http.NewRequest("POST", "https://{DOMAIN}/subscribe", bytes.NewBuffer(body))
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    respBody, _ := io.ReadAll(resp.Body)
    fmt.Println(string(respBody))
}

Parameter

Alle Felder werden als ein einzelner JSON-Request-Body gesendet.

Hinweis zu Pflicht/Optional: Die Quell-OpenAPI-Spezifikation deklariert für diesen Request-Body kein required-Array (nur der Body als Ganzes ist als erforderlich markiert). Alle unten stehenden Felder werden gemäß der Dokumentationskonvention dieses Projekts als Pflicht angezeigt — die tatsächliche Optionalität vor der Veröffentlichung mit dem DQE-Engineering-Team bestätigen.

Feld	Beschreibung	Typ	Pflicht/Opt.
orgId	Die zu registrierende Salesforce-Organisations-ID.	String	Pflicht
groupId	Kennung der Lizenzgruppe/Paketinstanz, unter der diese Organisation abonniert wird.	String	Pflicht
licence	Der mit diesem Abonnement verknüpfte DQE-Lizenzcode.	String	Pflicht
region	Die Region oder das Rechenzentrum, in dem die DQE-Instanz dieser Organisation bereitgestellt werden soll.	String	Pflicht
key	Ein Aktivierungs- oder Abonnementschlüssel zur Validierung der Registrierungsanfrage. Nur aus dem Feldnamen abgeleitet — der genaue Zweck ist in der Quellspezifikation nicht dokumentiert.	String	Pflicht

Antwort

Gibt ein JSON-Objekt zurück, das die für dieses Abonnement ausgestellten Anmeldedaten enthält.

Schlüssel	Beschreibung	Typ
pwd	Das Passwort, das als Teil der von dieser Registrierung zurückgegebenen neuen Anmeldedaten ausgestellt wird.	String
iss	Die der neu registrierten Organisation/dem Benutzer zugewiesene Aussteller-ID — Teil der Anmeldedaten für nachfolgende authentifizierte Aufrufe.	String
issSecret	Das mit der Aussteller-ID verknüpfte Geheimnis. Sicher aufbewahren; es autorisiert nachfolgende Aufrufe.	String
crt	Der Erstellungs-/Ausstellungszeitstempel dieser Anmeldedaten.	String
groupId	Die für dieses Abonnement bestätigte Gruppen-ID (entspricht dem Anfragewert).	String

Antwortbeispiel

Beispiel einer Abonnement-Antwort

{
  "pwd": "a8f3c9d21b47e6f0",
  "iss": "UNIFY-00123",
  "issSecret": "9f86d081884c7d659a2feaa0c55ad015",
  "crt": "2026-10-28T10:15:00Z",
  "groupId": "GRP-00123"
}

Die Quellspezifikation gibt für dieses Schema keine example-Werte an. Die obigen Werte sind lediglich veranschaulichende Platzhalter — es ist kein bestimmtes Format oder keine bestimmte Länge dokumentiert.

Fehler

API testen

Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.

Konsole öffnen

Custom-UI-Sitzung - DQE One API

Erstellt ein Sitzungs-Token für die eingebettete Custom-UI des DQE One-Pakets, begrenzt auf eine bestimmte Salesforce-Sitzung und einen bestimmten Benutzer.

customUI/createTokenSession

Direkt zu Parameter Antwort Beispiel Fehler ▶ API testen

Anfrage

Senden Sie an diesen Endpunkt einen JSON-Body mit gesetztem DQE-Authorization-Header.

POSThttps://{DOMAIN}/customUI/createTokenSession

Codebeispiele

Ein Custom-UI-Sitzungs-Token erstellen

cURL JavaScript Python PHP Node.js Java C# Go

curl -X POST "https://{DOMAIN}/customUI/createTokenSession" \
  -H "DQE-Authorization: {DQE_AUTHORIZATION_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
  "orgId": "00D5e0000008abcEAA",
  "aud": "dqe-unify-api",
  "urllogin": "https://login.salesforce.com",
  "sub": "0055e00000AbCnoFAF",
  "name": "Jane Doe",
  "sessionId": "00D5e0000008abcEAA!AQEAQJ3x9fKZ",
  "licence": "123456",
  "region": "EU",
  "isPersonAccountEnable": false,
  "chatterId": "0D55e00000ABCDEFG",
  "setTokenToUi": true
}'

fetch("https://{DOMAIN}/customUI/createTokenSession", {
  method: "POST",
  headers: {
    "DQE-Authorization": "{DQE_AUTHORIZATION_KEY}",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    orgId: "00D5e0000008abcEAA",
    aud: "dqe-unify-api",
    urllogin: "https://login.salesforce.com",
    sub: "0055e00000AbCnoFAF",
    name: "Jane Doe",
    sessionId: "00D5e0000008abcEAA!AQEAQJ3x9fKZ",
    licence: "123456",
    region: "EU",
    isPersonAccountEnable: false,
    chatterId: "0D55e00000ABCDEFG",
    setTokenToUi: true
  })
})
  .then(r => r.json())
  .then(data => console.log(data));

import requests

response = requests.post(
    "https://{DOMAIN}/customUI/createTokenSession",
    headers={
        "DQE-Authorization": "{DQE_AUTHORIZATION_KEY}",
    },
    json={
        "orgId": "00D5e0000008abcEAA",
        "aud": "dqe-unify-api",
        "urllogin": "https://login.salesforce.com",
        "sub": "0055e00000AbCnoFAF",
        "name": "Jane Doe",
        "sessionId": "00D5e0000008abcEAA!AQEAQJ3x9fKZ",
        "licence": "123456",
        "region": "EU",
        "isPersonAccountEnable": False,
        "chatterId": "0D55e00000ABCDEFG",
        "setTokenToUi": True,
    },
)
print(response.json())

<?php
$data = [
    'orgId' => '00D5e0000008abcEAA',
    'aud' => 'dqe-unify-api',
    'urllogin' => 'https://login.salesforce.com',
    'sub' => '0055e00000AbCnoFAF',
    'name' => 'Jane Doe',
    'sessionId' => '00D5e0000008abcEAA!AQEAQJ3x9fKZ',
    'licence' => '123456',
    'region' => 'EU',
    'isPersonAccountEnable' => false,
    'chatterId' => '0D55e00000ABCDEFG',
    'setTokenToUi' => true,
];

$ch = curl_init("https://{DOMAIN}/customUI/createTokenSession");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'DQE-Authorization: {DQE_AUTHORIZATION_KEY}',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);

const axios = require('axios');

axios.post('https://{DOMAIN}/customUI/createTokenSession', {
  orgId: '00D5e0000008abcEAA',
  aud: 'dqe-unify-api',
  urllogin: 'https://login.salesforce.com',
  sub: '0055e00000AbCnoFAF',
  name: 'Jane Doe',
  sessionId: '00D5e0000008abcEAA!AQEAQJ3x9fKZ',
  licence: '123456',
  region: 'EU',
  isPersonAccountEnable: false,
  chatterId: '0D55e00000ABCDEFG',
  setTokenToUi: true
}, {
  headers: {
    'DQE-Authorization': '{DQE_AUTHORIZATION_KEY}',
    'Content-Type': 'application/json'
  }
})
  .then(response => console.log(response.data));

HttpClient client = HttpClient.newHttpClient();

String body = "{\"orgId\":\"00D5e0000008abcEAA\",\"aud\":\"dqe-unify-api\",\"urllogin\":\"https://login.salesforce.com\",\"sub\":\"0055e00000AbCnoFAF\",\"name\":\"Jane Doe\",\"sessionId\":\"00D5e0000008abcEAA!AQEAQJ3x9fKZ\",\"licence\":\"123456\",\"region\":\"EU\",\"isPersonAccountEnable\":false,\"chatterId\":\"0D55e00000ABCDEFG\",\"setTokenToUi\":true}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://{DOMAIN}/customUI/createTokenSession"))
    .header("DQE-Authorization", "{DQE_AUTHORIZATION_KEY}")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

using var client = new HttpClient();

var json = "{\"orgId\":\"00D5e0000008abcEAA\",\"aud\":\"dqe-unify-api\",\"urllogin\":\"https://login.salesforce.com\",\"sub\":\"0055e00000AbCnoFAF\",\"name\":\"Jane Doe\",\"sessionId\":\"00D5e0000008abcEAA!AQEAQJ3x9fKZ\",\"licence\":\"123456\",\"region\":\"EU\",\"isPersonAccountEnable\":false,\"chatterId\":\"0D55e00000ABCDEFG\",\"setTokenToUi\":true}";
var content = new StringContent(json, Encoding.UTF8, "application/json");

using var request = new HttpRequestMessage(HttpMethod.Post, "https://{DOMAIN}/customUI/createTokenSession");
request.Headers.Add("DQE-Authorization", "{DQE_AUTHORIZATION_KEY}");
request.Content = content;

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

func main() {
    body := []byte(`{"orgId":"00D5e0000008abcEAA","aud":"dqe-unify-api","urllogin":"https://login.salesforce.com","sub":"0055e00000AbCnoFAF","name":"Jane Doe","sessionId":"00D5e0000008abcEAA!AQEAQJ3x9fKZ","licence":"123456","region":"EU","isPersonAccountEnable":false,"chatterId":"0D55e00000ABCDEFG","setTokenToUi":true}`)

    req, _ := http.NewRequest("POST", "https://{DOMAIN}/customUI/createTokenSession", bytes.NewBuffer(body))
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("DQE-Authorization", "{DQE_AUTHORIZATION_KEY}")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    respBody, _ := io.ReadAll(resp.Body)
    fmt.Println(string(respBody))
}

Parameter

Alle Felder werden als ein einzelner JSON-Request-Body gesendet.

Hinweis zu Pflicht/Optional: Die Quell-OpenAPI-Spezifikation deklariert für diesen Request-Body kein required-Array (nur der Body als Ganzes ist als erforderlich markiert). Alle unten stehenden Felder werden gemäß der Dokumentationskonvention dieses Projekts als Pflicht angezeigt — die tatsächliche Optionalität vor der Veröffentlichung mit dem DQE-Engineering-Team bestätigen.

Feld	Beschreibung	Typ	Pflicht/Opt.
orgId	Die Salesforce-Organisations-ID, die die Anfrage stellt.	String	Pflicht
aud	Der Audience-Claim — der vorgesehene Empfänger-/Zieldienst für diese signierte Anfrage.	String	Pflicht
urllogin	Die Login-URL der Salesforce-Organisation.	String	Pflicht
sub	Der Subject-Claim — die Salesforce-Benutzer- oder Sitzungs-ID, die die Anfrage ausstellt.	String	Pflicht
name	Anzeigename, der mit der Sitzung verknüpft ist (zum Beispiel der Name des Salesforce-Benutzers).	String	Pflicht
sessionId	Kennung der Salesforce-Sitzung, an die dieses Custom-UI-Token gebunden ist.	String	Pflicht
licence	Der mit dieser Organisation verknüpfte DQE-Lizenzcode.	String	Pflicht
region	Die Region oder das Rechenzentrum der Salesforce-Organisation oder DQE-Instanz.	String	Pflicht
isPersonAccountEnable	Gibt an, ob Personenkonten (Person Accounts) in der aufrufenden Salesforce-Organisation aktiviert sind.	Boolean	Pflicht
chatterId	Kennung eines Salesforce-Chatter-Datensatzes (zum Beispiel eines Feed-Eintrags), der mit dieser Sitzung verknüpft ist. Nur aus dem Feldnamen abgeleitet — der genaue Zweck ist in der Quellspezifikation nicht dokumentiert.	String	Pflicht
setTokenToUi	Gibt an, ob das generierte Token direkt in die Custom-UI-Sitzung geschrieben werden soll, statt nur in der API-Antwort zurückgegeben zu werden. Nur aus dem Feldnamen abgeleitet.	Boolean	Pflicht

Antwort

Gibt ein JSON-Objekt zurück, das das erstellte Custom-UI-Sitzungs-Token beschreibt.

Schlüssel	Beschreibung	Typ
status	Ergebnisstatus der Sitzungserstellungsanfrage.	String
uuidToken	Das generierte Sitzungs-Token, mit dem die Custom-UI-Sitzung authentifiziert wird. Der Feldname deutet auf ein UUID-Format hin, dies wird von der Quellspezifikation jedoch nicht bestätigt.	String
name	Gibt den mit dem erstellten Token verknüpften Sitzungs-/Benutzernamen zurück.	String
isUiLocal	Gibt an, ob die Custom-UI-Sitzung im lokalen Modus läuft statt gegen die gehostete DQE-Umgebung. Nur aus dem Feldnamen abgeleitet — nicht durch die Quellspezifikation bestätigt.	Boolean

Antwortbeispiel

Beispiel einer Sitzungs-Token-Antwort

{
  "status": "success",
  "uuidToken": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Jane Doe",
  "isUiLocal": false
}

Die Quellspezifikation gibt für dieses Schema keine example-Werte an. Die obigen Werte sind lediglich veranschaulichende Platzhalter.

DQE One API — Authentifizierung & Sitzung

getOAuthTokenForProcess

Anfrage

Codebeispiele

Parameter

Antwort

Antwortbeispiel

Fehler

API testen

subscribe

Anfrage

Codebeispiele

Parameter

Antwort

Antwortbeispiel

Fehler

API testen

customUI/createTokenSession

Anfrage

Codebeispiele

Parameter

Antwort

Antwortbeispiel

Fehler

API testen

Siehe auch

War dieser Beitrag hilfreich?

Vorheriger Artikel

Nächster Artikel