8000 Add id and description when building ResourceType representation by sguilhen · Pull Request #48499 · keycloak/keycloak · GitHub
[go: up one dir, main page]
Skip to content

Add id and description when building ResourceType representation #48499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pedroigor merged 1 commit into from
Apr 27, 2026
Merged

Add id and description when building ResourceType representation #48499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
8000
Diff view
9 changes: 9 additions & 0 deletions scim/core/src/main/java/org/keycloak/scim/resource/spi/ScimResourceTypeProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ default String getName() {
return getResourceType().getSimpleName();
}

/**
* Returns a human-readable description of the resource type managed by this provider.
*
* @return the description of the resource type
*/
default String getDescription() {
return getName();
}

/**
* Returns the schema name of the resource type managed by this provider.
*
Expand Down
2 changes: 2 additions & 0 deletions scim/model/src/main/java/org/keycloak/scim/model/resourcetype/ResourceTypeProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,9 @@ private ResourceType toRepresentation(ScimResourceTypeProviderFactory<? extends
throw new RuntimeException("Could not instantiate resource type representation for provider " + factory.getId(), e);
}

representation.setId(provider.getName());
representation.setName(provider.getName());
representation.setDescription(provider.getDescription());
representation.setEndpoint("/" + factory.getId());
representation.setSchema(provider.getSchema());

Expand Down
5 changes: 5 additions & 0 deletions scim/model/src/main/java/org/keycloak/scim/model/user/UserResourceTypeProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@ public UserResourceTypeProvider(KeycloakSession session) {
super(session, new UserCoreModelSchema(session), List.of(new UserEnterpriseModelSchema(session)));
}

@Override
public String getDescription() {
return "User Account";
}

@Override
public User onCreate(User resource) {
UserProfileProvider provider = session.getProvider(UserProfileProvider.class);
Expand Down
9 changes: 6 additions & 3 deletions scim/tests/base/src/test/java/org/keycloak/tests/scim/tck/ResourceTypeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,17 @@ public void testGet() {
assertNotNull(response);
assertEquals(2, response.getResources().size());

assertResourceType(response, User.class, List.of(ENTERPRISE_USER_SCHEMA));
assertResourceType(response, Group.class, List.of());
assertResourceType(response, User.class, "User Account", List.of(ENTERPRISE_USER_SCHEMA));
assertResourceType(response, Group.class, "Group", List.of());
}

private static void assertResourceType(ListResponse<ResourceType> response, Class<? extends ResourceTypeRepresentation> resourceType, List<String> expectedSchemaExtensions) {
private static void assertResourceType(ListResponse<ResourceType> response, Class<? extends ResourceTypeRepresentation> resourceType,
String expectedDescription, List<String> expectedSchemaExtensions) {
ResourceType representation = response.getResources().stream().filter(r -> r.getName().equals(resourceType.getSimpleName())).findAny().orElse(null);

assertNotNull(representation);
assertEquals(resourceType.getSimpleName(), representation.getId());
assertEquals(expectedDescription, representation.getDescription());
assertEquals("/" + representation.getName() + "s", representation.getEndpoint());
assertEquals(getCoreSchema(resourceType), representation.getSchema());

Expand Down
Loading
0