Method: contextProperties.list

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

Full name: projects.locations.instances.integrations.connectors.contextProperties.list

Lists all context properties for a specific parent entity. Use this method to discover all custom data points associated with a case, alert, or integration component.

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

GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{parent}/contextProperties

Path parameters

Parameters

parent

string Required. The instance to list ContextProperties for. Format: projects/{project}/locations/{location}/instances/{instance} projects/{project}/locations/{location}/instances/{instance}/cases/{case} projects/{project}/locations/{location}/instances/{instance}/cases/{case}/caseAlerts/{alert} projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/connectors/{connector} projects/{project}/locations/{location}/instances/{instance}/integrations/{integration}/jobs/{job}

Query parameters

Parameters
pageSize	integer Optional. The maximum number of ContextProperties to return. The service may return fewer than this value.
pageToken	string Optional. A page token, received from a previous contextProperties.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.
filter	string Optional. Filter to be applied over multiple ContextProperty fields.
orderBy	string Optional. The order in which items should be returned.

Request body

The request body must be empty.

Response body

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

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.contextProperties.get

For more information, see the IAM documentation.