@dotcms/ai 26.10.22-1 → 26.10.23-2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/ai",
-  "version": "26.10.22-1",
+  "version": "26.10.23-2",
   "description": "The dotCMS agentic runtime — run model-written or human-written code safely against a dotCMS instance, with auth and policy owned in one place.",
   "repository": {
     "type": "git",
@@ -8,7 +8,7 @@
     "directory": "core-web/libs/sdk/ai"
   },
   "dependencies": {
-    "@dotcms/types": "26.10.22-1",
+    "@dotcms/types": "26.10.23-2",
     "tslib": "^2.3.0",
     "zod": "^4.1.9"
   },

package/spec.cjs2.js

@@ -7540,7 +7540,7 @@ var paths = {
 	},
 	"/api/v1/users": {
 		post: {
-			description: "Creates a new user. Requires admin privileges or access to Users and Roles portlets. FirstName, LastName, Email and Password are required",
+			description: "Creates a new user. Requires a CMS Administrator. FirstName, LastName, Email and Password are required",
 			operationId: "createUser",
 			requestBody: {
 				content: {
@@ -7583,7 +7583,7 @@ var paths = {
 						"application/json": {
 						}
 					},
-					description: "Forbidden - insufficient permissions to create users"
+					description: "Forbidden - only a CMS Administrator can create users"
 				},
 				"409": {
 					content: {
@@ -7648,7 +7648,7 @@ var paths = {
 							}
 						}
 					},
-					description: "If the user is not an admin or access to the role + user layouts or does have permission, it will return a 403."
+					description: "If the user is not an admin or access to the role + user layouts or does have permission, it will return a 403. Changing the user's roles also requires a CMS Administrator; otherwise nothing is changed and a 403 is returned."
 				},
 				"404": {
 					content: {
@@ -7881,7 +7881,7 @@ var paths = {
 	},
 	"/api/v1/users/filter": {
 		get: {
-			description: "Returns a list of dotCMS users based on specified search criteria with pagination support. Each item is the user's data map. When `includeRoles=true` is passed, each item additionally carries a `roles` array listing the user's directly assigned roles as `{id, name, roleKey}` objects (`roleKey` may be null for roles created without a key); roles held through the role hierarchy and the user's personal role are not included. Requesting roles requires being a CMS Administrator or having access to both the Roles and Users portlets (403 otherwise). Without the flag the payload is unchanged.",
+			description: "Returns a list of dotCMS users based on specified search criteria with pagination support. Each item is the user's data map. When `includeRoles=true` is passed, each item additionally carries a `roles` array listing the user's directly assigned roles as `{id, name, roleKey}` objects (`roleKey` may be null for roles created without a key); roles held through the role hierarchy and the user's personal role are not included. Requesting roles requires being a CMS Administrator or having access to both the Roles and Users portlets (403 otherwise). Without the flag the payload is unchanged. Results can be restricted to users directly holding any of the given roles through `roleKey` and/or `roleId`; filtering by role requires that same privilege. The `admin` flag on each item is only returned to callers with that same privilege; for anyone else it is left out.",
 			operationId: "filterUsers",
 			parameters: [
 				{
@@ -7963,7 +7963,7 @@ var paths = {
 					}
 				},
 				{
-					description: "Role key(s) to restrict results to users holding any of them; repeatable and/or comma-separated, e.g. roleKey=DOTCMS_BACK_END_USER. Requires CMS Administrator or Roles+Users portlet access (403 otherwise)",
+					description: "Role key(s) to restrict results to users holding any of them; repeatable and/or comma-separated, e.g. roleKey=DOTCMS_BACK_END_USER (exact match). Requires CMS Administrator or Roles+Users portlet access (403 otherwise)",
 					"in": "query",
 					name: "roleKey",
 					schema: {
@@ -7973,6 +7973,17 @@ var paths = {
 						}
 					}
 				},
+				{
+					description: "Role ID(s) to restrict results to users directly holding any of them, combined with roleKey; repeatable and/or comma-separated. Also matches roles created without a key. Requires CMS Administrator or Roles+Users portlet access (403 otherwise)",
+					"in": "query",
+					name: "roleId",
+					schema: {
+						type: "array",
+						items: {
+							type: "string"
+						}
+					}
+				},
 				{
 					description: "When true, each user carries a `roles` array of its directly assigned roles as {id, name, roleKey}; inherited roles and the user's personal role are excluded. Requires CMS Administrator or Roles+Users portlet access (403 otherwise). Defaults to false (payload unchanged)",
 					"in": "query",
@@ -7999,7 +8010,7 @@ var paths = {
 						"application/json": {
 						}
 					},
-					description: "Bad request - a provided roleKey does not match any existing Role"
+					description: "Bad request - a provided roleKey or roleId does not match any existing Role"
 				},
 				"401": {
 					content: {
@@ -8013,7 +8024,7 @@ var paths = {
 						"application/json": {
 						}
 					},
-					description: "Forbidden - insufficient permissions, or includeRoles=true requested without CMS Administrator / Roles+Users portlet access"
+					description: "Forbidden - insufficient permissions, or includeRoles=true / a role filter requested without CMS Administrator / Roles+Users portlet access"
 				}
 			},
 			summary: "Filter users",

package/spec.esm2.js

@@ -7538,7 +7538,7 @@ var paths = {
 	},
 	"/api/v1/users": {
 		post: {
-			description: "Creates a new user. Requires admin privileges or access to Users and Roles portlets. FirstName, LastName, Email and Password are required",
+			description: "Creates a new user. Requires a CMS Administrator. FirstName, LastName, Email and Password are required",
 			operationId: "createUser",
 			requestBody: {
 				content: {
@@ -7581,7 +7581,7 @@ var paths = {
 						"application/json": {
 						}
 					},
-					description: "Forbidden - insufficient permissions to create users"
+					description: "Forbidden - only a CMS Administrator can create users"
 				},
 				"409": {
 					content: {
@@ -7646,7 +7646,7 @@ var paths = {
 							}
 						}
 					},
-					description: "If the user is not an admin or access to the role + user layouts or does have permission, it will return a 403."
+					description: "If the user is not an admin or access to the role + user layouts or does have permission, it will return a 403. Changing the user's roles also requires a CMS Administrator; otherwise nothing is changed and a 403 is returned."
 				},
 				"404": {
 					content: {
@@ -7879,7 +7879,7 @@ var paths = {
 	},
 	"/api/v1/users/filter": {
 		get: {
-			description: "Returns a list of dotCMS users based on specified search criteria with pagination support. Each item is the user's data map. When `includeRoles=true` is passed, each item additionally carries a `roles` array listing the user's directly assigned roles as `{id, name, roleKey}` objects (`roleKey` may be null for roles created without a key); roles held through the role hierarchy and the user's personal role are not included. Requesting roles requires being a CMS Administrator or having access to both the Roles and Users portlets (403 otherwise). Without the flag the payload is unchanged.",
+			description: "Returns a list of dotCMS users based on specified search criteria with pagination support. Each item is the user's data map. When `includeRoles=true` is passed, each item additionally carries a `roles` array listing the user's directly assigned roles as `{id, name, roleKey}` objects (`roleKey` may be null for roles created without a key); roles held through the role hierarchy and the user's personal role are not included. Requesting roles requires being a CMS Administrator or having access to both the Roles and Users portlets (403 otherwise). Without the flag the payload is unchanged. Results can be restricted to users directly holding any of the given roles through `roleKey` and/or `roleId`; filtering by role requires that same privilege. The `admin` flag on each item is only returned to callers with that same privilege; for anyone else it is left out.",
 			operationId: "filterUsers",
 			parameters: [
 				{
@@ -7961,7 +7961,7 @@ var paths = {
 					}
 				},
 				{
-					description: "Role key(s) to restrict results to users holding any of them; repeatable and/or comma-separated, e.g. roleKey=DOTCMS_BACK_END_USER. Requires CMS Administrator or Roles+Users portlet access (403 otherwise)",
+					description: "Role key(s) to restrict results to users holding any of them; repeatable and/or comma-separated, e.g. roleKey=DOTCMS_BACK_END_USER (exact match). Requires CMS Administrator or Roles+Users portlet access (403 otherwise)",
 					"in": "query",
 					name: "roleKey",
 					schema: {
@@ -7971,6 +7971,17 @@ var paths = {
 						}
 					}
 				},
+				{
+					description: "Role ID(s) to restrict results to users directly holding any of them, combined with roleKey; repeatable and/or comma-separated. Also matches roles created without a key. Requires CMS Administrator or Roles+Users portlet access (403 otherwise)",
+					"in": "query",
+					name: "roleId",
+					schema: {
+						type: "array",
+						items: {
+							type: "string"
+						}
+					}
+				},
 				{
 					description: "When true, each user carries a `roles` array of its directly assigned roles as {id, name, roleKey}; inherited roles and the user's personal role are excluded. Requires CMS Administrator or Roles+Users portlet access (403 otherwise). Defaults to false (payload unchanged)",
 					"in": "query",
@@ -7997,7 +8008,7 @@ var paths = {
 						"application/json": {
 						}
 					},
-					description: "Bad request - a provided roleKey does not match any existing Role"
+					description: "Bad request - a provided roleKey or roleId does not match any existing Role"
 				},
 				"401": {
 					content: {
@@ -8011,7 +8022,7 @@ var paths = {
 						"application/json": {
 						}
 					},
-					description: "Forbidden - insufficient permissions, or includeRoles=true requested without CMS Administrator / Roles+Users portlet access"
+					description: "Forbidden - insufficient permissions, or includeRoles=true / a role filter requested without CMS Administrator / Roles+Users portlet access"
 				}
 			},
 			summary: "Filter users",