Get licenses for Gemini Enterprise

This page describes how to get subscriptions for Gemini Enterprise and assign licenses to your users.

About licenses

To sign in to the Gemini Enterprise app, a user must have a license. Licenses can be assigned to users manually or automatically.

  • Manually-assigned licenses: You can add users by their email address.

  • Automatically-assigned licenses: You can choose to have licenses that are part of a subscription be automatically assigned to a user the first time they access the Gemini Enterprise or the NotebookLM Enterprise interface.

Licenses are specific to multi-region. For example, if users want access to apps in both the us multi-region and global, assign them a license in each.

About subscriptions

To get licenses, you must first have a subscription to a Gemini Enterprise edition. For information about available editions, see Compare editions of Gemini Enterprise.

Subscriptions are specific to regions. Users who create apps in the global region need licenses from a global subscription. Similarly, users who need to keep their apps and data in the European Union need licenses from an eu subscription.

For Gemini Enterprise, you can buy a monthly subscription or a year-long subscription. These subscriptions can be set to renew automatically.

Before you begin

Before starting the procedures on this page, make sure that:

  • You have completed the tasks on the Set up Gemini Enterprise. This includes, setting up a billing account for your project, and granting at least the Discovery Engine User role to any users who you'll license to use Gemini Enterprise.

  • You have the Discovery Engine Admin role.

Get a subscription

To get a Gemini Enterprise subscription, do the following:

  1. In the Google Cloud console, go to the Gemini Enterprise page.

    Gemini Enterprise

  2. Click Manage subscriptions > Create subscription.

  3. On the edition you want to subscribe to, click Subscribe.

  4. Configure the Billing details:

    1. Select the Billing account from the drop-down.

    2. Enter a Subscription name.

    3. Enter the Number of licenses you need for the edition.

  5. Select the Subscription period.

  6. If you want the subscription to renew automatically, select Auto renew subscription.

  7. Configure the Distribution details:

    1. In the Select a project drop-down, select your project.

    2. Choose a Location type for your subscription. If you don't have compliance or regulatory reasons to locate your data in the US or EU multi-regions, Google recommends that you choose the global multi-region for maximum availability and low latency.

  8. Click Create > Confirm.

Update subscription settings

After you create a subscription, you can update the settings, such as the license count or the auto-renewal setting.

  1. In the Google Cloud console, go to the Gemini Enterprise page.

    Gemini Enterprise

  2. Click Manage subscriptions.

  3. Click the subscription you want to update from the Gemini Subscriptions table.

  4. Click Edit next to Subscription details.

  5. Update the license count or turn on or turn off auto renewal.

  6. Click Submit.

Add users and manually assign them licenses

To give specific users access to Gemini Enterprise, you can manually assign them licenses from an active subscription.

Console

To manually assign licenses to users, do the following:

  1. In the Google Cloud console, go to the Gemini Enterprise page.

    Gemini Enterprise

  2. Click Manage users.

  3. Select the Multi-region of the existing license.

  4. Click Add users.

  5. On the Add users page:

    1. Enter the email addresses of the users. Make sure to use the same email address that they'll use to sign in to the Gemini Enterprise app.

    2. Select the subscription to assign to those users.

    3. Click Submit.

REST

To manually assign licenses to users, run the following command:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/userStores/default_user_store:batchUpdateUserLicenses" \
-d '{
  {
   "inlineSource":{
      "userLicenses":[
         {
            "userPrincipal":"USER_EMAIL_1",
            "licenseConfig":"projects/PROJECT_NUMBER/locations/global/licenseConfigs/SUBSCRIPTION_ID"
         },
         {
            "userPrincipal":"USER_EMAIL_2",
            "licenseConfig":"projects/PROJECT_NUMBER/locations/global/licenseConfigs/SUBSCRIPTION_ID"
         }
      ],
      "updateMask":{
         "paths":[
            "userPrincipal",
            "licenseConfig"
         ]
      }
   },
   "deleteUnassignedUserLicenses":false
}
}'

Replace the following:

  • PROJECT_ID: the ID of your project.
  • ENDPOINT_LOCATION: the multi-region for your API request. Assign one of the following values:
    • us- for the US multi-region
    • eu- for the EU multi-region
    • global- for the Global location
    For more information, see Specify a multi-region for your data store.
  • LOCATION: the multi-region of your data store: global, us or eu
  • USER_EMAIL: the email address of the user you want to add to the license.
  • PROJECT_NUMBER: the number of your Google Cloud project.
  • SUBSCRIPTION_ID: The ID of your Gemini Enterprise subscription.

Add users and assign them licenses automatically

To assign licenses to users automatically when they sign in to the Gemini Enterprise app, do the following:

  1. In the Google Cloud console, go to the Gemini Enterprise page.

    Gemini Enterprise

  2. Click Manage users.

  3. Select the Multi-region of the existing license.

  4. Select Assign licenses automatically and then select the subscription.

    A license from this subscription is assigned each time a user who doesn't have a manually-assigned license signs in. If no licenses remain in the subscription, users are shown a message notifying them that they don't have access.

    For more information about subscriptions, see the About subscriptions section.

Transfer licenses from expired subscriptions

Users can't sign in to Gemini Enterprise if the subscription has expired. There are a couple of approaches to returning sign-in access to them:

Automatically transfer users to an active subscription

To automatically transfer users to an active subscription, do the following:

  1. In the Google Cloud console, go to the Gemini Enterprise > Manage users page.

    Gemini Enterprise License

  2. Select the Multi-region of the existing license.

  3. Make sure that you have an active subscription. If you don't have one, get a subscription.

  4. Select Assign licenses automatically and choose the active subscription.

  5. Select Automatically update expired license.

    When a user with an expired license next signs in, they are automatically granted a license in the chosen subscription.

Manually transfer users to an active subscription

To manually transfer users to an active subscription, do the following:

  1. In the Google Cloud console, go to the Gemini Enterprise > Manage users page.

    Gemini Enterprise License

  2. Select the Multi-region of the existing license.

  3. Make sure that you have an active subscription. If you don't have one, get a subscription.

  4. Select the users and click Assign different license.

  5. In the Edit Users pane, select the subscription and click Submit.

List the licenses

To list the licenses and the users assigned to them, run the following command:

REST

curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/userStores/default_user_store/userLicenses"

Replace the following:

  • PROJECT_ID: the ID of your project.
  • ENDPOINT_LOCATION: the multi-region for your API request. Assign one of the following values:
    • us- for the US multi-region
    • eu- for the EU multi-region
    • global- for the Global location
    For more information, see Specify a multi-region for your data store.
  • LOCATION: the multi-region of your data store: global, us or eu

Remove users from a license

To remove users from a license, do the following:

Console

To remove users from a license using the Google Cloud console, do the following:

  1. In the Google Cloud console, go to the Gemini Enterprise > Manage users page.

    Gemini Enterprise License

  2. Select the Multi-region of the existing license.

  3. In the users table, select the users.

  4. To remove users from a license, choose one of the following:

    • To only remove the license from the selected users, click Unassign license.
    • To remove the license and also delete the selected users from the project, click Unassign and delete license.
  5. Click Confirm.

REST

To remove users from a license, run the following command:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/userStores/default_user_store:batchUpdateUserLicenses" \
-d '{
  {
   "inlineSource":{
      "userLicenses":[
         {
            "userPrincipal":";USER_EMAIL_1"
         },
         {
            "userPrincipal":"USER_EMAIL_2"
         }
      ],
      "updateMask":{
         "paths":[
            "userPrincipal",
            "licenseConfig"
         ]
      }
   },
   "deleteUnassignedUserLicenses":true
}
}'

Replace the following:

  • PROJECT_ID: the ID of your project.
  • ENDPOINT_LOCATION: the multi-region for your API request. Assign one of the following values:
    • us- for the US multi-region
    • eu- for the EU multi-region
    • global- for the Global location
    For more information, see Specify a multi-region for your data store.
  • LOCATION: the multi-region of your data store: global, us or eu
  • USER_EMAIL: the email address of the user you want to remove from the license.

What's next