user_licenses

Creates, updates, deletes, gets or lists a user_licenses resource.

Overview

Name	user_licenses
Type	Resource
Id	google.discoveryengine.user_licenses

Fields

The following fields are returned by SELECT queries:

projects_locations_user_stores_user_licenses_list

Successful response

Name	Datatype	Description
createTime	string (google-datetime)	Output only. User created timestamp.
lastLoginTime	string (google-datetime)	Output only. User last logged in time. If the user has not logged in yet, this field will be empty.
licenseAssignmentState	string	Output only. License assignment state of the user. If the user is assigned with a license config, the user login will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user;
licenseConfig	string	Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user.
updateTime	string (google-datetime)	Output only. User update timestamp.
userPrincipal	string	Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal.
userProfile	string	Optional. The user profile. We user user full name(First name + Last name) as user profile.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_user_stores_user_licenses_list	select	projectsId, locationsId, userStoresId	pageSize, pageToken, filter	Lists the User Licenses.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
userStoresId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

projects_locations_user_stores_user_licenses_list

Lists the User Licenses.

SELECT
createTime,
lastLoginTime,
licenseAssignmentState,
licenseConfig,
updateTime,
userPrincipal,
userProfile
FROM google.discoveryengine.user_licenses
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND userStoresId = '{{ userStoresId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';