Get licenses for Agentspace

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

About licenses

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

• Manually-assigned licenses: These belong to an individual user and are associated with the user's email address.

  Manually-assigned licenses are best for users who rely on the Agentspace app and use it often.

• Automatically-assigned licenses: You can choose to have licenses that are part of a subscription be automatically assigned to a user the first time that the user accesses the Agentspace or the NotebookLM Enterprise interface. This is a way to distribute licenses in bulk without having to assign licenses to each individual separately.

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

You buy licenses by the subscription. A subscription must contain at least 25 licenses.

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 Agentspace, you can buy a monthly subscription, a year-long subscription, or a three-year subscription. These subscriptions can be set to renew automatically.

Licenses correspond to Agentspace editions. For information about available editions, see Compare editions of Agentspace.

Note: The Agentspace Enterprise Search subscription is deprecated. You can continue to use the subscriptions that you have but you can't buy more.

Before you begin

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

• You have completed the tasks on the Set up Agentspace. This includes granting at least the Discovery Engine User role to any users who you'll license to use Agentspace.

• You have the Discovery Engine Admin role.

Get a subscription

To get a subscription for Agentspace user, do the following:

1. In the Google Cloud console, go to the Agentspace page.

   Agentspace

2. Go to the Settings > License page.

3. Choose a Region 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 region for maximum availability and low latency.

4. Click Add subscription.

5. On the Add a subscription for Agentspace page:

   1. Enter the Number of licenses that you want.

   2. Choose the Term for the subscription.

   3. Optional: Click Auto renew.

   4. Select your tier.

6. Click Add.

Add users and manually assign them licenses

To give specific users access to Agentspace, 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 Agentspace page.

   Agentspace

2. Go to the Settings > License page.

3. Click Add users.

4. 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 Agentspace app.

   2. Select the subscription to assign to those users.

   3. Click Submit.

REST

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

Key Term: In Agentspace, the term app can be used interchangeably with the term engine in the context of APIs. An Agentspace engine is a generic search engine where the app_type field is set to APP_TYPE_INTRANET.

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 Agentspace subscription.

Add users and assign them licenses automatically

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

1. In the Google Cloud console, go to the Agentspace page.

   Agentspace

2. Go to the Settings > License page.

3. Make sure that you have a subscription with enough licenses for the maximum number of users that you expect be signed in to Agentspace at any one time.

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 Agentspace if the subscription has expired. There are a couple of approaches to returning sign-in access to them:

• Automatically transfer users with expired licenses to the default subscription.

• Manually transfer users to a new subscription.

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 Agentspace > Settings > License page.

   Agentspace License

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

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

4. 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 Agentspace > Settings > License page.

   Agentspace License

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

3. Select the users and click Assign different license.

4. 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

Key Term: In Agentspace, the term app can be used interchangeably with the term engine in the context of APIs. An Agentspace engine is a generic search engine where the app_type field is set to APP_TYPE_INTRANET.

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 Agentspace > Settings > License page.

   Agentspace License

2. Select the Location type of your 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:

Key Term: In Agentspace, the term app can be used interchangeably with the term engine in the context of APIs. An Agentspace engine is a generic search engine where the app_type field is set to APP_TYPE_INTRANET.

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

• Learn about IAM roles and permissions.