# 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
- Dokumentation: /docs/api/v2/operations/post-v2-auth-saml-reply-f7b34370e447/
- OpenAPI-Version: 3.2.1
- Vollständige Spezifikation: /docs/api/v2/openapi.json
- Dokumentationsstatus: reviewed
- Ändert Zustand: ja
- Für Automation freigegeben: nein

## Server

Serverwerte stammen unverändert aus der Datei. Eine lokale Entwicklungsadresse ist keine bestätigte Produktionsadresse. `API_ORIGIN` muss auf die passende Instanz gesetzt werden.

```json
[
  {
    "url": "https://app2.edoobox.com",
    "description": "edoobox API"
  }
]
```

## Authentifizierung

Für diesen Endpunkt deklariert die Spezifikation keine OpenAPI-Authentifizierung (`security: []`). Weitere Bedingungen stehen in der Beschreibung und den edoobox-Hinweisen.

### Wirksame Security Requirements und vollständige Verfahren

```json
{
  "security": [],
  "securitySchemes": {}
}
```

## Parameter

Keine Parameter deklariert.

### Vollständige wirksame Parameterdefinitionen

```json
[]
```

## Anfrage

```json
{
  "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="
      }
    }
  }
}
```

## Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. Die folgenden Beschreibungen und Schemata sind die Angaben der Quelldatei.

```json
{
  "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"
        }
      }
    }
  }
}
```

## Aufrufbeispiele

Anpassen vor dem Ausführen. Platzhalter und veröffentlichte Beispiele sind synthetisch. Die Beispiele senden hier keine Anfrage; sie ergänzen keine unbekannten Pflichtfelder.

### cURL

```sh
# 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 (Node.js)

```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

```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.
```

## Vollständige Operationsdefinition und edoobox-Hinweise

Alle Originalfelder einschliesslich `x-edoobox-*`, requestBody und responses bleiben erhalten. Teilweise dokumentierte Schemata sind kein vollständiger Validierungsvertrag.

```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": []
  }
}
```