diff --git a/docs/source/index.rst b/docs/source/index.rst index 597cfb2..2b41d35 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -276,3 +276,19 @@ Main methods:: # Function to trigger user sync from provider sync_users(storage_id="storage_di", action="action") + + # List public RSA keys + components = keycloak_admin.keys + + # List all keys + components = keycloak_admin.get_components(query={"parent":"example_realm", "type":"org.keycloak.keys.KeyProvider"}) + + # Create a new RSA key + component = keycloak_admin.create_component({"name":"rsa-generated","providerId":"rsa-generated","providerType":"org.keycloak.keys.KeyProvider","parentId":"example_realm","config":{"priority":["100"],"enabled":["true"],"active":["true"],"algorithm":["RS256"],"keySize":["2048"]}}) + + # Update the key + component_details['config']['active'] = ["false"] + keycloak_admin.update_component(component['id']) + + # Delete the key + keycloak_admin.delete_component(component['id']) diff --git a/keycloak/keycloak_admin.py b/keycloak/keycloak_admin.py index dca5e23..c3ef9a9 100644 --- a/keycloak/keycloak_admin.py +++ b/keycloak/keycloak_admin.py @@ -42,7 +42,7 @@ from .urls_patterns import URL_ADMIN_SERVER_INFO, URL_ADMIN_CLIENT_AUTHZ_RESOURC URL_ADMIN_GROUP_MEMBERS, URL_ADMIN_USER_STORAGE, URL_ADMIN_GROUP_PERMISSIONS, URL_ADMIN_IDPS, \ URL_ADMIN_USER_CLIENT_ROLES_AVAILABLE, URL_ADMIN_USERS, URL_ADMIN_CLIENT_SCOPES, \ URL_ADMIN_CLIENT_SCOPES_ADD_MAPPER, URL_ADMIN_CLIENT_SCOPE, URL_ADMIN_CLIENT_SECRETS, \ - URL_ADMIN_USER_REALM_ROLES, URL_ADMIN_REALM + URL_ADMIN_USER_REALM_ROLES, URL_ADMIN_REALM, URL_ADMIN_COMPONENTS, URL_ADMIN_COMPONENT, URL_ADMIN_KEYS class KeycloakAdmin: @@ -1228,6 +1228,94 @@ class KeycloakAdmin: data_raw = self.raw_get(URL_ADMIN_CLIENT_SECRETS.format(**params_path)) return raise_error_from_response(data_raw, KeycloakGetError) + def get_components(self, query=None): + """ + Return a list of components, filtered according to query parameters + + ComponentRepresentation + https://www.keycloak.org/docs-api/8.0/rest-api/index.html#_componentrepresentation + + :param query: Query parameters (optional) + :return: components list + """ + params_path = {"realm-name": self.realm_name} + data_raw = self.raw_get(URL_ADMIN_COMPONENTS.format(**params_path), + data=None, **query) + return raise_error_from_response(data_raw, KeycloakGetError) + + def create_component(self, payload): + """ + Create a new component. + + ComponentRepresentation + https://www.keycloak.org/docs-api/8.0/rest-api/index.html#_componentrepresentation + + :param payload: ComponentRepresentation + + :return: UserRepresentation + """ + params_path = {"realm-name": self.realm_name} + + data_raw = self.raw_post(URL_ADMIN_COMPONENTS.format(**params_path), + data=json.dumps(payload)) + return raise_error_from_response(data_raw, KeycloakGetError, expected_code=201) + + def get_component(self, component_id): + """ + Get representation of the component + + :param component_id: Component id + + ComponentRepresentation + https://www.keycloak.org/docs-api/8.0/rest-api/index.html#_componentrepresentation + + :return: ComponentRepresentation + """ + params_path = {"realm-name": self.realm_name, "component-id": component_id} + data_raw = self.raw_get(URL_ADMIN_COMPONENT.format(**params_path)) + return raise_error_from_response(data_raw, KeycloakGetError) + + def update_component(self, component_id, payload): + """ + Update the component + + :param component_id: Component id + :param payload: ComponentRepresentation + https://www.keycloak.org/docs-api/8.0/rest-api/index.html#_componentrepresentation + + :return: Http response + """ + params_path = {"realm-name": self.realm_name, "component-id": component_id} + data_raw = self.raw_put(URL_ADMIN_COMPONENT.format(**params_path), + data=json.dumps(payload)) + return raise_error_from_response(data_raw, KeycloakGetError, expected_code=204) + + def delete_component(self, component_id): + """ + Delete the component + + :param component_id: Component id + + :return: Http response + """ + params_path = {"realm-name": self.realm_name, "component-id": component_id} + data_raw = self.raw_delete(URL_ADMIN_COMPONENT.format(**params_path)) + return raise_error_from_response(data_raw, KeycloakGetError, expected_code=204) + + def get_keys(self): + """ + Return a list of keys, filtered according to query parameters + + KeysMetadataRepresentation + https://www.keycloak.org/docs-api/8.0/rest-api/index.html#_key_resource + + :return: keys list + """ + params_path = {"realm-name": self.realm_name} + data_raw = self.raw_get(URL_ADMIN_KEYS.format(**params_path), + data=None) + return raise_error_from_response(data_raw, KeycloakGetError) + def raw_get(self, *args, **kwargs): """ diff --git a/keycloak/urls_patterns.py b/keycloak/urls_patterns.py index 6f69495..f08a422 100644 --- a/keycloak/urls_patterns.py +++ b/keycloak/urls_patterns.py @@ -82,3 +82,7 @@ URL_ADMIN_REALM_ROLES_ROLE_BY_NAME = "admin/realms/{realm-name}/roles/{role-name URL_ADMIN_FLOWS = "admin/realms/{realm-name}/authentication/flows" URL_ADMIN_FLOWS_EXECUTIONS = "admin/realms/{realm-name}/authentication/flows/{flow-alias}/executions" + +URL_ADMIN_COMPONENTS = "admin/realms/{realm-name}/components" +URL_ADMIN_COMPONENT = "admin/realms/{realm-name}/components/{component-id}" +URL_ADMIN_KEYS = "admin/realms/{realm-name}/keys"