Method: projects.locations.userStores.userLicenses.list

Lists the User Licenses.

HTTP request

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/userStores/*}/userLicenses

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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.

Request body

The request body must be empty.

Response body

Response message for UserLicenseService.ListUserLicenses.

If successful, the response body contains data with the following structure:

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

object (UserLicense)

All the customer's UserLicenses.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.userStores.listUserLicenses

For more information, see the IAM documentation.