Skip to content

Add configuration for SaaS app role return in ID token #8181

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
SujanSanjula96 merged 1 commit into from
Jun 24, 2026
Merged

Add configuration for SaaS app role return in ID token #8181

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
7 changes: 7 additions & 0 deletions ...dentity/application/authentication/framework/handler/claims/impl/DefaultClaimHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
import static org.wso2.carbon.identity.application.authentication.framework.util.FrameworkConstants.AdaptiveAuthentication.ALLOW_AUTHENTICATED_SUB_UPDATE;
import static org.wso2.carbon.identity.application.authentication.framework.util.FrameworkConstants.Config.SEND_ONLY_LOCALLY_MAPPED_ROLES_OF_IDP;
import static org.wso2.carbon.identity.application.authentication.framework.util.FrameworkConstants.JSAttributes.PROP_USERNAME_UPDATED_EXTERNALLY;
import static org.wso2.carbon.identity.application.authentication.framework.util.FrameworkConstants.RETURN_ROLES_IN_SAAS_APPS_IN_ID_TOKEN;
import static org.wso2.carbon.identity.core.util.IdentityUtil.getLocalGroupsClaimURI;

/**
Expand Down Expand Up @@ -429,6 +430,12 @@ protected List<String> getAppAssociatedRolesOfLocalUser(StepConfig stepConfig, A
if (serviceProvider == null) {
return null;
}
/* If the application and user are in different tenant domains and the ReturnRolesInSaaSAppsInIDToken config
is disabled, return an empty list. */
if (!StringUtils.equals(serviceProvider.getTenantDomain(), authenticatedUser.getTenantDomain()) &&
!Boolean.parseBoolean(IdentityUtil.getProperty(RETURN_ROLES_IN_SAAS_APPS_IN_ID_TOKEN))) {
return new ArrayList<>();
}
String applicationId = serviceProvider.getApplicationResourceId();
return FrameworkUtils.getAppAssociatedRolesOfLocalUser(authenticatedUser, applicationId);
}
Expand Down
2 changes: 2 additions & 0 deletions ...rg/wso2/carbon/identity/application/authentication/framework/util/FrameworkConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,8 @@ public abstract class FrameworkConstants {
public static final String AMR = "amr";
public static final String USER_ASSERTION = "userAssertion";

public static final String RETURN_ROLES_IN_SAAS_APPS_IN_ID_TOKEN = "ReturnRolesInSaaSAppsInIDToken";

// Authentication entity constants.
public static final String AUTH_ENTITY = "auth_entity";
public static final String AUTH_ENTITY_AGENT = "agent";
Expand Down
1 change: 1 addition & 0 deletions features/identity-core/org.wso2.carbon.identity.core.server.feature/resources/identity.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3049,6 +3049,7 @@
</NotificationChannel>
<PASTRCookieMaxAge>-1</PASTRCookieMaxAge>
<MarkStepCompletedOnInterrupt>true</MarkStepCompletedOnInterrupt>
<ReturnRolesInSaaSAppsInIDToken>false</ReturnRolesInSaaSAppsInIDToken>

<TenantLevelAuthenticationConfigForAuthSequence>true</TenantLevelAuthenticationConfigForAuthSequence>
<EnhancedOrganizationAuthenticationFeatureEnabled>true</EnhancedOrganizationAuthenticationFeatureEnabled>
Expand Down
1 change: 1 addition & 0 deletions ...ures/identity-core/org.wso2.carbon.identity.core.server.feature/resources/identity.xml.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5298,6 +5298,7 @@
<PASTRCookieMaxAge>{{pastr_cookie.max_age}}</PASTRCookieMaxAge>
<ResolveTenantDomainFromUsername>{{resolve_tenant_domain_from_username.enabled | default(false)}}</ResolveTenantDomainFromUsername>
<MarkStepCompletedOnInterrupt>{{authentication.mark_step_completed_on_interrupt}}</MarkStepCompletedOnInterrupt>
<ReturnRolesInSaaSAppsInIDToken>{{saas_apps.return_roles_in_id_token}}</ReturnRolesInSaaSAppsInIDToken>

<!-- API filtering controls -->
<APIFiltering>
Expand Down
4 changes: 3 additions & 1 deletion ...y.core.server.feature/resources/org.wso2.carbon.identity.core.server.feature.default.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2405,5 +2405,7 @@
"circuit_breaker.min_calls_to_evaluate": 15,
"circuit_breaker.failure_rate_threshold": 0.5,
"circuit_breaker.open_duration": 60000,
"circuit_breaker.max_in_flight": 20
"circuit_breaker.max_in_flight": 20,

Comment thread
PasinduYeshan marked this conversation as resolved.
"saas_apps.return_roles_in_id_token": false
}
Loading