Method: projects.locations.userStores.patch

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• IAM Permissions

Updates the User Store.

HTTP request

PATCH https://discoveryengine.googleapis.com/v1alpha/{userStore.name=projects/*/locations/*/userStores/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userStore.name	string Immutable. The full resource name of the User Store, in the format of projects/{project}/locations/{location}/userStores/{userStore}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Query parameters

Parameters
updateMask	string (FieldMask format) Optional. The list of fields to update. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of UserStore.

Response body

If successful, the response body contains an instance of UserStore.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

• discoveryengine.userStores.update

For more information, see the IAM documentation.