@logto/api 1.44.0 → 1.45.0

package/lib/generated-types/management.d.ts

@@ -3165,6 +3165,30 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/systems/license": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get the installed license.
+         * @description Get the license installed on this self-hosted deployment, i.e. the plan it grants, the entitlements it unlocks, its expiration, and its refresh/grace status. The license key itself is never returned. Returns 404 when no license is installed, and 501 on Logto Cloud.
+         */
+        get: operations["GetSystemLicense"];
+        /**
+         * Install a license.
+         * @description Install a license key on this self-hosted deployment, replacing the installed license if there is one. The key's signature is verified against the public key built into Logto before it is saved, and a key past its expiration is rejected as a stale copy. Returns 501 on Logto Cloud.
+         */
+        put: operations["InstallSystemLicense"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/subject-tokens": {
         parameters: {
             query?: never;
@@ -11826,6 +11850,8 @@ export interface operations {
             query?: {
                 /** @description If it's provided with a truthy value (`true`, `1`, `yes`), the scopes of each resource will be included in the response. */
                 includeScopes?: string;
+                /** @description If it's provided with a truthy value (`true`, `1`, `yes`), Logto Management API resources will be excluded from the response. */
+                excludeManagementApis?: string;
                 /** @description Page number (starts from 1). */
                 page?: number;
                 /** @description Entries per page. */
@@ -13183,7 +13209,7 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Forbidden */
+            /** @description Bring your UI is not available under the current entitlements, including when the self-hosted license grace period has ended. */
             403: {
                 headers: {
                     [name: string]: unknown;
@@ -24453,6 +24479,126 @@ export interface operations {
             };
         };
     };
+    GetSystemLicense: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The installed license. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @enum {string} */
+                        plan: "self-hosted-pro" | "self-hosted-enterprise";
+                        /** @enum {string} */
+                        env: "production" | "non-production";
+                        quota: {
+                            hideLogtoBranding: boolean;
+                            bringYourUi: boolean;
+                            idpInitiatedSso: boolean;
+                            consoleCollaboration: boolean;
+                            mandatoryMfa: boolean;
+                            hostedEmail: boolean;
+                            samlApplicationsLimit: number | null;
+                        };
+                        expiresAt: string;
+                        installedAt: string;
+                        lastRefreshedAt: string;
+                        graceEndsAt: string;
+                        refusalReason?: string;
+                    };
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description No license is installed on this deployment. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Licenses are only available on self-hosted deployments. */
+            501: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    InstallSystemLicense: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description The license key to install, as issued by Logto Cloud. */
+                    license: string;
+                };
+            };
+        };
+        responses: {
+            /** @description The license has been installed. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description The license key is invalid or has been tampered with, or it has expired. */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Licenses are only available on self-hosted deployments. */
+            501: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     CreateSubjectToken: {
         parameters: {
             query?: never;
@@ -28702,6 +28848,13 @@ export interface operations {
                 };
                 content?: never;
             };
+            /** @description IdP-initiated SSO is not available on this self-hosted deployment because the installed license does not grant it. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
             /** @description Invalid SSO connector ID or SSO connector authentication session not found. */
             404: {
                 headers: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/api",
-  "version": "1.44.0",
+  "version": "1.45.0",
   "description": "Logto API types and clients.",
   "author": "Silverhand Inc. <contact@silverhand.io>",
   "homepage": "https://github.com/logto-io/logto#readme",