Method: uniqueEntities.addNote

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

Adds a comment or note to a unique entity. Use this method to record observations or findings related to a specific entity for future investigation or collaboration.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/uniqueEntities:addNote

Path parameters

Parameters
parent

string

Required. Format: projects/{project}/locations/{location}/instances/{instance}/uniqueEntities

Request body

The request body contains an instance of UniqueEntityAddNote.

Response body

If successful, the response body is an empty JSON object.

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 parent resource:

  • chronicle.uniqueEntities.update

For more information, see the IAM documentation.

UniqueEntityAddNote

Request message for UniqueEntityAddNote.

JSON representation
{
  "author": string,
  "content": string,
  "entityIdentifier": string,
  "entityType": string,
  "entityEnvironment": string
}
Fields
author

string

Required. The author of the note.

content

string

Required. The content of the note.

entityIdentifier

string

Required. The entity identifier.

entityType

string

Required. The entity type.

entityEnvironment

string

Required. The entity environment.