Method: projects.locations.clusters.generateClientCertificate

Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.

HTTP request

POST https://alloydb.googleapis.com/v1/{parent=projects/*/locations/*/clusters/*}:generateClientCertificate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location}/clusters/{cluster}

Authorization requires the following IAM permission on the specified resource parent:

  • alloydb.clusters.generateClientCertificate

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestId": string,
  "certDuration": string,
  "publicKey": string
}
Fields
requestId

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

certDuration

string (Duration format)

Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

publicKey

string

Optional. The public key from the client.

Response body

Message returned by a clusters.generateClientCertificate operation.

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

JSON representation
{
  "pemCertificateChain": [
    string
  ],
  "caCert": string
}
Fields
pemCertificateChain[]

string

Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.

caCert

string

Optional. The pem-encoded cluster ca X.509 certificate.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.