REST Resource: projects.locations.licenseConfigs

Resource: LicenseConfig

Information about users' licenses.

JSON representation 
{
  "name": string,
  "licenseCount": string,
  "subscriptionTier": enum (SubscriptionTier),
  "state": enum (State),
  "autoRenew": boolean,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "subscriptionTerm": enum (SubscriptionTerm),
  "freeTrial": boolean,
  "alertPolicyResourceConfig": {
    object (AlertPolicyResourceConfig)
  },
  "geminiBundle": boolean,
  "earlyTerminated": boolean,
  "earlyTerminationDate": {
    object (Date)
  }
}
Fields
name

string

Immutable. Identifier. The fully qualified resource name of the license config. Format: projects/{project}/locations/{location}/licenseConfigs/{licenseConfig}
licenseCount

string (int64 format)

Required. Number of licenses purchased.
subscriptionTier

enum (SubscriptionTier)

Required. Subscription tier information for the license config.
state

enum (State)

Output only. The state of the license config.
autoRenew

boolean

Optional. Whether the license config should be auto renewed when it reaches the end date.
startDate

object (Date)

Required. The start date.
endDate

object (Date)

Optional. The planed end date.
subscriptionTerm

enum (SubscriptionTerm)

Required. Subscription term.
freeTrial

boolean

Optional. Whether the license config is for free trial.
alertPolicyResourceConfig

object (AlertPolicyResourceConfig)

Optional. The alert policy config for this license config.
geminiBundle

boolean

Output only. Whether the license config is for Gemini bundle.
earlyTerminated

boolean

Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
earlyTerminationDate

object (Date)

Output only. The date when the subscription is terminated earlier than the expiration date.

State

License config state enumeration.

Enums
STATE_UNSPECIFIED Default value. The license config does not exist.
ACTIVE The license config is effective and being used.
EXPIRED The license config has expired.
NOT_STARTED The license config has not started yet, and its start date is in the future.
WITHDRAWN This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED.
DEACTIVATING The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first.

AlertPolicyResourceConfig

The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.

JSON representation 
{
  "alertPolicy": string,
  "alertEnrollments": [
    {
      object (AlertEnrollment)
    }
  ],
  "contactDetails": [
    {
      object (ContactDetails)
    }
  ],
  "languageCode": string
}
Fields
alertPolicy

string

Immutable. The fully qualified resource name of the AlertPolicy.
alertEnrollments[]

object (AlertEnrollment)

Optional. The enrollment state of each alert.
contactDetails[]

object (ContactDetails)

Optional. The contact details for each alert policy.
languageCode

string

Optional. The language code used for notifications

AlertEnrollment

The alert enrollment status.

JSON representation 
{
  "alertId": string,
  "enrollState": enum (EnrollState),
  "notificationParams": {
    string: string,
    ...
  }
}
Fields
alertId

string

Immutable. The ID of an alert.
enrollState

enum (EnrollState)

Required. The enrollment status of a customer.
notificationParams

map (key: string, value: string)

Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.

EnrollState

The enrollment status enum for the alert.

Enums
ENROLL_STATE_UNSPECIFIED Default value. Used for customers who have not responded to the alert policy.
ENROLLED Customer is enrolled in this policy.
DECLINED Customer declined this policy.

ContactDetails

The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.

JSON representation 
{
  "emailAddress": string
}
Fields
emailAddress

string

Optional. The email address of the contact.

Methods

create

 Creates a LicenseConfig

get

 Gets a LicenseConfig.

patch

 Updates the LicenseConfig