Method: instances.generateWorkspaceConnectionToken

Full name: projects.locations.instances.generateWorkspaceConnectionToken

Generates a token that can be used to connect a workspace customer to a chronicle instance

HTTP request

POST https://chronicle.googleapis.com/v1alpha/{name}:generateWorkspaceConnectionToken

Path parameters

Parameters
name

string

Required. The name of the chronicle instance to create workspace token for. Format: projects/{project_id}/locations/{region}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "expire_time": string,
  "workspace_customer_id": string
}
Fields
expire_time

string (Timestamp format)

Required. The expiry time for the token.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
workspace_customer_id

string

Required. The workspace customer id for which the token should be crated

Response body

Response with a workspace connection token.

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

JSON representation 
{
  "token": string
}
Fields
token

string

Required. The created token.

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.generateWorkspaceConnectionToken

For more information, see the IAM documentation.