io.enterpriseai.resources.LicenseClient
Source: sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/resources/LicenseClient.java. Back to the Java SDK reference index.
This page is generated by tools/docs/gen_sdk_reference.py from the SDK sources and the OpenAPI text folders. Do not edit it by hand: change the source and regenerate.
Class LicenseClient
Licence entitlement and activations.
Constructor LicenseClient
LicenseClient(Transport transport)
Creates the client on the shared transport; EnterpriseAIClient builds it and exposes it through the accessor of the same name.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
transport | Transport | yes | Transport shared by the sub-clients of one client. |
LicenseClient.activate
JsonNode activate(Object body)
Activate a licence. Verifies a signed licence locally and stores it. Requires the role platform_admin and the policy decision license.activate.
Route: /v1/license/activations (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | The signed licence received from the publisher. |
Returns: JsonNode. Decoded JSON answer of the operation "Activate a licence".
Raises: the typed errors of the transport (Errors).
LicenseClient.activate
JsonNode activate(Object body, RequestOptions options)
Activate a licence. Verifies a signed licence locally and stores it. Requires the role platform_admin and the policy decision license.activate.
Route: /v1/license/activations (POST).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
body | Object | yes | The signed licence received from the publisher. | |
options | RequestOptions | yes | Per call options (idempotency key, traceparent, headers, abort signal). |
Returns: JsonNode. Decoded JSON answer of the operation "Activate a licence".
Raises: the typed errors of the transport (Errors).
LicenseClient.get
JsonNode get()
Read the licence state. Non sensitive licence status of the installation: state, edition, product, term, validity and grace dates, days remaining, whether a renewal is scheduled, the actions restricted now, the capabilities a licence never restricts, and the banner the portal shows (level none, info, warning or critical, with an English and French message). No customer identifier, support reference or token is returned. Any authenticated principal may call it, subject to the policy decision license.read (403 policy_denied).
Route: /v1/license (GET).
This element takes no parameter.
Returns: JsonNode. Decoded JSON answer of the operation "Read the licence state".
Raises: the typed errors of the transport (Errors).
LicenseClient.history
JsonNode history()
List the licence history. Licence history of the installation, newest event first: activations, rejected activations, actions refused after grace and expiry notices. The answer also gives the installation identity (installation id, installation group and when and by whom it was bound), every stored licence with its customer id, support reference and environments, and the support contracts. Requires the role platform_admin (403 forbidden) and the policy decision license.history.read. A malformed cursor answers 400 invalid_cursor.
Route: /v1/license/history (GET).
This element takes no parameter.
Returns: JsonNode. Decoded JSON answer of the operation "List the licence history".
Raises: the typed errors of the transport (Errors).
LicenseClient.history
JsonNode history(Map<String, ?> query)
List the licence history. Licence history of the installation, newest event first: activations, rejected activations, actions refused after grace and expiry notices. The answer also gives the installation identity (installation id, installation group and when and by whom it was bound), every stored licence with its customer id, support reference and environments, and the support contracts. Requires the role platform_admin (403 forbidden) and the policy decision license.history.read. A malformed cursor answers 400 invalid_cursor.
Route: /v1/license/history (GET).
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
query | Map<String, ?> | yes | Query string parameters of the route. |
Returns: JsonNode. Decoded JSON answer of the operation "List the licence history".
Raises: the typed errors of the transport (Errors).