Skip to content

Fix cascade deletion of client roles in keycloak_generic_role_mapper #1357

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix cascade deletion of client roles in keycloak_generic_role_mapper #1357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad894de
[fix] delete single client scope
foch01 Oct 17, 2025
36ec6ea
[fix] Add Test for DeleteRoleScopeMapping
foch01 Oct 20, 2025
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
25 changes: 11 additions & 14 deletions keycloak/role_scope_mapping.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,19 +61,16 @@ func (keycloakClient *KeycloakClient) GetRoleScopeMapping(ctx context.Context, r

func (keycloakClient *KeycloakClient) DeleteRoleScopeMapping(ctx context.Context, realmId string, clientId string, clientScopeId string, role *Role) error {
roleUrl := roleScopeMappingUrl(realmId, clientId, clientScopeId, role)
if role.ClientRole {
return keycloakClient.delete(ctx, roleUrl, nil)
} else {
body := [1]RealmRoleRepresentation{
{
Id: role.Id,
Name: role.Name,
Description: role.Description,
Composite: role.Composite,
ClientRole: role.ClientRole,
ContainerId: role.ContainerId,
},
}
return keycloakClient.delete(ctx, roleUrl, body)

body := [1]RealmRoleRepresentation{
{
Id: role.Id,
Name: role.Name,
Description: role.Description,
Composite: role.Composite,
ClientRole: role.ClientRole,
ContainerId: role.ContainerId,
},
}
return keycloakClient.delete(ctx, roleUrl, body)
}
96 changes: 96 additions & 0 deletions provider/resource_keycloak_generic_role_mapper_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,3 +376,99 @@ resource "keycloak_generic_role_mapper" "client-with-some-other-role" {
}
`, testAccRealm.Realm, clientName, someRoleName, someOtherRoleName)
}

func TestAccKeycloakGenericClientRoleMapper_deleteRoleScopeMappingRealmRole(t *testing.T) {
t.Parallel()

var role = &keycloak.Role{}
var childClient = &keycloak.GenericClient{}

roleName := acctest.RandomWithPrefix("tf-acc")
childClientName := acctest.RandomWithPrefix("tf-acc")

resource.Test(t, resource.TestCase{
ProviderFactories: testAccProviderFactories,
PreCheck: func() { testAccPreCheck(t) },
Steps: []resource.TestStep{
{
Config: testKeycloakGenericClientRoleMapper_realmRole(roleName, childClientName),
Check: resource.ComposeTestCheckFunc(
testAccCheckKeycloakGenericClientRoleMapperExists("keycloak_generic_client_role_mapper.child-client-with-realm-role"),
testAccCheckKeycloakRoleFetch("keycloak_role.realm-role", role),
testAccCheckKeycloakGenericClientFetch("keycloak_openid_client.child-client", childClient),
),
},
{
PreConfig: func() {
err := keycloakClient.DeleteRoleScopeMapping(testCtx, childClient.RealmId, childClient.Id, "", role)
if err != nil {
t.Fatalf("Error deleting realm role mapping: %s", err)
}
},
Config: testKeycloakGenericClientRoleMapper_realmRole(roleName, childClientName),
Check: testAccCheckKeycloakGenericClientRoleMapperExists("keycloak_generic_client_role_mapper.child-client-with-realm-role"),
},
},
})
}

func TestAccKeycloakGenericClientRoleMapper_deleteRoleScopeMappingClientRole(t *testing.T) {
t.Parallel()

var role = &keycloak.Role{}
var childClient = &keycloak.GenericClient{}

parentClientName := acctest.RandomWithPrefix("tf-acc")
parentRoleName := acctest.RandomWithPrefix("tf-acc")
childClientName := acctest.RandomWithPrefix("tf-acc")

resource.Test(t, resource.TestCase{
ProviderFactories: testAccProviderFactories,
PreCheck: func() { testAccPreCheck(t) },
Steps: []resource.TestStep{
{
Config: testKeycloakGenericClientRoleMapper_basic(parentClientName, parentRoleName, childClientName),
Check: resource.ComposeTestCheckFunc(
testAccCheckKeycloakGenericClientRoleMapperExists("keycloak_generic_client_role_mapper.child-client-with-parent-client-role"),
testAccCheckKeycloakRoleFetch("keycloak_role.parent-role", role),
testAccCheckKeycloakGenericClientFetch("keycloak_openid_client.child-client", childClient),
),
},
{
PreConfig: func() {
err := keycloakClient.DeleteRoleScopeMapping(testCtx, childClient.RealmId, childClient.Id, "", role)
if err != nil {
t.Fatalf("Error deleting client role mapping: %s", err)
}
},
Config: testKeycloakGenericClientRoleMapper_basic(parentClientName, parentRoleName, childClientName),
Check: testAccCheckKeycloakGenericClientRoleMapperExists("keycloak_generic_client_role_mapper.child-client-with-parent-client-role"),
},
},
})
}

func testKeycloakGenericClientRoleMapper_realmRole(roleName, childClientName string) string {
return fmt.Sprintf(`
data "keycloak_realm" "realm" {
realm = "%s"
}

resource "keycloak_role" "realm-role" {
realm_id = data.keycloak_realm.realm.id
name = "%s"
}

resource "keycloak_openid_client" "child-client" {
realm_id = data.keycloak_realm.realm.id
client_id = "%s"
access_type = "PUBLIC"
}

resource "keycloak_generic_client_role_mapper" "child-client-with-realm-role" {
realm_id = data.keycloak_realm.realm.id
client_id = keycloak_openid_client.child-client.id
role_id = keycloak_role.realm-role.id
}
`, testAccRealm.Realm, roleName, childClientName)
}