Required. The parent UserStore resource name, format: projects/{project}/locations/{location}/userStores/{userStoreId}.
Query parameters
Parameters
pageSize
integer
Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50.
If this field is negative, an INVALID_ARGUMENT error is returned.
pageToken
string
Optional. A page token, received from a previous userLicenses.list call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to userLicenses.list must match the call that provided the page token.
filter
string
Optional. Filter for the list request.
Supported fields:
licenseAssignmentState
Examples:
licenseAssignmentState = ASSIGNED to list assigned user licenses.
licenseAssignmentState = NO_LICENSE to list not licensed users.
licenseAssignmentState = NO_LICENSE_ATTEMPTED_LOGIN to list users who attempted login but no license assigned.
licenseAssignmentState != NO_LICENSE_ATTEMPTED_LOGIN to filter out users who attempted login but no license assigned.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[],[],null,["# Method: projects.locations.userStores.userLicenses.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListUserLicensesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n\nLists the User Licenses.\n\n### HTTP request\n\n`GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/userStores/*}/userLicenses`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for [UserLicenseService.ListUserLicenses](/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.userStores.userLicenses/list#google.cloud.discoveryengine.v1alpha.UserLicenseService.ListUserLicenses).\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `discoveryengine.userStores.listUserLicenses`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]