REST Resource: projects.locations.userStores

Resource: UserStore

Configures metadata that is used for End User entities.

JSON representation 
{
  "name": string,
  "displayName": string,
  "defaultLicenseConfig": string,
  "enableLicenseAutoRegister": boolean,
  "enableExpiredLicenseAutoUpdate": boolean
}
Fields
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.
displayName

string

The display name of the User Store.
defaultLicenseConfig

string

Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription.

If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if licenseAssignmentTierRules is not configured.
enableLicenseAutoRegister

boolean

Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
enableExpiredLicenseAutoUpdate

boolean

Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.

Methods

batchUpdateUserLicenses

 Updates the User License.

create

 Creates a new User Store.

delete

 Deletes the User Store.

get

 Gets the User Store.

patch

 Updates the User Store.