Method: projects.locations.userStores.batchUpdateUserLicenses

Updates the User License. This method is used for batch assign/unassign licenses to users.

HTTP request

POST https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/userStores/*}:batchUpdateUserLicenses

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent [UserStore][] resource name, format: projects/{project}/locations/{location}/userStores/{userStoreId}.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "deleteUnassignedUserLicenses": boolean,

  // Union field source can be only one of the following:
  "inlineSource": {
    object (InlineSource)
  }
  // End of list of possible types for union field source.
}
Fields
deleteUnassignedUserLicenses

boolean

Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state.
Union field source. Required. The source of the input. source can be only one of the following:
inlineSource

object (InlineSource)

The inline source for the input content for document embeddings.

Response body

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

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 parent resource:

  • discoveryengine.userStores.batchUpdateUserLicenses

For more information, see the IAM documentation.

InlineSource

The inline source for the input config for userStores.batchUpdateUserLicenses method.

JSON representation 
{
  "userLicenses": [
    {
      object (UserLicense)
    }
  ],
  "updateMask": string
}
Fields
userLicenses[]

object (UserLicense)

Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal.
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".