projects

Changed on

Updates the parameters of a single User.

patch/v1/{+name}

Request

  • Base URL: https://alloydb.googleapis.com
  • URL: https://alloydb.googleapis.com/v1/{+name}
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)

Path parameters

namestring required

Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.

Query parameters

allowMissingboolean

Optional. Allow missing fields in the update mask.

requestIdstring

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

updateMaskstring

Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

validateOnlyboolean

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

Request body

databaseRolesstring[]

Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions.

keepExtraRolesboolean

Input only. If the user already exists and it has additional roles, keep them granted.

namestring

Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.

passwordstring

Input only. Password for the user.

userType'USER_TYPE_UNSPECIFIED' | 'ALLOYDB_BUILT_IN' | 'ALLOYDB_IAM_USER' | 'ALLOYDB_IAM_GROUP' | 'ALLOYDB_IAM_GROUP_USER' | 'ALLOYDB_IAM_GROUP_SERVICE_ACCOUNT'

Optional. Type of this user.

Response

Successful response

Changes

  • 75052c733176Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

  • 0cbe49764d89Revision changes
    • warning

      added the new ALLOYDB_IAM_GROUP enum value to the response property for the response status

    • warning

      added the new ALLOYDB_IAM_GROUP_SERVICE_ACCOUNT enum value to the response property for the response status

    • warning

      added the new ALLOYDB_IAM_GROUP_USER enum value to the response property for the response status

    • info

      added the new ALLOYDB_IAM_GROUP enum value to the request property

    • info

      added the new ALLOYDB_IAM_GROUP_SERVICE_ACCOUNT enum value to the request property

    • info

      added the new ALLOYDB_IAM_GROUP_USER enum value to the request property