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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eThis API endpoint, \u003ccode\u003eprojects.locations.instances.generateCollectionAgentAuth\u003c/code\u003e, creates an authentication JSON file for a collection agent.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a \u003ccode\u003ePOST\u003c/code\u003e operation to a specific URL format that includes a required \u003ccode\u003ename\u003c/code\u003e path parameter specifying the Chronicle instance.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this operation must be empty, and a successful response will contain the auth JSON file in a specified structure.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this endpoint requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope and the \u003ccode\u003echronicle.instances.generateCollectionAgentAuth\u003c/code\u003e IAM permission.\u003c/p\u003e\n"]]],[],null,["# Method: instances.generateCollectionAgentAuth\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.GenerateCollectionAgentAuthResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\n**Full name**: projects.locations.instances.generateCollectionAgentAuth\n\ninstances.generateCollectionAgentAuth generates an auth json file for the collection agent.\n\n### HTTP request\n\nChoose a location: \nafrica-south1 asia-northeast1 asia-south1 asia-southeast1 asia-southeast2 australia-southeast1 europe-west12 europe-west2 europe-west3 europe-west6 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast2 southamerica-east1 us eu \n\n\u003cbr /\u003e\n\n### Path parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse with a generated collection agent auth json file.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `chronicle.instances.generateCollectionAgentAuth`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
