authAPI-Referenz

POST/v2/auth/admin_invitation/accept

Administrator-Einladung annehmen

Prüft den gültigen, noch nicht angenommenen Einladungscode, setzt das über die Passwortregeln geprüfte Passwort und markiert die Einladung als angenommen. Erstellt anschließend einen Administrator-Login; reply=token bleibt von der produktiven Tokenausgaberegel abhängig. code und password stehen im data-Objekt.

Operation-ID post_v2_auth_admin_invitation_accept

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

object

data object erforderlich

code string erforderlich writeOnly sensibler Wert

Nur synthetisches Beispiel; tatsächlich zurückgegebenes geschütztes Material sicher übergeben.

minLength: 40
maxLength: 200

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

password string erforderlich writeOnly sensibler Wert

Neues Passwort: mindestens acht Zeichen mit Klein-/Großbuchstaben, Ziffer und unterstütztem Sonderzeichen; Trivialpasswortliste wird geprüft. Der Server trimmt das Passwort.

minLength: 8

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

reply string

token fordert Tokenmodus an; jeder andere Wert verwendet cookie. Produktionsregel kann Tokenmodus auf Cookie zurückführen.

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "writeOnly": true,
          "x-edoobox-sensitive": true,
          "description": "Nur synthetisches Beispiel; tatsächlich zurückgegebenes geschütztes Material sicher übergeben.",
          "minLength": 40,
          "maxLength": 200
        },
        "password": {
          "type": "string",
          "writeOnly": true,
          "x-edoobox-sensitive": true,
          "description": "Neues Passwort: mindestens acht Zeichen mit Klein-/Großbuchstaben, Ziffer und unterstütztem Sonderzeichen; Trivialpasswortliste wird geprüft. Der Server trimmt das Passwort.",
          "minLength": 8
        },
        "reply": {
          "type": "string",
          "description": "token fordert Tokenmodus an; jeder andere Wert verwendet cookie. Produktionsregel kann Tokenmodus auf Cookie zurückführen."
        }
      },
      "additionalProperties": true,
      "required": [
        "code",
        "password"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}

Beispiel

{
  "data": {
    "code": "iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii",
    "password": "Synthetic-Invitation-42!",
    "reply": "cookie"
  }
}

`application/x-www-form-urlencoded`

object

code string erforderlich writeOnly sensibler Wert

Nur synthetisches Beispiel; tatsächlich zurückgegebenes geschütztes Material sicher übergeben.

minLength: 40
maxLength: 200

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

password string erforderlich writeOnly sensibler Wert

Neues Passwort: mindestens acht Zeichen mit Klein-/Großbuchstaben, Ziffer und unterstütztem Sonderzeichen; Trivialpasswortliste wird geprüft. Der Server trimmt das Passwort.

minLength: 8

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

reply string

token fordert Tokenmodus an; jeder andere Wert verwendet cookie. Produktionsregel kann Tokenmodus auf Cookie zurückführen.

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "writeOnly": true,
      "x-edoobox-sensitive": true,
      "description": "Nur synthetisches Beispiel; tatsächlich zurückgegebenes geschütztes Material sicher übergeben.",
      "minLength": 40,
      "maxLength": 200
    },
    "password": {
      "type": "string",
      "writeOnly": true,
      "x-edoobox-sensitive": true,
      "description": "Neues Passwort: mindestens acht Zeichen mit Klein-/Großbuchstaben, Ziffer und unterstütztem Sonderzeichen; Trivialpasswortliste wird geprüft. Der Server trimmt das Passwort.",
      "minLength": 8
    },
    "reply": {
      "type": "string",
      "description": "token fordert Tokenmodus an; jeder andere Wert verwendet cookie. Produktionsregel kann Tokenmodus auf Cookie zurückführen."
    }
  },
  "additionalProperties": true,
  "required": [
    "code",
    "password"
  ]
}

Beispiel

{
  "code": "iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii",
  "password": "Synthetic-Invitation-42!",
  "reply": "cookie"
}

Antworten

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

200application/json

Grantabhängige Administrator-Login-Antwort mit Cookie bzw. erlaubtem Tokenmodus; kein neues Konto wird angelegt.

`application/json`

object

success boolean

error boolean | string

error_code string

data Typ nicht eingeschränkt

Action-dependent data; deliberately unconstrained until a complete field contract is established.

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": {
      "description": "Action-dependent data; deliberately unconstrained until a complete field contract is established."
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "auth_012345abcdef_123456"
  }
}

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-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_admin_invitation_accept",
  "summary": "Administrator-Einladung annehmen",
  "description": "Prüft den gültigen, noch nicht angenommenen Einladungscode, setzt das über die Passwortregeln geprüfte Passwort und markiert die Einladung als angenommen. Erstellt anschließend einen Administrator-Login; reply=token bleibt von der produktiven Tokenausgaberegel abhängig. code und password stehen im data-Objekt.",
  "tags": [
    "auth"
  ],
  "security": [],
  "parameters": [],
  "responses": {
    "200": {
      "description": "Grantabhängige Administrator-Login-Antwort mit Cookie bzw. erlaubtem Tokenmodus; kein neues Konto wird angelegt.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "auth_012345abcdef_123456"
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "description": "Action-dependent data; deliberately unconstrained until a complete field contract is established."
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      }
    },
    "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/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string",
                  "writeOnly": true,
                  "x-edoobox-sensitive": true,
                  "description": "Nur synthetisches Beispiel; tatsächlich zurückgegebenes geschütztes Material sicher übergeben.",
                  "minLength": 40,
                  "maxLength": 200
                },
                "password": {
                  "type": "string",
                  "writeOnly": true,
                  "x-edoobox-sensitive": true,
                  "description": "Neues Passwort: mindestens acht Zeichen mit Klein-/Großbuchstaben, Ziffer und unterstütztem Sonderzeichen; Trivialpasswortliste wird geprüft. Der Server trimmt das Passwort.",
                  "minLength": 8
                },
                "reply": {
                  "type": "string",
                  "description": "token fordert Tokenmodus an; jeder andere Wert verwendet cookie. Produktionsregel kann Tokenmodus auf Cookie zurückführen."
                }
              },
              "additionalProperties": true,
              "required": [
                "code",
                "password"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "example": {
          "data": {
            "code": "iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii",
            "password": "Synthetic-Invitation-42!",
            "reply": "cookie"
          }
        }
      },
      "application/x-www-form-urlencoded": {
        "schema": {
          "type": "object",
          "properties": {
            "code": {
              "type": "string",
              "writeOnly": true,
              "x-edoobox-sensitive": true,
              "description": "Nur synthetisches Beispiel; tatsächlich zurückgegebenes geschütztes Material sicher übergeben.",
              "minLength": 40,
              "maxLength": 200
            },
            "password": {
              "type": "string",
              "writeOnly": true,
              "x-edoobox-sensitive": true,
              "description": "Neues Passwort: mindestens acht Zeichen mit Klein-/Großbuchstaben, Ziffer und unterstütztem Sonderzeichen; Trivialpasswortliste wird geprüft. Der Server trimmt das Passwort.",
              "minLength": 8
            },
            "reply": {
              "type": "string",
              "description": "token fordert Tokenmodus an; jeder andere Wert verwendet cookie. Produktionsregel kann Tokenmodus auf Cookie zurückführen."
            }
          },
          "additionalProperties": true,
          "required": [
            "code",
            "password"
          ]
        },
        "example": {
          "code": "iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii",
          "password": "Synthetic-Invitation-42!",
          "reply": "cookie"
        }
      }
    }
  },
  "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: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
: "${API_ORIGIN:?API_ORIGIN setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "data": {
    "code": "iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii",
    "password": "Synthetic-Invitation-42!",
    "reply": "cookie"
  }
}
EDOOBOX_JSON_EXAMPLE
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/auth/admin_invitation/accept' \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/auth/admin_invitation/accept";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "code": "iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii",
    "password": "Synthetic-Invitation-42!",
    "reply": "cookie"
  }
});
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: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/auth/admin_invitation/accept"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"code\":\"iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii\",\"password\":\"Synthetic-Invitation-42!\",\"reply\":\"cookie\"}}".encode("utf-8")

# 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: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/auth/admin_invitation/accept";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "code": "iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii",
    "password": "Synthetic-Invitation-42!",
    "reply": "cookie"
  }
});
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: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/auth/admin_invitation/accept"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"code\":\"iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii\",\"password\":\"Synthetic-Invitation-42!\",\"reply\":\"cookie\"}}".encode("utf-8")

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