Codebeispiele für die Connectors API

Informationen zu API-Funktionen finden Sie unter Connectors API.

Für alle Anfragen auf dieser Seite werden die folgenden Variablen verwendet:

• $TOKEN – OAuth 2.0-Token
• $CUSTOMER – ID des Kunden oder Literal my_customer
• $PAGE_TOKEN: Das Seitentoken, das aus den Antworten der vorherigen Seite abgerufen wurde.
• $CONNECTOR_CONFIG_ID: ID der Connector-Konfiguration. Generierte IDs haben die Form von UUIDs in Großbuchstaben (z. B. 550E8400-E29B-41D4-A716-446655440000).

Connector-Konfigurationen auflisten

Verwenden Sie die Methode list, um die Connector-Konfigurationen für Ihre Kundendomäne aufzulisten. Optional können Sie die Abfrageparameter page_size (oder pageSize) und page_token (oder pageToken) angeben, wenn Sie die Ergebnisse paginieren:

• page_size / pageSize: Die maximale Anzahl der zurückzugebenden Connector-Konfigurationen. Die Standardseitengröße ist 50, sofern nicht anders angegeben, und hat ein Maximum von 100.
• page_token / pageToken: Ein Seitentoken, das von einem vorherigen list-Aufruf empfangen wurde.

Anfrage

curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/connectorConfigs?page_size=50&page_token=$PAGE_TOKEN"

Antwort

{
  "connectorConfigs": [
    {
      "name": "customers/my_customer/connectorConfigs/550E8400-E29B-41D4-A716-446655440000",
      "displayName": "Configuration 1",
      "type": "REPORTING",
      "details": {
        "googleSecOpsConfig": {
          "host": "example.googlesecops.com",
          "reportingSettings": {
            "enabledDefaultEvents": [
              "ALL_DEFAULT_EVENTS"
            ],
            "enabledOptInEvents": [
              "PASSWORD_BREACH_EVENT",
              "URL_NAVIGATION_EVENT"
            ],
            "enabledDeviceEvents": [
              "ALL_DEVICE_EVENTS"
            ]
          }
        }
      },
      "status": {
        "state": "ENABLED"
      }
    }
  ],
  "nextPageToken": "<next_page_token>"
}

Connectorkonfiguration abrufen

Verwenden Sie die Methode get, um eine bestimmte Connector-Konfiguration anhand der ID abzurufen.

Anfrage

curl -X GET \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/connectorConfigs/$CONNECTOR_CONFIG_ID"

Antwort

{
  "name": "customers/my_customer/connectorConfigs/550E8400-E29B-41D4-A716-446655440000",
  "displayName": "Configuration 1",
  "type": "REPORTING",
  "details": {
    "googleSecOpsConfig": {
      "host": "example.googlesecops.com",
      "reportingSettings": {
        "enabledDefaultEvents": [
          "ALL_DEFAULT_EVENTS"
        ],
        "enabledOptInEvents": [
          "PASSWORD_BREACH_EVENT",
          "URL_NAVIGATION_EVENT"
        ],
        "enabledDeviceEvents": [
          "ALL_DEVICE_EVENTS"
        ]
      }
    }
  },
  "status": {
    "state": "ENABLED"
  }
}

Connectorkonfiguration erstellen

Verwenden Sie die Methode create, um eine neue Connector-Konfiguration für die Kundendomain zu erstellen. Optional können Sie eine benutzerdefinierte ID angeben, indem Sie den Abfrageparameter connector_config_id (oder connectorConfigId) festlegen. Wenn keine ID angegeben ist, wird vom Server eine UUID in Großbuchstaben generiert.

Anfrage

curl -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Configuration 1",
    "type": "REPORTING",
    "details": {
      "googleSecOpsConfig": {
        "apiKey": "api-key",
        "host": "example.googlesecops.com",
        "reportingSettings": {
          "enabledDefaultEvents": [
            "ALL_DEFAULT_EVENTS"
          ],
          "enabledOptInEvents": [
            "PASSWORD_BREACH_EVENT"
          ],
          "enabledDeviceEvents": [
            "ALL_DEVICE_EVENTS"
          ]
        }
      }
    }
  }' \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/connectorConfigs?connector_config_id=$CONNECTOR_CONFIG_ID"

Antwort

{
  "name": "customers/my_customer/connectorConfigs/550E8400-E29B-41D4-A716-446655440000",
  "displayName": "Configuration 1",
  "type": "REPORTING",
  "details": {
    "googleSecOpsConfig": {
      "host": "example.googlesecops.com",
      "reportingSettings": {
        "enabledDefaultEvents": [
          "ALL_DEFAULT_EVENTS"
        ],
        "enabledOptInEvents": [
          "PASSWORD_BREACH_EVENT"
        ],
        "enabledDeviceEvents": [
          "ALL_DEVICE_EVENTS"
        ]
      }
    }
  },
  "status": {
    "state": "ENABLED"
  }
}

Connector-Konfiguration aktualisieren

Eine Connector-Konfiguration kann auf eine der folgenden Arten aktualisiert werden:

• Keine Aktualisierungsmaske: Wenn kein updateMask-Abfrageparameter angegeben ist, werden alle in der Anfrage festgelegten Felder aktualisiert.
• Mit Aktualisierungsmaske: Wenn ein updateMask-Abfrageparameter angegeben ist, werden nur die in der Maske aufgeführten Felder aktualisiert.
• Mit Aktualisierungsmaske, die * entspricht: Wenn updateMask auf * festgelegt ist, wird die Aktualisierung als vollständiger Ersatz (entspricht „Erstellen“) behandelt.

Beispiel 1: Aktualisierungsmaske, die nur auf displayName ausgerichtet ist

Wenn Sie bei dieser Option updateMask=displayName angeben, wird nur displayName aktualisiert, auch wenn im Textkörper zusätzliche Felder angegeben sind.

Anfrage

curl -X PATCH \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Updated name"
  }' \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/connectorConfigs/$CONNECTOR_CONFIG_ID?updateMask=displayName"

Antwort

{
  "name": "customers/my_customer/connectorConfigs/550E8400-E29B-41D4-A716-446655440000",
  "displayName": "Updated name",
  "type": "REPORTING",
  "details": {
    "googleSecOpsConfig": {
      "host": "example.googlesecops.com",
      "reportingSettings": {
        "enabledDefaultEvents": [
          "BROWSER_EXTENSION_INSTALL_EVENT"
        ],
        "enabledOptInEvents": [
          "PASSWORD_BREACH_EVENT"
        ],
        "enabledDeviceEvents": [
          "LOGIN_LOGOUT_EVENT"
        ]
      }
    }
  },
  "status": {
    "state": "ENABLED"
  }
}

Beispiel 2: Keine Aktualisierungsmaske (alle Felder in der Anfrage werden aktualisiert)

Wenn updateMask im Abfragestring der Anfrage weggelassen wird, werden alle in der JSON-Nutzlast angegebenen Felder aktualisiert.

Anfrage

curl -X PATCH \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Updated again",
    "details": {
      "googleSecOpsConfig": {
        "reportingSettings": {
          "enabledDefaultEvents": [
            "BROWSER_EXTENSION_INSTALL_EVENT",
            "CONTENT_TRANSFER_EVENT",
            "CONTENT_UNSCANNED_EVENT",
            "DATA_ACCESS_CONTROL_EVENT",
            "MALWARE_TRANSFER_EVENT"
          ]
        }
      }
    }
  }' \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/connectorConfigs/$CONNECTOR_CONFIG_ID"

Antwort

{
  "name": "customers/my_customer/connectorConfigs/550E8400-E29B-41D4-A716-446655440000",
  "displayName": "Updated again",
  "type": "REPORTING",
  "details": {
    "googleSecOpsConfig": {
      "host": "example.googlesecops.com",
      "reportingSettings": {
        "enabledDefaultEvents": [
          "BROWSER_EXTENSION_INSTALL_EVENT",
          "CONTENT_TRANSFER_EVENT",
          "CONTENT_UNSCANNED_EVENT",
          "DATA_ACCESS_CONTROL_EVENT",
          "MALWARE_TRANSFER_EVENT"
        ],
        "enabledOptInEvents": [
          "PASSWORD_BREACH_EVENT"
        ],
        "enabledDeviceEvents": [
          "ALL_DEVICE_EVENTS"
        ]
      }
    }
  },
  "status": {
    "state": "ENABLED"
  }
}

Beispiel 3: Aktualisierungsmaske * (vollständiger Ersatz)

Wenn Sie updateMask=* festlegen, wird die vorhandene Konfiguration vollständig durch die Nutzlast im Anfragetext ersetzt.

Anfrage

curl -X PATCH \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "New Updated Display Name",
    "type": "REPORTING",
    "details": {
      "googleSecOpsConfig": {
        "apiKey": "api-key",
        "host": "example.googlesecops.com",
        "reportingSettings": {
          "enabledOptInEvents": [
            "PASSWORD_BREACH_EVENT"
          ]
        }
      }
    }
  }' \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/connectorConfigs/$CONNECTOR_CONFIG_ID?updateMask=*"

Antwort

{
  "name": "customers/my_customer/connectorConfigs/550E8400-E29B-41D4-A716-446655440000",
  "displayName": "New Updated Display Name",
  "type": "REPORTING",
  "details": {
    "googleSecOpsConfig": {
      "host": "example.googlesecops.com",
      "reportingSettings": {
        "enabledOptInEvents": [
          "PASSWORD_BREACH_EVENT"
        ]
      }
    }
  },
  "status": {
    "state": "ENABLED"
  }
}

Connector-Konfiguration löschen

Verwenden Sie zum Löschen einer Connector-Konfiguration die Methode delete.

Anfrage

curl -X DELETE \
  -H "Authorization: Bearer $TOKEN" \
  "https://chromemanagement.googleapis.com/v1/customers/$CUSTOMER/connectorConfigs/$CONNECTOR_CONFIG_ID"

Antwort

{}