Method: projects.locations.clusters.users.create

Creates a new User in a given project, location, and cluster.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Value for parent.

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

  • alloydb.users.create

Query parameters

Parameters
userId

string

Required. ID of the requesting object.
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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since 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 the original operation with the same request ID was received, and if so, ignores 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).
validateOnly

boolean

Optional. If set, the backend validates the request, but doesn't actually execute it.

Request body

The request body contains an instance of User.

Response body

If successful, the response body contains a newly created instance of User.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.