From b175d8f20e0e2ce603b4446c33e1e381ac11e277 Mon Sep 17 00:00:00 2001 From: Danny <117714228+UCNDanny@users.noreply.github.com> Date: Fri, 25 Sep 2026 15:19:24 +0200 Subject: [PATCH] Add organization picker to FGAP permissions in Admin UI Selecting "Specific Organizations" in a Fine-Grained Admin Permissions permission rendered no picker, because "organizations" was missing from the resource-type component map. Add an OrganizationSelect modeled on the client picker and register it. The permission evaluation tab reuses the same component map, so also handle Organizations there. Removing an organization marks the form dirty so the search dropdown enables its Search button. Closes #50830 Signed-off-by: Danny <117714228+UCNDanny@users.noreply.github.com> --- .../fine-grain-v2.adoc | 6 + .../admin/messages/messages_en.properties | 3 + .../PermissionsEvaluationTab.tsx | 3 + .../resource-types/OrganizationSelect.tsx | 200 ++++++++++++++++++ .../resource-types/ResourceType.tsx | 2 + .../src/utils/useSortedResourceTypes.ts | 16 +- .../admin-ui/test/permissions/main.spec.ts | 76 ++++++- js/apps/admin-ui/test/permissions/main.ts | 21 +- js/apps/admin-ui/test/utils/AdminClient.ts | 12 ++ 9 files changed, 335 insertions(+), 4 deletions(-) create mode 100644 js/apps/admin-ui/src/permissions-configuration/resource-types/OrganizationSelect.tsx diff --git a/docs/documentation/server_admin/topics/admin-console-permissions/fine-grain-v2.adoc b/docs/documentation/server_admin/topics/admin-console-permissions/fine-grain-v2.adoc index 428b060cb640..9b5a0414f45a 100644 --- a/docs/documentation/server_admin/topics/admin-console-permissions/fine-grain-v2.adoc +++ b/docs/documentation/server_admin/topics/admin-console-permissions/fine-grain-v2.adoc @@ -225,6 +225,12 @@ set of management operations: Creating new organizations requires `manage` permission on all organizations (the resource type level), not just on a specific organization. +To apply a permission to particular organizations, select *Specific Organizations* when creating the permission and pick them from the list. +With *All Organizations*, the permission applies to every organization in the realm. + +A realm administrator who only has permissions on specific organizations also needs the `query-organizations` role to see and list them in the administration console. +For more details on these roles, see <<_realm_access_control, Accessing a Realm administration console as a Realm Administrator>>. + ==== Enabling admin permissions to a realm To enable fine-grained admin permissions in a realm, follow these steps: diff --git a/js/apps/admin-ui/maven-resources/theme/keycloak.v2/admin/messages/messages_en.properties b/js/apps/admin-ui/maven-resources/theme/keycloak.v2/admin/messages/messages_en.properties index bd99a835e19d..473524aa4e76 100644 --- a/js/apps/admin-ui/maven-resources/theme/keycloak.v2/admin/messages/messages_en.properties +++ b/js/apps/admin-ui/maven-resources/theme/keycloak.v2/admin/messages/messages_en.properties @@ -3958,6 +3958,9 @@ authorizationScope.Roles.map-role=Maps this role to a user or group usersResources=Users clientsResources=Clients groupsResources=Groups +organizationsResources=Organizations +selectOrganization=Select organization +selectOrganizations=Select organizations resourceTypeHelpText=Specifies which {{resourceType}} are allowed by this permission. If left blank, it is the same as selecting all. evaluation=Evaluation addSubFlowTo=Add sub-flow to {{name}} diff --git a/js/apps/admin-ui/src/permissions-configuration/permission-evaluation/PermissionsEvaluationTab.tsx b/js/apps/admin-ui/src/permissions-configuration/permission-evaluation/PermissionsEvaluationTab.tsx index 1a8f00f55329..5368733e8bec 100644 --- a/js/apps/admin-ui/src/permissions-configuration/permission-evaluation/PermissionsEvaluationTab.tsx +++ b/js/apps/admin-ui/src/permissions-configuration/permission-evaluation/PermissionsEvaluationTab.tsx @@ -42,6 +42,7 @@ interface EvaluateFormInputs groups: string[]; users: string[]; roles: string[]; + organizations: string[]; resourceType?: string; } @@ -114,6 +115,8 @@ const PermissionEvaluateContent = ({ client }: Props) => { return getSingleValue(formValues.clients); case "Roles": return getSingleValue(formValues.roles); + case "Organizations": + return getSingleValue(formValues.organizations); default: return undefined; } diff --git a/js/apps/admin-ui/src/permissions-configuration/resource-types/OrganizationSelect.tsx b/js/apps/admin-ui/src/permissions-configuration/resource-types/OrganizationSelect.tsx new file mode 100644 index 000000000000..dad5aa135822 --- /dev/null +++ b/js/apps/admin-ui/src/permissions-configuration/resource-types/OrganizationSelect.tsx @@ -0,0 +1,200 @@ +import type OrganizationRepresentation from "@keycloak/keycloak-admin-client/lib/defs/organizationRepresentation"; +import { + FormErrorText, + HelpItem, + KeycloakDataTable, + ListEmptyState, + useFetch, +} from "@keycloak/keycloak-ui-shared"; +import { Button, FormGroup, Modal, ModalVariant } from "@patternfly/react-core"; +import { MinusCircleIcon } from "@patternfly/react-icons"; +import { Table, Tbody, Td, Th, Thead, Tr } from "@patternfly/react-table"; +import { useState } from "react"; +import { Controller, useFormContext } from "react-hook-form"; +import { useTranslation } from "react-i18next"; +import { useAdminClient } from "../../admin-client"; +import type { ComponentProps } from "../../components/dynamic/components"; + +type OrganizationSelectProps = Omit & { + variant?: "typeahead" | "typeaheadMulti"; + isRequired?: boolean; +}; + +export const OrganizationSelect = ({ + name, + label, + helpText, + defaultValue, + isDisabled = false, + isRequired, + variant = "typeaheadMulti", +}: OrganizationSelectProps) => { + const { adminClient } = useAdminClient(); + const { t } = useTranslation(); + const { + control, + setValue, + getValues, + formState: { errors }, + } = useFormContext(); + const [open, setOpen] = useState(false); + const [selected, setSelected] = useState([]); + const [picked, setPicked] = useState([]); + const selectOne = variant === "typeahead"; + + useFetch( + () => { + const v = getValues(name!) ?? defaultValue; + const values: string[] = typeof v === "string" ? (v ? [v] : []) : v || []; + if (values.length > 0) { + return Promise.all( + values.map((id) => adminClient.organizations.findOne({ id })), + ); + } + return Promise.resolve([]); + }, + (orgs) => setSelected(orgs), + [], + ); + + const loader = async (first?: number, max?: number, search?: string) => + adminClient.organizations.find({ first, max, search }); + + return ( + + ) : undefined + } + fieldId={name} + isRequired={isRequired} + > + { + if (!isRequired) return true; + if (Array.isArray(value)) return value.length > 0; + return !!value; + }, + }} + render={({ field }) => ( + <> + {open && ( + setOpen(false)} + actions={[ + , + , + ]} + > + setPicked([...rows])} + searchPlaceholderKey="searchOrganization" + isPaginated + canSelectAll={!selectOne} + isRadio={selectOne} + loader={loader} + ariaLabelKey="organizations" + columns={[{ name: "name" }, { name: "alias" }]} + emptyState={ + + } + /> + + )} + + + )} + /> + {selected.length > 0 && ( + + + + + + + + {selected.map((org) => ( + + + + + ))} + +
{t("organization")}
{org.name} +
+ )} + {errors[name!] && } +
+ ); +}; diff --git a/js/apps/admin-ui/src/permissions-configuration/resource-types/ResourceType.tsx b/js/apps/admin-ui/src/permissions-configuration/resource-types/ResourceType.tsx index cb874495dc94..e0ca20e9a958 100644 --- a/js/apps/admin-ui/src/permissions-configuration/resource-types/ResourceType.tsx +++ b/js/apps/admin-ui/src/permissions-configuration/resource-types/ResourceType.tsx @@ -7,6 +7,7 @@ import { GroupSelect } from "./GroupSelect"; import { UserSelect } from "../../components/users/UserSelect"; import { RoleSelect } from "./RoleSelect"; import { ClientSelectComponent } from "./ClientSelectComponent"; +import { OrganizationSelect } from "./OrganizationSelect"; type ResourceTypeProps = { withEnforceAccessTo?: boolean; @@ -20,6 +21,7 @@ export const COMPONENTS: { clients: ClientSelectComponent, groups: GroupSelect, roles: RoleSelect, + organizations: OrganizationSelect, } as const; export const isValidComponentType = (value: string) => value in COMPONENTS; diff --git a/js/apps/admin-ui/src/utils/useSortedResourceTypes.ts b/js/apps/admin-ui/src/utils/useSortedResourceTypes.ts index aa4868566ba3..b93946d30f93 100644 --- a/js/apps/admin-ui/src/utils/useSortedResourceTypes.ts +++ b/js/apps/admin-ui/src/utils/useSortedResourceTypes.ts @@ -1,6 +1,8 @@ import ResourceServerRepresentation from "@keycloak/keycloak-admin-client/lib/defs/resourceServerRepresentation"; import { useMemo, useState } from "react"; import { useAdminClient } from "../admin-client"; +import { useRealm } from "../context/realm-context/RealmContext"; +import useIsFeatureEnabled, { Feature } from "./useIsFeatureEnabled"; import { useFetch } from "@keycloak/keycloak-ui-shared"; import { sortBy } from "lodash-es"; @@ -12,6 +14,11 @@ export default function useSortedResourceTypes({ clientId, }: UseSortedResourceTypesProps) { const { adminClient } = useAdminClient(); + const { realmRepresentation } = useRealm(); + const isFeatureEnabled = useIsFeatureEnabled(); + const organizationsAvailable = + isFeatureEnabled(Feature.Organizations) && + realmRepresentation.organizationsEnabled; const [resourceServer, setResourceServer] = useState(); @@ -27,9 +34,14 @@ export default function useSortedResourceTypes({ const resourceTypes = useMemo(() => { const allResourceTypes = resourceServer?.authorizationSchema?.resourceTypes; return allResourceTypes - ? sortBy(Object.values(allResourceTypes), "type") + ? sortBy( + Object.values(allResourceTypes).filter( + ({ type }) => type !== "Organizations" || organizationsAvailable, + ), + "type", + ) : []; - }, [resourceServer]); + }, [resourceServer, organizationsAvailable]); return resourceTypes; } diff --git a/js/apps/admin-ui/test/permissions/main.spec.ts b/js/apps/admin-ui/test/permissions/main.spec.ts index e7263d077686..9dfd02ab39bf 100644 --- a/js/apps/admin-ui/test/permissions/main.spec.ts +++ b/js/apps/admin-ui/test/permissions/main.spec.ts @@ -17,7 +17,9 @@ import { goToPermissions, openSearchPanel, pickGroup, + pickOrganization, removeGroup, + removeOrganization, selectClient, selectResource, } from "./main.ts"; @@ -27,7 +29,10 @@ test.describe.serial("Permissions section tests", () => { const realmName = `permissions-${uuid()}`; test.beforeAll(async () => { - await adminClient.createRealm(realmName, { adminPermissionsEnabled: true }); + await adminClient.createRealm(realmName, { + adminPermissionsEnabled: true, + organizationsEnabled: true, + }); await adminClient.createUser({ realm: realmName, username: "test-user", @@ -35,6 +40,16 @@ test.describe.serial("Permissions section tests", () => { }); await adminClient.createGroup("one", realmName); await adminClient.createGroup("two", realmName); + await adminClient.createOrganization({ + realm: realmName, + name: "org-one", + domains: [{ name: "one.example.com", verified: false }], + }); + await adminClient.createOrganization({ + realm: realmName, + name: "org-two", + domains: [{ name: "two.example.com", verified: false }], + }); }); test.afterAll(() => adminClient.deleteRealm(realmName)); @@ -83,6 +98,43 @@ test.describe.serial("Permissions section tests", () => { await assertRowExists(page, "test-policy"); }); + test("should edit organization permission", async ({ page }) => { + await clickCreatePermission(page); + await selectResource(page, "Organizations"); + await fillPermissionForm(page, { + name: "test-organization-permission", + scopes: ["view"], + enforcementMode: "specificResources", + }); + await pickOrganization(page, "org-one"); + await pickOrganization(page, "org-two"); + + await clickCreateNewPolicy(page); + await fillPolicyForm( + page, + { + name: "test-policy-org", + description: "test-description", + type: "User", + user: "test-user", + }, + true, + ); + + await clickCreatePolicySaveButton(page); + await assertNotificationMessage(page, "Successfully created the policy"); + await clickSaveButton(page); + await removeOrganization(page, "org-two"); + await clickSaveButton(page); + await assertNotificationMessage( + page, + "Successfully updated the permission", + ); + + await goToPermissions(page); + await deletePermission(page, "test-organization-permission"); + }); + test("should edit group permission", async ({ page }) => { await clickCreatePermission(page); await selectResource(page, "Groups"); @@ -145,6 +197,15 @@ test.describe.serial("Permissions section tests", () => { resourceType: "Clients", scopes: ["view"], }); + await adminClient.createPermission({ + realm: realmName, + name: "organization-permission", + description: "", + policies: [id!], + resources: [await adminClient.findOrganizationId("org-one", realmName)], + resourceType: "Organizations", + scopes: ["view"], + }); }); test("should evaluate permissions success", async ({ page }) => { @@ -180,6 +241,19 @@ test.describe.serial("Permissions section tests", () => { await expect(page.getByTestId("select-group-button")).toBeVisible(); }); + + test("should evaluate organization permissions", async ({ page }) => { + await goToEvaluation(page); + await selectItem(page, page.getByTestId("user"), "other-user"); + await selectItem(page, "#resourceType", "Organizations"); + await pickOrganization(page, "org-one"); + await selectItem(page, "#authScopes", "view"); + await page.getByTestId("permission-eval").click(); + + await expect( + page.getByRole("heading", { name: "Success alert: org-one with" }), + ).toBeVisible(); + }); }); test.describe.serial("permission search", () => { diff --git a/js/apps/admin-ui/test/permissions/main.ts b/js/apps/admin-ui/test/permissions/main.ts index cf4750ebd81f..24eadb9c7d5c 100644 --- a/js/apps/admin-ui/test/permissions/main.ts +++ b/js/apps/admin-ui/test/permissions/main.ts @@ -2,7 +2,7 @@ import type PolicyRepresentation from "@keycloak/keycloak-admin-client/lib/defs/ import type { Page } from "@playwright/test"; import { selectItem } from "../utils/form.ts"; import { confirmModal } from "../utils/modal.ts"; -import { clickRowKebabItem } from "../utils/table.ts"; +import { clickRowKebabItem, clickSelectRow } from "../utils/table.ts"; type PermissionForm = PolicyRepresentation & { enforcementMode?: "allResources" | "specificResources"; @@ -52,6 +52,25 @@ export async function removeGroup(page: Page, groupName: string) { .click(); } +export async function pickOrganization(page: Page, organizationName: string) { + await page.getByTestId("select-organization-button").click(); + const modal = page.getByTestId("select-organization-modal"); + await modal.locator("table tbody").waitFor(); + await clickSelectRow(page, "Organizations", organizationName); + await page.getByTestId("confirm").click(); + await modal.waitFor({ state: "hidden" }); +} + +export async function removeOrganization( + page: Page, + organizationName: string, +) { + await page + .getByRole("row", { name: organizationName }) + .getByRole("button", { name: "Remove" }) + .click(); +} + export async function clickCreateNewPolicy(page: Page) { await page.getByTestId("select-createNewPolicy-button").click(); } diff --git a/js/apps/admin-ui/test/utils/AdminClient.ts b/js/apps/admin-ui/test/utils/AdminClient.ts index fa93930cb8f4..b1b4689c1870 100644 --- a/js/apps/admin-ui/test/utils/AdminClient.ts +++ b/js/apps/admin-ui/test/utils/AdminClient.ts @@ -488,6 +488,18 @@ class AdminClient { await this.#client.organizations.create(org); } + async findOrganizationId( + name: string, + realm: string = this.#client.realmName, + ) { + await this.#login(); + const found = await this.#client.organizations.find({ + search: name, + realm, + }); + return found[0].id!; + } + async deleteOrganization( name: string, realm: string = this.#client.realmName,