authAPI-Referenz

POST/v2/auth

Administrator anmelden oder API-Token beziehen

Meldet einen Administrator mit email/password oder einen nicht öffentlichen API-Zugang mit key/secret an (grant-type=password). Alternativ signiert authorization_code einen 50-Zeichen-Übergabetoken samt zugelassenem App-Callback für den anschließenden Browser-Login. Header grant-type hat Vorrang vor dem gleichnamigen JSON-Feld. Administratoren mit zweitem Faktor erhalten zunächst einen eingeschränkten 2FA-Kontext. API-Logins liefern access_token oben im Antwortobjekt, Administratoren auf dem Produktionssystem üblicherweise ein _edlogin-Cookie. Konto-Kontexte in data.login.data werden später über edid gewählt; Passwörter/Secrets/Token nie protokollieren.

Operation-ID post_v2_auth

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.

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

Parameter

Header

languageoptional

Account language code, where the resource supports setLanguage().

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

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

grant-typeoptional

Alternativ zum JSON-Feld; wird zuerst ausgewertet.

string

Erlaubte Werte

"password""authorization_code"

Vollständiges Schema als JSON

{
  "type": "string",
  "enum": [
    "password",
    "authorization_code"
  ]
}

Request Body

erforderlich

`application/json`

object

grant-type muss im Header oder JSON stehen. Das JSON-Schema kann die Header-Alternative nicht als erforderliches Body-Feld ausdrücken.

grant-type string

Erlaubte Werte

"password""authorization_code"

email string

format: "email"

password string writeOnly sensibler Wert

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

minLength: 8

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

key string writeOnly sensibler Wert

API-Schlüssel mit Präfix key_; aus dem geschützten API-Zugang beziehen.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

secret string writeOnly sensibler Wert

API-Secret mit Präfix sec_; nur bei Erstellung ausgegeben.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

token string writeOnly sensibler Wert

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

minLength: 50
maxLength: 50

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

redirect_uri string

App-Callback beginnend mit com.edoobox.admission://, com.edoobox.scan:// oder com.edoobox.event://.

reply string

cookie (Standard), code (App-Übergabe) oder token (Administrator-Tokenantwort ist umgebungsabhängig eingeschränkt).

remember Typ nicht eingeschränkt

PHP-normalisierte Remember-Auswahl; kanonisch Boolean. true verlängert Administrator-Sitzungen.

Schema-Beispiel

false

expire string | number

Optionaler API-Ablaufzeitpunkt, durch dP in Unixzeit normalisiert.

state string writeOnly sensibler Wert

Signierter State aus dem authorization_code-Vorlauf bei reply=code.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

g-recaptcha-response string writeOnly sensibler Wert

Bedingt erforderlicher reCAPTCHA-Nachweis nach verdächtigen Anmeldeversuchen.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

anyOf · Mindestens eine Variante muss passen

Variante 1 Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: email, password

Variante 2 Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: key, secret

Variante 3 Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: token, redirect_uri

allOf · Alle Teilschemas müssen gemeinsam passen

Variante 1 Typ nicht eingeschränkt

Schema-Regel if

Typ nicht eingeschränkt

grant-type Typ nicht eingeschränkt erforderlich

Fester Wert: "password"

Schema-Regel then

Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: email, password

Variante 2 Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: key, secret

Variante 2 Typ nicht eingeschränkt

Schema-Regel if

Typ nicht eingeschränkt

grant-type Typ nicht eingeschränkt erforderlich

Fester Wert: "authorization_code"

Schema-Regel then

Typ nicht eingeschränkt

Zusätzlich erforderlich, ohne eigenes Feldschema: token, redirect_uri

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "grant-type": {
      "type": "string",
      "enum": [
        "password",
        "authorization_code"
      ]
    },
    "email": {
      "type": "string",
      "format": "email"
    },
    "password": {
      "type": "string",
      "writeOnly": true,
      "x-edoobox-sensitive": true,
      "description": "Nur synthetisches Beispiel; tatsächlich zurückgegebenes geschütztes Material sicher übergeben.",
      "minLength": 8
    },
    "key": {
      "type": "string",
      "writeOnly": true,
      "x-edoobox-sensitive": true,
      "description": "API-Schlüssel mit Präfix key_; aus dem geschützten API-Zugang beziehen."
    },
    "secret": {
      "type": "string",
      "writeOnly": true,
      "x-edoobox-sensitive": true,
      "description": "API-Secret mit Präfix sec_; nur bei Erstellung ausgegeben."
    },
    "token": {
      "type": "string",
      "writeOnly": true,
      "x-edoobox-sensitive": true,
      "description": "Nur synthetisches Beispiel; tatsächlich zurückgegebenes geschütztes Material sicher übergeben.",
      "minLength": 50,
      "maxLength": 50
    },
    "redirect_uri": {
      "type": "string",
      "description": "App-Callback beginnend mit com.edoobox.admission://, com.edoobox.scan:// oder com.edoobox.event://."
    },
    "reply": {
      "type": "string",
      "description": "cookie (Standard), code (App-Übergabe) oder token (Administrator-Tokenantwort ist umgebungsabhängig eingeschränkt)."
    },
    "remember": {
      "description": "PHP-normalisierte Remember-Auswahl; kanonisch Boolean. true verlängert Administrator-Sitzungen.",
      "examples": [
        false
      ]
    },
    "expire": {
      "type": [
        "string",
        "number"
      ],
      "description": "Optionaler API-Ablaufzeitpunkt, durch dP in Unixzeit normalisiert."
    },
    "state": {
      "type": "string",
      "writeOnly": true,
      "x-edoobox-sensitive": true,
      "description": "Signierter State aus dem authorization_code-Vorlauf bei reply=code."
    },
    "g-recaptcha-response": {
      "type": "string",
      "writeOnly": true,
      "x-edoobox-sensitive": true,
      "description": "Bedingt erforderlicher reCAPTCHA-Nachweis nach verdächtigen Anmeldeversuchen."
    }
  },
  "additionalProperties": true,
  "anyOf": [
    {
      "required": [
        "email",
        "password"
      ]
    },
    {
      "required": [
        "key",
        "secret"
      ]
    },
    {
      "required": [
        "token",
        "redirect_uri"
      ]
    }
  ],
  "description": "grant-type muss im Header oder JSON stehen. Das JSON-Schema kann die Header-Alternative nicht als erforderliches Body-Feld ausdrücken.",
  "allOf": [
    {
      "if": {
        "required": [
          "grant-type"
        ],
        "properties": {
          "grant-type": {
            "const": "password"
          }
        }
      },
      "then": {
        "anyOf": [
          {
            "required": [
              "email",
              "password"
            ]
          },
          {
            "required": [
              "key",
              "secret"
            ]
          }
        ]
      }
    },
    {
      "if": {
        "required": [
          "grant-type"
        ],
        "properties": {
          "grant-type": {
            "const": "authorization_code"
          }
        }
      },
      "then": {
        "required": [
          "token",
          "redirect_uri"
        ]
      }
    }
  ]
}

Administrator anmelden oder API-Token beziehen

{
  "grant-type": "password",
  "email": "alex@example.invalid",
  "password": "Synthetic-Password-42!",
  "reply": "cookie",
  "remember": false
}

Antworten

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

200application/json

Je nach Grant Login-Kontext mit optionalem Login-Payload, Cookie-/Tokenmodus oder {state,redirect_uri} für App-Übergabe; API-access_token steht auf oberster Ebene. reply=code kann ausschließlich {code} liefern.

`application/json`

object

success boolean

error boolean | string

error_code string

data object

edid string

Opaker Login-Kontext edid aus der Authentifizierungsantwort. Keine Objekt- oder Datenbank-ID.

Schema-Beispiel

"edid_synthetic_login_context"

login object

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

token string | boolean sensibler Wert

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

cookie string | boolean

code string sensibler Wert

Geschütztes Authentifizierungs- oder Wiederherstellungsmaterial; nicht protokollieren.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

state string sensibler Wert

Geschütztes Authentifizierungs- oder Wiederherstellungsmaterial; nicht protokollieren.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

redirect_uri string

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": {
        "edid": {
          "type": "string",
          "description": "Opaker Login-Kontext edid aus der Authentifizierungsantwort. Keine Objekt- oder Datenbank-ID.",
          "examples": [
            "edid_synthetic_login_context"
          ]
        },
        "login": {
          "type": "object",
          "additionalProperties": true
        },
        "token": {
          "type": [
            "string",
            "boolean"
          ],
          "x-edoobox-sensitive": true
        },
        "cookie": {
          "type": [
            "string",
            "boolean"
          ]
        },
        "code": {
          "type": "string",
          "x-edoobox-sensitive": true,
          "description": "Geschütztes Authentifizierungs- oder Wiederherstellungsmaterial; nicht protokollieren."
        },
        "state": {
          "type": "string",
          "x-edoobox-sensitive": true,
          "description": "Geschütztes Authentifizierungs- oder Wiederherstellungsmaterial; nicht protokollieren."
        },
        "redirect_uri": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "edid": "edid_synthetic_login_context",
    "cookie": "_edlogin",
    "token": false
  }
}

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

{
  "resource": "auth",
  "short": "auth",
  "checkedByDispatcher": false,
  "levels": [],
  "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."
}

Vollständige Operation als JSON

{
  "operationId": "post_v2_auth",
  "summary": "Administrator anmelden oder API-Token beziehen",
  "description": "Meldet einen Administrator mit email/password oder einen nicht öffentlichen API-Zugang mit key/secret an (grant-type=password). Alternativ signiert authorization_code einen 50-Zeichen-Übergabetoken samt zugelassenem App-Callback für den anschließenden Browser-Login. Header grant-type hat Vorrang vor dem gleichnamigen JSON-Feld. Administratoren mit zweitem Faktor erhalten zunächst einen eingeschränkten 2FA-Kontext. API-Logins liefern access_token oben im Antwortobjekt, Administratoren auf dem Produktionssystem üblicherweise ein _edlogin-Cookie. Konto-Kontexte in data.login.data werden später über edid gewählt; Passwörter/Secrets/Token nie protokollieren.",
  "tags": [
    "auth"
  ],
  "security": [],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "grant-type",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "password",
          "authorization_code"
        ]
      },
      "description": "Alternativ zum JSON-Feld; wird zuerst ausgewertet."
    }
  ],
  "responses": {
    "200": {
      "description": "Je nach Grant Login-Kontext mit optionalem Login-Payload, Cookie-/Tokenmodus oder {state,redirect_uri} für App-Übergabe; API-access_token steht auf oberster Ebene. reply=code kann ausschließlich {code} liefern.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "edid": "edid_synthetic_login_context",
              "cookie": "_edlogin",
              "token": false
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "edid": {
                    "type": "string",
                    "description": "Opaker Login-Kontext edid aus der Authentifizierungsantwort. Keine Objekt- oder Datenbank-ID.",
                    "examples": [
                      "edid_synthetic_login_context"
                    ]
                  },
                  "login": {
                    "type": "object",
                    "additionalProperties": true
                  },
                  "token": {
                    "type": [
                      "string",
                      "boolean"
                    ],
                    "x-edoobox-sensitive": true
                  },
                  "cookie": {
                    "type": [
                      "string",
                      "boolean"
                    ]
                  },
                  "code": {
                    "type": "string",
                    "x-edoobox-sensitive": true,
                    "description": "Geschütztes Authentifizierungs- oder Wiederherstellungsmaterial; nicht protokollieren."
                  },
                  "state": {
                    "type": "string",
                    "x-edoobox-sensitive": true,
                    "description": "Geschütztes Authentifizierungs- oder Wiederherstellungsmaterial; nicht protokollieren."
                  },
                  "redirect_uri": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              },
              "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": {
            "grant-type": {
              "type": "string",
              "enum": [
                "password",
                "authorization_code"
              ]
            },
            "email": {
              "type": "string",
              "format": "email"
            },
            "password": {
              "type": "string",
              "writeOnly": true,
              "x-edoobox-sensitive": true,
              "description": "Nur synthetisches Beispiel; tatsächlich zurückgegebenes geschütztes Material sicher übergeben.",
              "minLength": 8
            },
            "key": {
              "type": "string",
              "writeOnly": true,
              "x-edoobox-sensitive": true,
              "description": "API-Schlüssel mit Präfix key_; aus dem geschützten API-Zugang beziehen."
            },
            "secret": {
              "type": "string",
              "writeOnly": true,
              "x-edoobox-sensitive": true,
              "description": "API-Secret mit Präfix sec_; nur bei Erstellung ausgegeben."
            },
            "token": {
              "type": "string",
              "writeOnly": true,
              "x-edoobox-sensitive": true,
              "description": "Nur synthetisches Beispiel; tatsächlich zurückgegebenes geschütztes Material sicher übergeben.",
              "minLength": 50,
              "maxLength": 50
            },
            "redirect_uri": {
              "type": "string",
              "description": "App-Callback beginnend mit com.edoobox.admission://, com.edoobox.scan:// oder com.edoobox.event://."
            },
            "reply": {
              "type": "string",
              "description": "cookie (Standard), code (App-Übergabe) oder token (Administrator-Tokenantwort ist umgebungsabhängig eingeschränkt)."
            },
            "remember": {
              "description": "PHP-normalisierte Remember-Auswahl; kanonisch Boolean. true verlängert Administrator-Sitzungen.",
              "examples": [
                false
              ]
            },
            "expire": {
              "type": [
                "string",
                "number"
              ],
              "description": "Optionaler API-Ablaufzeitpunkt, durch dP in Unixzeit normalisiert."
            },
            "state": {
              "type": "string",
              "writeOnly": true,
              "x-edoobox-sensitive": true,
              "description": "Signierter State aus dem authorization_code-Vorlauf bei reply=code."
            },
            "g-recaptcha-response": {
              "type": "string",
              "writeOnly": true,
              "x-edoobox-sensitive": true,
              "description": "Bedingt erforderlicher reCAPTCHA-Nachweis nach verdächtigen Anmeldeversuchen."
            }
          },
          "additionalProperties": true,
          "anyOf": [
            {
              "required": [
                "email",
                "password"
              ]
            },
            {
              "required": [
                "key",
                "secret"
              ]
            },
            {
              "required": [
                "token",
                "redirect_uri"
              ]
            }
          ],
          "description": "grant-type muss im Header oder JSON stehen. Das JSON-Schema kann die Header-Alternative nicht als erforderliches Body-Feld ausdrücken.",
          "allOf": [
            {
              "if": {
                "required": [
                  "grant-type"
                ],
                "properties": {
                  "grant-type": {
                    "const": "password"
                  }
                }
              },
              "then": {
                "anyOf": [
                  {
                    "required": [
                      "email",
                      "password"
                    ]
                  },
                  {
                    "required": [
                      "key",
                      "secret"
                    ]
                  }
                ]
              }
            },
            {
              "if": {
                "required": [
                  "grant-type"
                ],
                "properties": {
                  "grant-type": {
                    "const": "authorization_code"
                  }
                }
              },
              "then": {
                "required": [
                  "token",
                  "redirect_uri"
                ]
              }
            }
          ]
        },
        "examples": {
          "request": {
            "summary": "Administrator anmelden oder API-Token beziehen",
            "value": {
              "grant-type": "password",
              "email": "alex@example.invalid",
              "password": "Synthetic-Password-42!",
              "reply": "cookie",
              "remember": false
            }
          }
        }
      }
    }
  },
  "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": {
    "resource": "auth",
    "short": "auth",
    "checkedByDispatcher": false,
    "levels": [],
    "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."
  }
}

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'
{
  "grant-type": "password",
  "email": "alex@example.invalid",
  "password": "Synthetic-Password-42!",
  "reply": "cookie",
  "remember": false
}
EDOOBOX_JSON_EXAMPLE
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/auth' \
  --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";
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({
  "grant-type": "password",
  "email": "alex@example.invalid",
  "password": "Synthetic-Password-42!",
  "reply": "cookie",
  "remember": false
});
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"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Content-Type"] = "application/json"
body = "{\"grant-type\":\"password\",\"email\":\"alex@example.invalid\",\"password\":\"Synthetic-Password-42!\",\"reply\":\"cookie\",\"remember\":false}".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";
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({
  "grant-type": "password",
  "email": "alex@example.invalid",
  "password": "Synthetic-Password-42!",
  "reply": "cookie",
  "remember": false
});
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"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Content-Type"] = "application/json"
body = "{\"grant-type\":\"password\",\"email\":\"alex@example.invalid\",\"password\":\"Synthetic-Password-42!\",\"reply\":\"cookie\",\"remember\":false}".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.