search_workspace_people

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

Verhalten und Grenzen

Sucht im Google-Workspace-Verzeichnis freigegebener Google-Konten. Bei privaten Google-Konten ist das Ergebnis leer. Verzeichnisdaten werden niemals geschrieben.

Berechtigungen

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

contacts:read

Freigaben und Grenzen

Eingabe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "limit": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 30
    }
  },
  "required": [
    "query",
    "limit"
  ],
  "additionalProperties": false
}

Ausgabe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contacts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "accountId": {
            "type": "string"
          },
          "accountName": {
            "type": "string"
          },
          "provider": {
            "type": "string"
          },
          "contact": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "displayName": {
                "type": "string"
              },
              "givenName": {
                "type": "string"
              },
              "familyName": {
                "type": "string"
              },
              "emailAddresses": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "phoneNumbers": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "organization": {
                "type": "string"
              },
              "jobTitle": {
                "type": "string"
              },
              "writable": {
                "type": "boolean"
              },
              "updatedAt": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "displayName",
              "emailAddresses",
              "phoneNumbers",
              "writable"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "accountId",
          "accountName",
          "provider",
          "contact"
        ],
        "additionalProperties": false
      }
    },
    "truncated": {
      "type": "boolean"
    },
    "ausgeschlossen": {
      "type": "object",
      "properties": {
        "andereOrganisation": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "arbeitGesperrt": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "inaktivesKonto": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "providerNichtUnterstuetzt": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "scopeFehlt": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "tenantUnbekannt": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "andereOrganisation",
        "arbeitGesperrt",
        "inaktivesKonto",
        "providerNichtUnterstuetzt",
        "scopeFehlt",
        "tenantUnbekannt"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "contacts",
    "truncated",
    "ausgeschlossen"
  ],
  "additionalProperties": false
}

Fehler und Wiederholungen

Prüfe das Werkzeugergebnis auf Fehler. Wiederhole Schreiboperationen nicht blind nach einem Timeout. Prüfe zuerst den Kalenderzustand.

Fehlerbehandlung