Method: projects.locations.userStores.userLicenses.export

Exports all the UserLicenses under the parent UserStore as a single CSV document. This is the backend for the admin console "Download as CSV" action: it reuses the userLicenses.list read path so admins can sort/filter offline in Excel or Sheets.

The response carries the full CSV (header row followed by data rows) inline in ExportUserLicensesResponse.csv_data.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent UserStore resource name, format: projects/{project}/locations/{location}/userStores/{userStoreId}. All UserLicenses under this UserStore are exported.

Request body

The request body must be empty.

Response body

Response message for UserLicenseService.ExportUserLicenses.

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

JSON representation 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "csvData": string
  // End of mutually exclusive fields.
}
Fields
The exported result. M1 returns the CSV inline in csv_data; the oneof leaves room for a future large-export variant (e.g. a GCS URI) without breaking the contract. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
csvData

string (bytes format)

The full CSV document as raw bytes: the header row followed by one row per UserLicense. Contains user license data (e.g. user emails). An export with no matching licenses contains only the header row.

A base64-encoded string.
End of mutually exclusive fields.

Authorization scopes

Requires one of the following OAuth scopes:

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

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.