authAPI-Referenz

GET/v2/auth/oauth2/microsoft_calendar/redirect

Microsoft-Supportkalender-Verbindung abschließen

Verarbeitet ausschließlich den Microsoft-Rückruf aus der zuvor gestarteten Support-Anmeldung und speichert die Kalender-Verbindung für die gebundene Support-Sitzung. state ist ein einmaliger, zehn Minuten gültiger 64-stelliger Hex-Wert mit serverseitiger Browser-Cookie-Bindung; aktuelle Rechte bzw. Support-Sitzung werden erneut geprüft. Query-code und Query-state werden auch beim POST-Alias verwendet. Abschließend folgt eine Browser-Weiterleitung; kein freier Konto- oder Token-Import.

Operation-ID get_v2_auth_oauth2_microsoft_calendar_redirect

Vertrag & Verhalten

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

Dieser GET-Aufruf kann Zustand verändern. Die HTTP-Methode allein kennzeichnet hier keinen reinen Lesezugriff.

GET-Verhalten laut Spezifikation

business-mutation

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

Fehlender oder ungültiger Code führt zur Fehlerweiterleitung.

string

Microsoft-Autorisierungscode; nur aus dem vorherigen Browser-Ablauf.

Vollständiges Schema als JSON

{
  "type": "string",
  "description": "Microsoft-Autorisierungscode; nur aus dem vorherigen Browser-Ablauf."
}

stateerforderlich

Einmaliger browsergebundener OAuth-State.

string sensibler Wert

pattern: "^[a-f0-9]{64}$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{64}$",
  "x-edoobox-sensitive": true
}

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.

200Ohne dokumentierten Response Body

Browser-Weiterleitung zur Mail- bzw. Supportansicht mit Erfolgs-/Fehlerstatus.

302Ohne dokumentierten Response Body

Browser-Weiterleitung zum Folgeschritt oder zur Fehleransicht.

Response Header

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-auth-boundarySource

{
  "file": "application/models/v2/auth/Microsoftcalendar.php",
  "line": 14,
  "reason": "Reads code/state from query for both HTTP methods, validates the OAuth state through the provider handler, and writes a Location redirect with an empty body."
}

x-edoobox-runtimeMutationGuard

false

x-edoobox-get-effect

"business-mutation"

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": "get_v2_auth_oauth2_microsoft_calendar_redirect",
  "summary": "Microsoft-Supportkalender-Verbindung abschließen",
  "description": "Verarbeitet ausschließlich den Microsoft-Rückruf aus der zuvor gestarteten Support-Anmeldung und speichert die Kalender-Verbindung für die gebundene Support-Sitzung. state ist ein einmaliger, zehn Minuten gültiger 64-stelliger Hex-Wert mit serverseitiger Browser-Cookie-Bindung; aktuelle Rechte bzw. Support-Sitzung werden erneut geprüft. Query-code und Query-state werden auch beim POST-Alias verwendet. Abschließend folgt eine Browser-Weiterleitung; kein freier Konto- oder Token-Import.",
  "tags": [
    "auth"
  ],
  "security": [],
  "parameters": [
    {
      "name": "code",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "description": "Microsoft-Autorisierungscode; nur aus dem vorherigen Browser-Ablauf."
      },
      "description": "Fehlender oder ungültiger Code führt zur Fehlerweiterleitung."
    },
    {
      "name": "state",
      "in": "query",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{64}$",
        "x-edoobox-sensitive": true
      },
      "description": "Einmaliger browsergebundener OAuth-State."
    }
  ],
  "responses": {
    "200": {
      "description": "Browser-Weiterleitung zur Mail- bzw. Supportansicht mit Erfolgs-/Fehlerstatus."
    },
    "302": {
      "description": "Browser-Weiterleitung zum Folgeschritt oder zur Fehleransicht.",
      "headers": {
        "Location": {
          "schema": {
            "type": "string",
            "format": "uri"
          },
          "description": "Vom Server ermittelte Zieladresse."
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "x-edoobox-auth-boundarySource": {
    "file": "application/models/v2/auth/Microsoftcalendar.php",
    "line": 14,
    "reason": "Reads code/state from query for both HTTP methods, validates the OAuth state through the provider handler, and writes a Location redirect with an empty body."
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "business-mutation",
  "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

: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${QUERY_STATE:?QUERY_STATE setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/auth/oauth2/microsoft_calendar/redirect' \
  --url-query 'state='"${QUERY_STATE}"

JavaScript

const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/auth/oauth2/microsoft_calendar/redirect";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
url.searchParams.append("state", required("QUERY_STATE"));
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/oauth2/microsoft_calendar/redirect"
url = os.environ["API_ORIGIN"].rstrip("/") + path
url += "?" + urllib.parse.urlencode([("state", os.environ["QUERY_STATE"])])
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/oauth2/microsoft_calendar/redirect";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
url.searchParams.append("state", required("QUERY_STATE"));
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/oauth2/microsoft_calendar/redirect"
url = os.environ["API_ORIGIN"].rstrip("/") + path
url += "?" + urllib.parse.urlencode([("state", os.environ["QUERY_STATE"])])
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.