Class UserStore (0.20.1)

0.20.1 (latest) 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.12 0.12.3 0.11.14 0.10.0 0.9.1 0.8.1 0.7.0 0.6.0 0.5.0 0.4.1 0.3.1 0.2.1 0.1.1

UserStore(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configures metadata that is used for End User entities.

Attributes
Name	Description
name	str Immutable. The full resource name of the User Store, in the format of projects/{project}/locations/{location}/userStores/{user_store}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
display_name	str The display name of the User Store.
default_license_config	str 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 license_assignment_tier_rules is not configured.
enable_license_auto_register	bool 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.
enable_expired_license_auto_update	bool 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.