Method: customFields.patch

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• IAM Permissions

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

Update a CustomField.

HTTP request

Choose a location:

africa-south1 asia-northeast1 asia-south1 asia-southeast1 asia-southeast2 australia-southeast1 europe-central2 europe-west12 europe-west2 europe-west3 europe-west6 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast2 southamerica-east1 us eu

PATCH https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{customField.name}

Path parameters

Parameters
customField.name	string Identifier. The unique name(ID) of the CustomField. Format: projects/{project}/locations/{location}/instances/{instance}/customFields/{customField}

Query parameters

Parameters
updateMask	string (FieldMask format) Optional. The list of fields to update. If not included, all fields will be updated (effectively a full replacement). Mutable fields: displayName, type, scopes, type_options, description. 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 CustomField.

Response body

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

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.customFields.update

For more information, see the IAM documentation.