authAPI-Referenz

POST/v2/auth/saml/reply

SAML-Identitätsantwort empfangen

Empfängt SAMLResponse als Formularfeld des IdP und validiert sie gegen den gestarteten SSO-Vorgang, Providerkonfiguration und Signatur. Nutzt _edsso-Cookie oder die ausdrücklich konfigurierte cookiearme Korrelation. Kann den zugeordneten Administrator/Teilnehmer anlegen oder verbinden und eine Login-Sitzung erstellen; danach Browser-Weiterleitung. Kein JSON-data-Envelope und kein frei aufrufbarer API-Login.

Operation-ID post_v2_auth_saml_reply

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Ja
Als readOnly markiert: Nein
Für Automation markiert: Nein

Authentifizierung

Für diesen Endpunkt sind keine OpenAPI-Security-Schemas vorgeschrieben. Weitere Voraussetzungen stehen in den Parametern und den Metadaten.

Berechtigungen

No account-JWT resource permission levels are applied. Authentication requirements, if any, are defined by this route source-specific boundary and dedicated security scheme.

Levels: Keine Account-Level angegeben
Dispatcher-Prüfung: Nein

Parameter

Keine Parameter in der Spezifikation angegeben. Authentifizierungsdaten sind oben separat aufgeführt.

Request Body

erforderlich

`application/x-www-form-urlencoded`

object

SAMLResponse string erforderlich writeOnly sensibler Wert

Base64-kodierte signierte SAMLResponse des IdP.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "SAMLResponse": {
      "type": "string",
      "writeOnly": true,
      "x-edoobox-sensitive": true,
      "description": "Base64-kodierte signierte SAMLResponse des IdP."
    }
  },
  "additionalProperties": true,
  "required": [
    "SAMLResponse"
  ]
}

Beispiel

{
  "SAMLResponse": "c3ludGhldGljLXNhbWwtcmVzcG9uc2U="
}

Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200text/html

Browser-Antwort/Weiterleitung nach SAML-Anmeldung; Fehler können ebenfalls als Login-Weiterleitung erscheinen.

`text/html`

string

Vollständiges Schema als JSON

{
  "type": "string"
}

302Ohne dokumentierten Response Body

Browser-Weiterleitung zum Folgeschritt oder zur Fehleransicht.

Response Header

400application/json

Invalid request.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40006"
}

401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40103"
}

402application/json

Missing/invalid action data or subscription/operation restriction.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80100"
}

403application/json

Permission denied. Browser CORS rejection may have an empty body.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40340"
}

404application/json

Unknown resource/action or unsupported method.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80019"
}

422application/json

Validation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80020"
}

429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

`Retry-After`

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string

Schema-Beispiel

"30"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "30"
  ]
}

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED42902"
}

502application/json

Server-side operation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED50201"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/controllers/V2.php:28coreV2()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state

true

x-edoobox-exampleStatus

"Requires a real signed SAML response from the configured identity provider; synthetic signatures are not executable examples."

x-edoobox-runtimeMutationGuard

false

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/05-auth.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/controllers/V2.php",
  "method": "coreV2",
  "line": 28
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "description": "No account-JWT resource permission levels are applied. Authentication requirements, if any, are defined by this route source-specific boundary and dedicated security scheme.",
  "checkedByDispatcher": false,
  "levels": []
}

Vollständige Operation als JSON

{
  "operationId": "post_v2_auth_saml_reply",
  "summary": "SAML-Identitätsantwort empfangen",
  "description": "Empfängt SAMLResponse als Formularfeld des IdP und validiert sie gegen den gestarteten SSO-Vorgang, Providerkonfiguration und Signatur. Nutzt _edsso-Cookie oder die ausdrücklich konfigurierte cookiearme Korrelation. Kann den zugeordneten Administrator/Teilnehmer anlegen oder verbinden und eine Login-Sitzung erstellen; danach Browser-Weiterleitung. Kein JSON-data-Envelope und kein frei aufrufbarer API-Login.",
  "tags": [
    "auth"
  ],
  "security": [],
  "parameters": [],
  "responses": {
    "200": {
      "description": "Browser-Antwort/Weiterleitung nach SAML-Anmeldung; Fehler können ebenfalls als Login-Weiterleitung erscheinen.",
      "content": {
        "text/html": {
          "schema": {
            "type": "string"
          }
        }
      }
    },
    "302": {
      "description": "Browser-Weiterleitung zum Folgeschritt oder zur Fehleransicht.",
      "headers": {
        "Location": {
          "schema": {
            "type": "string",
            "format": "uri"
          },
          "description": "Vom Server ermittelte Zieladresse."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/x-www-form-urlencoded": {
        "schema": {
          "type": "object",
          "properties": {
            "SAMLResponse": {
              "type": "string",
              "writeOnly": true,
              "x-edoobox-sensitive": true,
              "description": "Base64-kodierte signierte SAMLResponse des IdP."
            }
          },
          "additionalProperties": true,
          "required": [
            "SAMLResponse"
          ]
        },
        "example": {
          "SAMLResponse": "c3ludGhldGljLXNhbWwtcmVzcG9uc2U="
        }
      }
    }
  },
  "x-edoobox-exampleStatus": "Requires a real signed SAML response from the configured identity provider; synthetic signatures are not executable examples.",
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/05-auth.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/controllers/V2.php",
    "method": "coreV2",
    "line": 28
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "description": "No account-JWT resource permission levels are applied. Authentication requirements, if any, are defined by this route source-specific boundary and dedicated security scheme.",
    "checkedByDispatcher": false,
    "levels": []
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Request Body selbst gemäss Definition vorbereiten; unbekannte Pflichtfelder werden nicht erfunden.
# Bodydatei request-body.bin für application/x-www-form-urlencoded vorbereiten. REQUEST_CONTENT_TYPE einschliesslich nötiger Multipart-Boundary setzen.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${REQUEST_CONTENT_TYPE:?REQUEST_CONTENT_TYPE setzen}"
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/auth/saml/reply' \
  --header 'Content-Type: '"${REQUEST_CONTENT_TYPE}" \
  --data-binary '@request-body.bin'

JavaScript

// Request Body selbst gemäss Definition vorbereiten; unbekannte Pflichtfelder werden nicht erfunden.
// Bodydatei request-body.bin für application/x-www-form-urlencoded vorbereiten. REQUEST_CONTENT_TYPE einschliesslich nötiger Multipart-Boundary setzen.
import { readFileSync } from 'node:fs';
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/auth/saml/reply";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers['Content-Type'] = required('REQUEST_CONTENT_TYPE');
const body = readFileSync("request-body.bin");
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Request Body selbst gemäss Definition vorbereiten; unbekannte Pflichtfelder werden nicht erfunden.
# Bodydatei request-body.bin für application/x-www-form-urlencoded vorbereiten. REQUEST_CONTENT_TYPE einschliesslich nötiger Multipart-Boundary setzen.
import os
import urllib.parse
import urllib.request
import urllib.error
from pathlib import Path

path = "/v2/auth/saml/reply"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Content-Type"] = os.environ["REQUEST_CONTENT_TYPE"]
body = Path("request-body.bin").read_bytes()

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="POST", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Request Body selbst gemäss Definition vorbereiten; unbekannte Pflichtfelder werden nicht erfunden.
// Bodydatei request-body.bin für application/x-www-form-urlencoded vorbereiten. REQUEST_CONTENT_TYPE einschliesslich nötiger Multipart-Boundary setzen.
import { readFileSync } from 'node:fs';
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/auth/saml/reply";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers['Content-Type'] = required('REQUEST_CONTENT_TYPE');
const body = readFileSync("request-body.bin");
const response = await fetch(url, { method: "POST", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Request Body selbst gemäss Definition vorbereiten; unbekannte Pflichtfelder werden nicht erfunden.
# Bodydatei request-body.bin für application/x-www-form-urlencoded vorbereiten. REQUEST_CONTENT_TYPE einschliesslich nötiger Multipart-Boundary setzen.
import os
import urllib.parse
import urllib.request
import urllib.error
from pathlib import Path

path = "/v2/auth/saml/reply"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Content-Type"] = os.environ["REQUEST_CONTENT_TYPE"]
body = Path("request-body.bin").read_bytes()

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="POST", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.