/v2/auth2fa/list/backupkeyZehn neue Wiederherstellungscodes erzeugen
Deaktiviert alle bisherigen Backupcodes des angemeldeten Administrators im Konto und erzeugt zehn neue Codes. Die vollständigen neuen Codes werden einmalig in data.backupkey ausgegeben. Ein übergebenes admin darf nur die eigene öffentliche Administrator-ID sein; admin ist in diesem Sonderzweig optional.
Operation-ID post_v2_auth2fa_list_backupkey
Vertrag & Verhalten
- Dokumentationsstand
- reviewed
- Ändert Zustand
- Ja
- Als readOnly markiert
- Nein
- Für Automation markiert
- Nein
Authentifizierung
Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).
Alternative 1
bearerAuthhttp · bearerExisting edoobox v2 access token. Never substitute API key/secret headers.
Format: JWT
Security-Schema als JSON
{
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}accountContextapiKeySelected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.
header: edid
Security-Schema als JSON
{
"type": "apiKey",
"in": "header",
"name": "edid",
"description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}Alternative 2
sessionCookieapiKeyExisting browser login session, with the same permission checks as Bearer authentication.
cookie: _edlogin
Security-Schema als JSON
{
"type": "apiKey",
"in": "cookie",
"name": "_edlogin",
"description": "Existing browser login session, with the same permission checks as Bearer authentication."
}accountContextapiKeySelected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.
header: edid
Security-Schema als JSON
{
"type": "apiKey",
"in": "header",
"name": "edid",
"description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}Parameter
Header
languageoptionalAccount language code, where the resource supports setLanguage().
Schema-Beispiel
"de"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"de"
]
}X-Edoobox-If-RevisionoptionalOptional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.
- pattern
"^[a-f0-9]{32}$"
Schema-Beispiel
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"Vollständiges Schema als JSON
{
"type": "string",
"pattern": "^[a-f0-9]{32}$",
"examples": [
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
]
}Request Body
erforderlichapplication/json
data object erforderlich admin string Öffentliche v2-ID aus dem gewählten Konto; keine rohe Datenbank-ID.
- pattern
"^admin_[a-f0-9]{12}_-?[0-9]+$"
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"admin": {
"type": "string",
"pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem gewählten Konto; keine rohe Datenbank-ID."
}
},
"additionalProperties": true
}
},
"additionalProperties": true,
"required": [
"data"
]
}Zehn neue Wiederherstellungscodes erzeugen
{
"data": {}
}Antworten
11HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.
200application/json
insert=true und genau zehn vollständige neue Backupcodes; vertraulich behandeln.
Response Header
X-Edoobox-Revision
Rotated account revision supplied for the next action in one reviewed sequence.
- pattern
"^[a-f0-9]{32}$"
Vollständiges Schema als JSON
{
"type": "string",
"pattern": "^[a-f0-9]{32}$"
}application/json
success boolean error boolean | string error_code string data object insert boolean erforderlich backupkey array erforderlich - minItems
10- maxItems
10
Array-Elemente
Geschütztes Authentifizierungs- oder Wiederherstellungsmaterial; nicht protokollieren.
Feld-Metadaten aus der Spezifikation
{
"x-edoobox-sensitive": true
}Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
type string Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": [
"boolean",
"string"
]
},
"error_code": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"insert": {
"type": "boolean"
},
"backupkey": {
"type": "array",
"minItems": 10,
"maxItems": 10,
"items": {
"type": "string",
"x-edoobox-sensitive": true,
"description": "Geschütztes Authentifizierungs- oder Wiederherstellungsmaterial; nicht protokollieren."
}
}
},
"additionalProperties": true,
"required": [
"insert",
"backupkey"
]
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}Beispiel
{
"success": true,
"error": false,
"data": {
"insert": true,
"backupkey": [
"SYNTHETIC-BACKUP-01",
"SYNTHETIC-BACKUP-02",
"SYNTHETIC-BACKUP-03",
"SYNTHETIC-BACKUP-04",
"SYNTHETIC-BACKUP-05",
"SYNTHETIC-BACKUP-06",
"SYNTHETIC-BACKUP-07",
"SYNTHETIC-BACKUP-08",
"SYNTHETIC-BACKUP-09",
"SYNTHETIC-BACKUP-10"
]
}
}400application/json
Invalid request.
application/json
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
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
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
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
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED80019"
}409application/json
The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.
application/json
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "object",
"additionalProperties": true
}Beispiel
{
"error": "ED40901",
"error_code": "mutation_revision_conflict"
}422application/json
Validation failed.
application/json
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.
Schema-Beispiel
"30"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"30"
]
}application/json
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
Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.
Beispiel
{
"success": false,
"error": "ED50201"
}503application/json
The account mutation lock or revision store is unavailable. No unprotected fallback is executed.
Response Header
Retry-After
Fester Wert: 1
Vollständiges Schema als JSON
{
"type": "integer",
"const": 1
}application/json
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "object",
"additionalProperties": true
}Beispiel
{
"error": "ED50301",
"error_code": "mutation_revision_busy"
}Quelle & Metadaten
application/models/v2/Auth2fa.php:188postAuth2fa()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
truex-edoobox-user-handoff
{
"sensitivePaths": [
"/data/backupkey"
],
"oneTime": true
}x-edoobox-sensitive-response-paths
[
"/data/backupkey"
]x-edoobox-sensitiveResponseFields
[
"otpauth",
"yubikey",
"qrcode",
"review",
"backupkey",
"first5"
]x-edoobox-account-security-mutation
truex-edoobox-account-security-source
{
"file": "application/models/v2/Auth2fa.php",
"line": 184,
"reason": "Authenticated account credential enrollment, recovery and deletion are account mutations. Preserve JWT tenant/current-role permissions and mutation approval. Enrollment/recovery material requires a protected human handoff; browser authenticator cryptography remains a human step."
}x-edoobox-runtimeMutationGuard
truex-edoobox-documentationReview
{
"file": "docs/openapi/operation-contracts/05-auth.json",
"notes": []
}x-edoobox-source
{
"file": "application/models/v2/Auth2fa.php",
"method": "postAuth2fa",
"line": 188,
"branch": {
"file": "application/models/v2/Auth2fa.php",
"line": 212
}
}x-edoobox-documentationStatus
"reviewed"x-edoobox-readOnly
falsex-edoobox-safeForAutomation
falsex-edoobox-permission
{
"resource": "auth2fa",
"short": "2fa",
"checkedByDispatcher": true,
"levels": [
2,
3,
4
],
"description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}Vollständige Operation als JSON
{
"operationId": "post_v2_auth2fa_list_backupkey",
"summary": "Zehn neue Wiederherstellungscodes erzeugen",
"description": "Deaktiviert alle bisherigen Backupcodes des angemeldeten Administrators im Konto und erzeugt zehn neue Codes. Die vollständigen neuen Codes werden einmalig in data.backupkey ausgegeben. Ein übergebenes admin darf nur die eigene öffentliche Administrator-ID sein; admin ist in diesem Sonderzweig optional.",
"tags": [
"auth2fa"
],
"security": [
{
"bearerAuth": [],
"accountContext": []
},
{
"sessionCookie": [],
"accountContext": []
}
],
"parameters": [
{
"name": "language",
"in": "header",
"required": false,
"description": "Account language code, where the resource supports setLanguage().",
"schema": {
"type": "string",
"examples": [
"de"
]
}
},
{
"name": "X-Edoobox-If-Revision",
"in": "header",
"required": false,
"schema": {
"type": "string",
"pattern": "^[a-f0-9]{32}$",
"examples": [
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
]
},
"description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
}
],
"responses": {
"200": {
"description": "insert=true und genau zehn vollständige neue Backupcodes; vertraulich behandeln.",
"content": {
"application/json": {
"example": {
"success": true,
"error": false,
"data": {
"insert": true,
"backupkey": [
"SYNTHETIC-BACKUP-01",
"SYNTHETIC-BACKUP-02",
"SYNTHETIC-BACKUP-03",
"SYNTHETIC-BACKUP-04",
"SYNTHETIC-BACKUP-05",
"SYNTHETIC-BACKUP-06",
"SYNTHETIC-BACKUP-07",
"SYNTHETIC-BACKUP-08",
"SYNTHETIC-BACKUP-09",
"SYNTHETIC-BACKUP-10"
]
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": [
"boolean",
"string"
]
},
"error_code": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"insert": {
"type": "boolean"
},
"backupkey": {
"type": "array",
"minItems": 10,
"maxItems": 10,
"items": {
"type": "string",
"x-edoobox-sensitive": true,
"description": "Geschütztes Authentifizierungs- oder Wiederherstellungsmaterial; nicht protokollieren."
}
}
},
"additionalProperties": true,
"required": [
"insert",
"backupkey"
]
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"headers": {
"X-Edoobox-Revision": {
"schema": {
"type": "string",
"pattern": "^[a-f0-9]{32}$"
},
"description": "Rotated account revision supplied for the next action in one reviewed sequence."
}
}
},
"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"
}
}
}
},
"409": {
"description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"error": "ED40901",
"error_code": "mutation_revision_conflict"
}
}
}
},
"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"
}
}
}
},
"503": {
"description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
"headers": {
"Retry-After": {
"schema": {
"type": "integer",
"const": 1
}
}
},
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
},
"example": {
"error": "ED50301",
"error_code": "mutation_revision_busy"
}
}
}
}
},
"x-edoobox-mutates-state": true,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"admin": {
"type": "string",
"pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID aus dem gewählten Konto; keine rohe Datenbank-ID."
}
},
"additionalProperties": true
}
},
"additionalProperties": true,
"required": [
"data"
]
},
"examples": {
"request": {
"summary": "Zehn neue Wiederherstellungscodes erzeugen",
"value": {
"data": {}
}
}
}
}
}
},
"x-edoobox-user-handoff": {
"sensitivePaths": [
"/data/backupkey"
],
"oneTime": true
},
"x-edoobox-sensitive-response-paths": [
"/data/backupkey"
],
"x-edoobox-sensitiveResponseFields": [
"otpauth",
"yubikey",
"qrcode",
"review",
"backupkey",
"first5"
],
"x-edoobox-account-security-mutation": true,
"x-edoobox-account-security-source": {
"file": "application/models/v2/Auth2fa.php",
"line": 184,
"reason": "Authenticated account credential enrollment, recovery and deletion are account mutations. Preserve JWT tenant/current-role permissions and mutation approval. Enrollment/recovery material requires a protected human handoff; browser authenticator cryptography remains a human step."
},
"x-edoobox-runtimeMutationGuard": true,
"x-edoobox-documentationReview": {
"file": "docs/openapi/operation-contracts/05-auth.json",
"notes": []
},
"x-edoobox-source": {
"file": "application/models/v2/Auth2fa.php",
"method": "postAuth2fa",
"line": 188,
"branch": {
"file": "application/models/v2/Auth2fa.php",
"line": 212
}
},
"x-edoobox-documentationStatus": "reviewed",
"x-edoobox-readOnly": false,
"x-edoobox-safeForAutomation": false,
"x-edoobox-permission": {
"resource": "auth2fa",
"short": "2fa",
"checkedByDispatcher": true,
"levels": [
2,
3,
4
],
"description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}
}