Mã mẫu cho Connectors API

Hãy xem bài viết API Trình kết nối để biết thông tin về các tính năng của API.

Tất cả các yêu cầu trên trang này đều sử dụng các biến sau:

  • $TOKEN – Mã thông báo OAuth 2.0
  • $CUSTOMER – Mã của khách hàng hoặc chuỗi ký tự my_customer
  • $PAGE_TOKEN – Mã trang nhận được từ các phản hồi của trang trước
  • $CONNECTOR_CONFIG_ID – Mã của cấu hình trình kết nối. Mã được tạo có dạng UUID viết hoa (ví dụ: 550E8400-E29B-41D4-A716-446655440000).

Liệt kê các cấu hình trình kết nối

Để liệt kê các cấu hình trình kết nối cho miền của khách hàng, hãy sử dụng phương thức list. Bạn có thể tuỳ ý cung cấp các tham số truy vấn page_size (hoặc pageSize) và page_token (hoặc pageToken) khi phân trang trên các kết quả:

  • page_size / pageSize: Số lượng tối đa cấu hình trình kết nối cần trả về. Kích thước trang mặc định là 50 nếu bạn không chỉ định và tối đa là 100.
  • page_token / pageToken: Mã trang nhận được từ lệnh gọi list trước đó.

Yêu cầu

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

Phản hồi

{
  "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>"
}

Nhận cấu hình trình kết nối

Để truy xuất một cấu hình trình kết nối cụ thể theo mã, hãy sử dụng phương thức get.

Yêu cầu

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

Phản hồi

{
  "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"
  }
}

Tạo cấu hình trình kết nối

Để tạo cấu hình trình kết nối mới cho miền của khách hàng, hãy sử dụng phương thức create. Bạn có thể tuỳ ý cung cấp mã tuỳ chỉnh bằng cách đặt tham số truy vấn connector_config_id (hoặc connectorConfigId). Nếu bạn không cung cấp mã, máy chủ sẽ tạo một UUID viết hoa.

Yêu cầu

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"

Phản hồi

{
  "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"
  }
}

Cập nhật cấu hình trình kết nối

Bạn có thể cập nhật cấu hình trình kết nối theo một trong những cách sau:

  • Không có mặt nạ cập nhật: Nếu bạn không cung cấp tham số truy vấn updateMask, tất cả các trường được đặt trong yêu cầu sẽ được cập nhật.
  • Có mặt nạ cập nhật: Nếu bạn chỉ định tham số truy vấn updateMask, thì chỉ các trường được liệt kê trong mặt nạ mới được cập nhật.
  • Có mặt nạ cập nhật tương ứng với *: Nếu updateMask được đặt thành *, thì bản cập nhật sẽ được coi là một bản thay thế đầy đủ (tương đương với thao tác tạo).

Ví dụ 1: Mặt nạ cập nhật chỉ nhắm đến displayName

Trong lựa chọn này, việc cung cấp updateMask=displayName sẽ đảm bảo chỉ displayName được cập nhật, ngay cả khi bạn cung cấp thêm các trường trong nội dung.

Yêu cầu

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"

Phản hồi

{
  "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"
  }
}

Ví dụ 2: Không có mặt nạ cập nhật (cập nhật tất cả các trường trong yêu cầu)

Nếu bạn bỏ qua updateMask khỏi chuỗi truy vấn yêu cầu, thì tất cả các trường được cung cấp trong tải trọng JSON sẽ được cập nhật.

Yêu cầu

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"

Phản hồi

{
  "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"
  }
}

Ví dụ 3: Mặt nạ cập nhật của * (thay thế đầy đủ)

Việc đặt updateMask=* sẽ thay thế hoàn toàn cấu hình hiện có bằng tải trọng được cung cấp trong nội dung yêu cầu.

Yêu cầu

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=*"

Phản hồi

{
  "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"
  }
}

Xoá cấu hình trình kết nối

Để xoá cấu hình trình kết nối, hãy sử dụng phương thức delete.

Yêu cầu

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

Phản hồi

{}