authAPI-Referenz

GET/v2/auth/admin_invitation

Gültigkeit einer Administrator-Einladung prüfen

Prüft den vertraulichen Einladungs-code aus der Query und liefert Gültigkeit, Status, Ablaufzeit sowie Anzeigenamen. Fehlende/ungültige Codes liefern valid=false; die Einladung wird durch das Lesen nicht angenommen.

Operation-ID get_v2_auth_admin_invitation

Vertrag & Verhalten

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

GET-Verhalten laut Spezifikation

read

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

Query-Parameter

codeoptional

Vertraulicher Einladungs-Code.

string writeOnly sensibler Wert

Einladungs-Code aus dem erhaltenen Link, 40 bis 200 Zeichen.

Vollständiges Schema als JSON

{
  "type": "string",
  "writeOnly": true,
  "x-edoobox-sensitive": true,
  "description": "Einladungs-Code aus dem erhaltenen Link, 40 bis 200 Zeichen."
}

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-sensitive": true
}

Request Body

Kein Request Body in der Spezifikation beschrieben.

Antworten

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

200application/json

Öffentliche Einladungsanzeige ohne interne IDs.

`application/json`

object

success boolean

error boolean | string

error_code string

data object

valid boolean erforderlich

status string erforderlich

expires_at integer | null erforderlich

invited_by_name string erforderlich

admin_name string erforderlich

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": {
        "valid": {
          "type": "boolean"
        },
        "status": {
          "type": "string"
        },
        "expires_at": {
          "type": [
            "integer",
            "null"
          ]
        },
        "invited_by_name": {
          "type": "string"
        },
        "admin_name": {
          "type": "string"
        }
      },
      "additionalProperties": true,
      "required": [
        "valid",
        "status",
        "expires_at",
        "invited_by_name",
        "admin_name"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "valid": true,
    "status": "pending",
    "expires_at": 1790261000,
    "invited_by_name": "Kim Beispiel",
    "admin_name": "Alex Beispiel"
  }
}

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

false

x-edoobox-runtimeMutationGuard

false

x-edoobox-get-effect

"read"

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

true

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": "get_v2_auth_admin_invitation",
  "summary": "Gültigkeit einer Administrator-Einladung prüfen",
  "description": "Prüft den vertraulichen Einladungs-code aus der Query und liefert Gültigkeit, Status, Ablaufzeit sowie Anzeigenamen. Fehlende/ungültige Codes liefern valid=false; die Einladung wird durch das Lesen nicht angenommen.",
  "tags": [
    "auth"
  ],
  "security": [],
  "parameters": [
    {
      "name": "code",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "writeOnly": true,
        "x-edoobox-sensitive": true,
        "description": "Einladungs-Code aus dem erhaltenen Link, 40 bis 200 Zeichen."
      },
      "description": "Vertraulicher Einladungs-Code."
    }
  ],
  "responses": {
    "200": {
      "description": "Öffentliche Einladungsanzeige ohne interne IDs.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "valid": true,
              "status": "pending",
              "expires_at": 1790261000,
              "invited_by_name": "Kim Beispiel",
              "admin_name": "Alex Beispiel"
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "valid": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "string"
                  },
                  "expires_at": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "invited_by_name": {
                    "type": "string"
                  },
                  "admin_name": {
                    "type": "string"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "valid",
                  "status",
                  "expires_at",
                  "invited_by_name",
                  "admin_name"
                ]
              },
              "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": false,
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "read",
  "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": true,
  "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

: "${API_ORIGIN:?API_ORIGIN setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/auth/admin_invitation'

JavaScript

const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/auth/admin_invitation";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
const response = await fetch(url, { method: "GET", headers, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/auth/admin_invitation"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}

# 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="GET")
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

const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/auth/admin_invitation";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
const response = await fetch(url, { method: "GET", headers, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/auth/admin_invitation"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}

# 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="GET")
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.