Browse Source

feat: added KeycloakAdmin.update_client_authz_resource() (#462)

* feat: added KeycloakAdmin.update_client_authz_resource()

Signed-off-by: Cainã S. G <p-caina.galante@pd.tec.br>

* fix: linting

Signed-off-by: Cainã S. G <p-caina.galante@pd.tec.br>

* fix: test expecting and different anwser from server

Signed-off-by: Cainã S. G <p-caina.galante@pd.tec.br>

* fix: test expecting and different anwser from server

Signed-off-by: Cainã S. G <p-caina.galante@pd.tec.br>

---------

Signed-off-by: Cainã S. G <p-caina.galante@pd.tec.br>
Co-authored-by: Cainã S. G <p-caina.galante@pd.tec.br>
pull/464/head v3.3.0
Cainã 2 years ago
committed by GitHub
parent
commit
326a2d343a
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 33
      src/keycloak/keycloak_admin.py
  2. 17
      tests/test_keycloak_admin.py

33
src/keycloak/keycloak_admin.py

@ -1533,6 +1533,39 @@ class KeycloakAdmin:
data_raw, KeycloakPostError, expected_codes=[201], skip_exists=skip_exists data_raw, KeycloakPostError, expected_codes=[201], skip_exists=skip_exists
) )
def update_client_authz_resource(self, client_id, resource_id, payload):
"""Update resource of client.
Any parameter missing from the ResourceRepresentation in the payload WILL be set
to default by the Keycloak server.
:param client_id: id in ClientRepresentation
https://www.keycloak.org/docs-api/18.0/rest-api/index.html#_clientrepresentation
:type client_id: str
:param payload: ResourceRepresentation
https://www.keycloak.org/docs-api/18.0/rest-api/index.html#_resourcerepresentation
:type payload: dict
:param client_id: id in ClientRepresentation
https://www.keycloak.org/docs-api/18.0/rest-api/index.html#_clientrepresentation
:type client_id: str
:param resource_id: id in ResourceRepresentation
https://www.keycloak.org/docs-api/18.0/rest-api/index.html#_resourcerepresentation
:type resource_id: str
:return: Keycloak server response
:rtype: bytes
"""
params_path = {
"realm-name": self.connection.realm_name,
"id": client_id,
"resource-id": resource_id,
}
data_raw = self.connection.raw_put(
urls_patterns.URL_ADMIN_CLIENT_AUTHZ_RESOURCE.format(**params_path),
data=json.dumps(payload),
)
return raise_error_from_response(data_raw, KeycloakPutError, expected_codes=[204])
def delete_client_authz_resource(self, client_id: str, resource_id: str): def delete_client_authz_resource(self, client_id: str, resource_id: str):
"""Delete a client resource. """Delete a client resource.

17
tests/test_keycloak_admin.py

@ -851,7 +851,22 @@ def test_clients(admin: KeycloakAdmin, realm: str):
client_id=auth_client_id, payload={"name": "temp-resource"} client_id=auth_client_id, payload={"name": "temp-resource"}
) )
assert res["name"] == "temp-resource", res assert res["name"] == "temp-resource", res
temp_resource_id = res["_id"]
temp_resource_id: str = res["_id"]
# Test update authz resources
admin.update_client_authz_resource(
client_id=auth_client_id,
resource_id=temp_resource_id,
payload={"name": "temp-updated-resource"},
)
res = admin.get_client_authz_resource(client_id=auth_client_id, resource_id=temp_resource_id)
assert res["name"] == "temp-updated-resource", res
with pytest.raises(KeycloakPutError) as err:
admin.update_client_authz_resource(
client_id=auth_client_id,
resource_id="invalid_resource_id",
payload={"name": "temp-updated-resource"},
)
assert err.match("404: b''"), err
admin.delete_client_authz_resource(client_id=auth_client_id, resource_id=temp_resource_id) admin.delete_client_authz_resource(client_id=auth_client_id, resource_id=temp_resource_id)
with pytest.raises(KeycloakGetError) as err: with pytest.raises(KeycloakGetError) as err:
admin.get_client_authz_resource(client_id=auth_client_id, resource_id=temp_resource_id) admin.get_client_authz_resource(client_id=auth_client_id, resource_id=temp_resource_id)

Loading…
Cancel
Save