Method: instances.generateCollectionAgentAuth

Full name: projects.locations.instances.generateCollectionAgentAuth

instances.generateCollectionAgentAuth generates an auth json file for the collection agent.

HTTP request


Path parameters

Parameters
name

string

Required. The name of the chronicle instance to generate a collection agent auth json file for. Format: projects/{projectId}/locations/{location}/instances/{instance}

Request body

The request body must be empty.

Response body

Response with a generated collection agent auth json file.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "authJson": string
}
Fields
authJson

string

The auth json file.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.instances.generateCollectionAgentAuth

For more information, see the IAM documentation.