License Manager API: Developer's Guide

This document describes how account-level and reseller administrators can use the Google Enterprise License Manager API to manage users license assignments. Once your account's product SKU licenses have been enabled and your users have been created, use the License Manager API to assign, update, retrieve, and delete licenses for your account's users.

In this version, the API is used by account and reseller administrators. Delegated administrators are not supported.

Note: The License Manager API is used by a Google customer. For information about how Google third-party application developers manage licenses, see the G Suite Marketplace License API.

The License Manager API is based on the Representational State Transfer (RESTful) design approach to web services.

Managing Licenses

Assign a license

Previous to this operation, the customer or reseller has ordered Google product licenses and has created the user. To assign one of these product licenses to this user, use the following POST HTTP request. Include the Authorization header as described in Authorizing requests. For product and SKU IDs, see the API's available Products and SKUs:

POST https://www.googleapis.com/apps/licensing/v1/product/productId/sku/skuId/user

Note: A user can be assigned licenses for a wide range of different Google products. But a user is assigned only one SKU license per product at a time. By using the API, a user's SKU license can be reassigned to a different SKU license within the product.

This example assigns the Google-Drive-storage-20GB SKU to the user whose primary email address is alex@example.com:

POST https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-20GB/user

The JSON request body:

{
  "userId" : "alex@example.com",
}

A successful response returns a 200 HTTP status code. For possible error codes, see the API's Error codes. If successful, the response returns the licensing assignment status in JSON data format.

JSON Response

{
  "kind": "licensing#licenseAssignment",
  "etags": "etag value",
  "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-20GB/user/alex@example.com",
  "userId": "alex@example.com",
  "productId": "Google-Drive-storage",
  "skuId": "Google-Drive-storage-20GB",
  "skuName": "Google Drive storage 20 GB",
  "productName": "Google Drive storage"
}

For more information, see the licenseAssignments insert method reference page.

Reassign a user's product SKU with a different SKU in the same product

To reassign a user's license to a new license SKU within the same product, use the following PUT HTTP request. The API also supports the patch syntax. Include the Authorization header as described in Authorizing requests. For product and SKU IDs, see the API's available Products and SKUs:

PUT https://www.googleapis.com/apps/licensing/v1/product/productId/sku/the current skuId/user/user's email

This example updates the present Google-Drive-storage-20GB SKU with the Google-Drive-storage-50GB. The present license SKU is in the request's URI and the new license SKU is in the request's body:

PUT https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-20GB/user/alex@example.com

The JSON request body has :

{
  "kind": "licensing#licenseAssignment",
  "etags": "etag value",
  "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-50GB/user/alex@example.com",
  "userId": "alex@example.com",
  "productId": "Google-Drive-storage",
  "skuId": "Google-Drive-storage-50GB",
  "skuName": "Google Drive storage 50 GB",
  "productName": "Google Drive storage"
}

A successful response returns a 200 HTTP status code. For possible error codes, see the API's Error codes. If successful, the response returns the license assignment status in JSON data format.

JSON Response

{
  "kind": "licensing#licenseAssignment",
  "etags": "etag value",
  "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-50GB/user/alex@example.com",
  "userId": "alex@example.com",
  "productId": "Google-Drive-storage",
  "skuId": "Google-Drive-storage-50GB",
  "skuName": "Google Drive storage 50 GB",
  "productName": "Google Drive storage"
}

For more information, see the licenseAssignments update method and patch method reference pages.

Retrieve all users assigned licenses for a specific product

To get all user licenses for a specific product, use the following GET HTTP request. Include the Authorization header as described in Authorizing requests. The customerId query string is the customer's primary domain name. The maxResults query string determines how many user license entries are returned in the API's response:

GET https://www.googleapis.com/apps/licensing/v1/product/productId/users?customerId=primary domain name&maxResults=max results per page

For product and SKU IDs, see the API's available Products and SKUs.

This example lists the first page of results for all users in the example.com domain assigned licenses for the Google-Drive-storage product:

GET https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/users?customerId=example.com&maxResults=2

A successful response returns a 200 HTTP status code. For possible error codes, see the API's Error codes. If successful, the response returns the licensing list in JSON format.

JSON Response

{
  "kind" : "licensing#licenseAssignmentList",
  "etag": "etag value",
  "nextPageToken" : "the next page token value",
  "items": [
  {
    "kind": "licensing#licenseAssignment",
    "etags": "etag value",
    "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-50GB/user/alex@example.com",
    "userId": "alex@example.com",
    "productId": "Google-Drive-storage",
    "skuId": "Google-Drive-storage-50GB",
    "skuName": "Google Drive storage 50 GB",
    "productName": "Google Drive storage"
  },
  {
    "kind": "licensing#licenseAssignment",
    "etags": "etag value",
    "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-200GB/user/keshav@example.com",
    "userId": "keshav@example.com",
    "productId": "Google-Drive-storage",
    "skuId": "Google-Drive-storage-200GB",
    "skuName": "Google Drive storage 200 GB",
    "productName": "Google Drive storage"
  },
  ...
}

For more information, see the licenseAssignments listForProduct method reference page.

Retrieve all users assigned licenses for a specific product SKU

To get a list of all users with licenses for a specific product SKU, use the following GET HTTP request. Include the Authorization header as described in Authorizing requests. The customerId query string is the customer's primary domain name. The maxResults query string determines how many user entries are returned in the API's response:

GET https://www.googleapis.com/apps/licensing/v1/product/productId/sku/skuId/users?customerId=primary domain name&maxResults=max results per response page

For product and SKU IDs, see the API's available Products and SKUs

This example returns the first page of all users in the example.com domain assigned a license for the Google-Drive-storage-200GB SKU. The response lists two user entries per page:

GET https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-200GB/users?customerId=example.com&maxResults=2

A successful response returns a 200 HTTP status code. For possible error codes, see the API's Error codes. If successful, response returns the licensing list in JSON format.

JSON Response

{
  "kind" : "licensing#licenseAssignmentList",
   "etag": "etag value",
   "nextPageToken" : "next page token's value",
   "items": [
    {
     "kind": "licensing#licenseAssignment",
     "etags": "etag value",
     "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-200GB/user/alex@example.com",
     "userId": "alex@example.com",
     "productId": "Google-Drive-storage",
     "skuId": "Google-Drive-storage-200GB",
     "skuName": "Google Drive storage 200 GB",
     "productName": "Google Drive storage"
    },
    {
     "kind": "licensing#licenseAssignment",
     "etags": "etag value",
     "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-200GB/user/mary@example.com",
     "userId": "mary@example.com",
     "productId": "Google-Drive-storage",
     "skuId": "Google-Drive-storage-200GB",
     "skuName": "Google Drive storage 200 GB",
     "productName": "Google Drive storage"
    },
    ...
  }

For more information, see the licenseAssignments listForProductAndSku method reference page.

Retrieve a specific user's license by product SKU

To get a specific user's license by product SKU, use the following GET HTTP request. Include the Authorization header as described in Authorizing requests. For product and SKU IDs, see the API's available Products and SKUs:

GET https://www.googleapis.com/apps/licensing/v1/product/productId/sku/skuId/user/userId

This example gets the Google Drive storage 50GB product SKU for the user whose userId is alex@example.com:

GET https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-50GB/user/alex@example.com

If the user has this license, it is a successful response and a 200 HTTP status code. For possible error codes, see the API's Error codes. If successful, the response returns the user's license in JSON format.

JSON Response

{
  "kind": "licensing#licenseAssignment",
  "etag": "etag value",
  "selfLink": "https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-50GB/user/alex@example.com",
  "userId": "keshav@example.com",
  "productId": "Google-Drive-storage",
  "skuId": "Google-Drive-storage-50GB",
  "skuName": "Google Drive storage 50 GB",
  "productName": "Google Drive storage"
}

For more information, see the licenseAssignments get method reference page.

Delete a license

To unassign a license from a user, use the following DELETE HTTP request. Include the Authorization header as described in Authorizing requests. For product and SKU IDs, see the API's available Products and SKUs:

DELETE https://www.googleapis.com/apps/licensing/v1/product/productId/sku/skuId/user/userId

This example the Google-Drive-storage-50GB license is unassigned from the user whose userId is alex@example.com:

DELETE https://www.googleapis.com/apps/licensing/v1/product/Google-Drive-storage/sku/Google-Drive-storage-50GB/user/alex@example.com

A successful response returns a 200 HTTP status code. For possible error codes, see the API's Error codes.

For more information, see the licenseAssignments delete method reference page.

Error codes

If the request is unsuccessful, the response has a brief explanation of the error:

Error Code Description
400 Bad Request User email not valid
400 Bad Request Sku/product does not exist
401 Actor doesn't have credentials to call this API
404 If the user does not have this license, the response has a 'not found' error code.
412 A precondition has not been met. Some examples are assigning a license to a user who already has the license, or when there are not enough licenses to assign.
503 The License Manager service is not available.