REST Resource: userLicense
Stay organized with collections
Save and categorize content based on your preferences.
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 |
|
|
Gets the user's licensing status for their permission to use a given app. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-14 UTC.
[null,null,["Last updated 2024-11-14 UTC."],[[["\u003cp\u003eThe UserLicense resource represents a user's license status for a specific application within a Google Workspace domain.\u003c/p\u003e\n"],["\u003cp\u003eIt provides information about the user's license status, including whether it's active, unlicensed, or expired.\u003c/p\u003e\n"],["\u003cp\u003eThe resource includes details such as the user's email, domain, application ID, and license ID.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve a user's license information using the \u003ccode\u003eget\u003c/code\u003e method of the UserLicense API.\u003c/p\u003e\n"]]],["The `UserLicense` resource provides information about a user's access to an application. Key data includes `kind` (resource type), `enabled` (domain-level activation), and `state` (user's license status: `ACTIVE`, `UNLICENSED`, `EXPIRED`). Additional fields are `customerId` (domain), `applicationId` (app ID), `id` (license ID), and `userId` (user's email). The `editionId` field is deprecated. The `get` method retrieves a user's licensing status for a specific app.\n"],null,["# REST Resource: userLicense\n\nResource: UserLicense\n---------------------\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"enabled\": boolean, \"state\": string, \"editionId\": string, \"customerId\": string, \"applicationId\": string, \"id\": string, \"userId\": string } ``` |\n\n| Fields ||\n|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` The type of API resource. This is always appsmarket#userLicense. |\n| `enabled` | `boolean` The domain administrator has activated the application for this domain. |\n| `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. |\n| `editionId` **(deprecated)** | `string` | This item is deprecated! (Deprecated) |\n| `customerId` | `string` The domain name of the user. |\n| `applicationId` | `string` The ID of the application corresponding to the license query. |\n| `id` | `string` The ID of user license. |\n| `userId` | `string` The email address of the user. |\n\n| Methods ------- ||\n|---------------------------------------------------------------------|---------------------------------------------------------------------------|\n| ### [get](/workspace/marketplace/reference/rest/v2/userLicense/get) | Gets the user's licensing status for their permission to use a given app. |"]]
