Skip to content

Allow custom protocol mappers to be recognized as organization-aware in OrganizationScope #49025

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

Open
kota65535 wants to merge 1 commit into
base: main
Choose a base branch
from
+25 −4
Open

Allow custom protocol mappers to be recognized as organization-aware in OrganizationScope #49025

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
Diff view
3 changes: 2 additions & 1 deletion ...in/java/org/keycloak/organization/protocol/mappers/oidc/OrganizationMembershipMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
import org.keycloak.protocol.oidc.mappers.OIDCAccessTokenMapper;
import org.keycloak.protocol.oidc.mappers.OIDCAttributeMapperHelper;
import org.keycloak.protocol.oidc.mappers.OIDCIDTokenMapper;
import org.keycloak.protocol.oidc.mappers.OrganizationAwareMapper;
import org.keycloak.protocol.oidc.mappers.TokenIntrospectionTokenMapper;
import org.keycloak.protocol.oidc.mappers.UserInfoTokenMapper;
import org.keycloak.provider.EnvironmentDependentProviderFactory;
Expand All @@ -54,7 +55,7 @@
import static org.keycloak.protocol.oidc.mappers.OIDCAttributeMapperHelper.JSON_TYPE;
import static org.keycloak.protocol.oidc.mappers.OIDCAttributeMapperHelper.TOKEN_CLAIM_NAME;

public class OrganizationMembershipMapper extends AbstractOIDCProtocolMapper implements OIDCAccessTokenMapper, OIDCIDTokenMapper, UserInfoTokenMapper, TokenIntrospectionTokenMapper, EnvironmentDependentProviderFactory {
public class OrganizationMembershipMapper extends AbstractOIDCProtocolMapper implements OIDCAccessTokenMapper, OIDCIDTokenMapper, UserInfoTokenMapper, TokenIntrospectionTokenMapper, EnvironmentDependentProviderFactory, OrganizationAwareMapper {

public static final String PROVIDER_ID = "oidc-organization-membership-mapper";
public static final String ADD_ORGANIZATION_ATTRIBUTES = "addOrganizationAttributes";
Expand Down
10 changes: 7 additions & 3 deletions ...ices/src/main/java/org/keycloak/organization/protocol/mappers/oidc/OrganizationScope.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,11 @@
import org.keycloak.models.OrganizationModel;
import org.keycloak.models.ProtocolMapperModel;
import org.keycloak.models.UserModel;
import org.keycloak.protocol.ProtocolMapper;
import org.keycloak.protocol.oidc.OIDCLoginProtocol;
import org.keycloak.protocol.oidc.OIDCLoginProtocolFactory;
import org.keycloak.protocol.oidc.TokenManager;
import org.keycloak.protocol.oidc.mappers.OrganizationAwareMapper;
import org.keycloak.sessions.AuthenticationSessionModel;
import org.keycloak.utils.StringUtil;

Expand Down Expand Up @@ -415,9 +417,11 @@ private static ClientScopeModel resolveClientScope(KeycloakSession session, Stri
ClientScopeModel clientScope = getClientScope(client, scope);

if (clientScope != null) {
Stream<String> mappers = clientScope.getProtocolMappersStream().map(ProtocolMapperModel::getProtocolMapper);

if (mappers.noneMatch(OrganizationMembershipMapper.PROVIDER_ID::equals)) {
if (clientScope.getProtocolMappersStream()
.map(ProtocolMapperModel::getProtocolMapper)
.map(id -> session.getKeycloakSessionFactory().getProviderFactory(ProtocolMapper.class, id))
.filter(Objects::nonNull)
.noneMatch(OrganizationAwareMapper.class::isInstance)) {
Set<String> nonOrganizationScopes = session.getAttributeOrDefault(UNSUPPORTED_ORGANIZATION_SCOPES_ATTRIBUTE, Set.of());

if (nonOrganizationScopes.isEmpty()) {
Expand Down
16 changes: 16 additions & 0 deletions services/src/main/java/org/keycloak/protocol/oidc/mappers/OrganizationAwareMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package org.keycloak.protocol.oidc.mappers;

/**
* Marker interface for protocol mappers that handle organization claims.
*
* <p>Mappers implementing this interface are recognized by
* {@link org.keycloak.organization.protocol.mappers.oidc.OrganizationScope OrganizationScope}
* as organization-aware, enabling scope-based organization resolution for the
* client scope containing the mapper.
*
* <p>This follows the same pattern as {@link OIDCAccessTokenMapper} and
* {@link UserInfoTokenMapper}, where mapper capabilities are declared
* through interface implementation and checked via {@code instanceof}.
*/
public interface OrganizationAwareMapper {
}
Loading