Browse Source

fix: name of client_id parameter

The name client_role_id for the parameter is confusing because it
expects the client_id.
enhancement/docs v3.8.3
Tobias Genannt 11 months ago
committed by Marcos Pereira
parent
commit
70af4bf256
  1. 8
      src/keycloak/keycloak_admin.py
  2. 4
      tests/test_keycloak_admin.py

8
src/keycloak/keycloak_admin.py

@ -2453,14 +2453,14 @@ class KeycloakAdmin:
) )
return raise_error_from_response(data_raw, KeycloakPostError, expected_codes=[204]) return raise_error_from_response(data_raw, KeycloakPostError, expected_codes=[204])
def update_client_role(self, client_role_id, role_name, payload):
def update_client_role(self, client_id, role_name, payload):
"""Update a client role. """Update a client role.
RoleRepresentation RoleRepresentation
https://www.keycloak.org/docs-api/18.0/rest-api/index.html#_rolerepresentation https://www.keycloak.org/docs-api/18.0/rest-api/index.html#_rolerepresentation
:param client_role_id: id of client (not client-id)
:type client_role_id: str
:param client_id: id of client (not client-id)
:type client_id: str
:param role_name: role's name (not id!) :param role_name: role's name (not id!)
:type role_name: str :type role_name: str
:param payload: RoleRepresentation :param payload: RoleRepresentation
@ -2470,7 +2470,7 @@ class KeycloakAdmin:
""" """
params_path = { params_path = {
"realm-name": self.connection.realm_name, "realm-name": self.connection.realm_name,
"id": client_role_id,
"id": client_id,
"role-name": role_name, "role-name": role_name,
} }
data_raw = self.connection.raw_put( data_raw = self.connection.raw_put(

4
tests/test_keycloak_admin.py

@ -1638,14 +1638,14 @@ def test_client_roles(admin: KeycloakAdmin, client: str):
# Test update client role # Test update client role
res = admin.update_client_role( res = admin.update_client_role(
client_role_id=client,
client_id=client,
role_name="client-role-test", role_name="client-role-test",
payload={"name": "client-role-test-update"}, payload={"name": "client-role-test-update"},
) )
assert res == dict() assert res == dict()
with pytest.raises(KeycloakPutError) as err: with pytest.raises(KeycloakPutError) as err:
res = admin.update_client_role( res = admin.update_client_role(
client_role_id=client,
client_id=client,
role_name="client-role-test", role_name="client-role-test",
payload={"name": "client-role-test-update"}, payload={"name": "client-role-test-update"},
) )

Loading…
Cancel
Save