Method: uniqueEntities.patch

Full name: projects.locations.instances.uniqueEntities.patch

Updates properties of a unique entity. Allows modifying attributes like suspicious status or custom key-value properties. Updating properties might trigger updates across related systems that use this entity information.

HTTP request


PATCH https://chronicle.africa-south1.rep.googleapis.com/v1beta/{uniqueEntity.name}

Path parameters

Parameters
uniqueEntity.name

string

Identifier. The unique name of the entity.

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The list of fields to update. If not included, all fields with default/non-default values will be overwritten.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of UniqueEntity.

Response body

If successful, the response body contains an instance of UniqueEntity.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/chronicle
  • https://www.googleapis.com/auth/chronicle.readonly

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.uniqueEntities.update

For more information, see the IAM documentation.