enterprise_ai.license

Source: sdks/python/src/enterprise_ai/license/__init__.py. Back to the Python SDK reference index.

note

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

/v1/license.

Resource

LicenseClient.activate

activate(token: str) -> Any

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
token	str		yes	Signed licence: JWS compact serialization (three base64url segments separated by dots), algorithm EdDSA, 20 to 16384 characters.

Returns: Any. Decoded JSON answer of the operation "Activate a licence".

Raises: the typed errors of the transport (Errors).

LicenseClient.get

get() -> Any

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: Any. Decoded JSON answer of the operation "Read the licence state".

Raises: the typed errors of the transport (Errors).

LicenseClient.history

history(**page: Any) -> Any

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
**page	Any		no	Pagination options passed to the listing: limit (maximum number of items per page) and cursor (the next_cursor of the previous page). Iterating the returned page follows every cursor.

Returns: Any. Decoded JSON answer of the operation "List the licence history".

Raises: the typed errors of the transport (Errors).