setup_status

Diese Referenz wird aus dem veröffentlichten Werkzeugvertrag erzeugt. Feldnamen und normative Beschreibungen im Schema sind Englisch.

Verhalten und Grenzen

Meldet zusammengefassten Einrichtungsstand und nächsten Schritt. Bei einer externen reinen OAuth-Postfachfreigabe liefert mailboxes.total die Zahl erreichbarer aktiver Agent Mailboxes; benötigt inbox:read, kein Kalenderkonto. Sonst liefert es Kalenderkonten nach Anbieter und Status sowie Sync-Anzahlen und benötigt calendar:read. nextStepUrl führt zur passenden Seite in Ridian; bei fertiger Einrichtung ist es null. Keine Kalendernamen, Termintitel oder E-Mail-Adressen. Nur lesend. Konten werden in der App verbunden oder erneut verbunden; ein erster Sync kann dort oder mit preview_sync und create_sync angelegt werden.

Berechtigungen

Freigegebene Scopes, Konten, Kalender und Sichtbarkeitsregeln begrenzen den Zugriff. Ein Workspace-Admin erhält dadurch keinen pauschalen Zugriff auf fremde Konten.

calendar:read

Freigaben und Grenzen

Eingabe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Ausgabe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "accounts": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number"
        },
        "active": {
          "type": "number"
        },
        "authError": {
          "type": "number"
        },
        "disabled": {
          "type": "number"
        },
        "byProvider": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "provider": {
                "type": "string"
              },
              "active": {
                "type": "number"
              },
              "authError": {
                "type": "number"
              },
              "disabled": {
                "type": "number"
              }
            },
            "required": [
              "provider",
              "active",
              "authError",
              "disabled"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "total",
        "active",
        "authError",
        "disabled",
        "byProvider"
      ],
      "additionalProperties": false
    },
    "syncs": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number"
        },
        "active": {
          "type": "number"
        },
        "paused": {
          "type": "number"
        },
        "error": {
          "type": "number"
        },
        "deleting": {
          "type": "number"
        }
      },
      "required": [
        "total",
        "active",
        "paused",
        "error",
        "deleting"
      ],
      "additionalProperties": false
    },
    "mailboxes": {
      "type": "object",
      "properties": {
        "total": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "total"
      ],
      "additionalProperties": false
    },
    "assistantGrant": {
      "type": "object",
      "properties": {
        "granted": {
          "type": "boolean",
          "const": true
        }
      },
      "required": [
        "granted"
      ],
      "additionalProperties": false
    },
    "nextStep": {
      "type": "string",
      "enum": [
        "connect_first_account",
        "reconnect_account",
        "create_first_sync",
        "ready",
        "open_mailbox"
      ]
    },
    "nextStepUrl": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "assistantGrant",
    "nextStep",
    "nextStepUrl"
  ],
  "additionalProperties": false
}

Fehler und Wiederholungen

Prüfe das Werkzeugergebnis auf Fehler. Wiederhole Schreiboperationen nicht blind nach einem Timeout. Prüfe zuerst den aktuellen Ressourcen- oder Sendestatus.

Fehlerbehandlung