REST Resource: userLicense

  • The UserLicense resource represents a user's license status for a specific application within a Google Workspace domain.

  • It provides information about the user's license status, including whether it's active, unlicensed, or expired.

  • The resource includes details such as the user's email, domain, application ID, and license ID.

  • You can retrieve a user's license information using the get method of the UserLicense API.

Resource: UserLicense

JSON representation 
{
  "kind": string,
  "enabled": boolean,
  "state": string,
  "editionId": string,
  "customerId": string,
  "applicationId": string,
  "id": string,
  "userId": string
}
Fields
kind

string

The type of API resource. This is always appsmarket#userLicense.
enabled

boolean

The domain administrator has activated the application for this domain.
state

string

The user's licensing status. One of:

  • ACTIVE: The user has a valid license and should be permitted to use the application.
  • UNLICENSED: The administrator of this user's domain never assigned a seat for the application to this user.
  • EXPIRED: The administrator assigned a seat to this user, but the license is expired.
editionId
(deprecated)

string

(Deprecated)
customerId

string

The domain name of the user.
applicationId

string

The ID of the application corresponding to the license query.
id

string

The ID of user license.
userId

string

The email address of the user.

Methods

get

 Gets the user's licensing status for their permission to use a given app.