added send_verify_email, reset_password, send_update_account, server_info, get_sessions, get_clients.

keycloak/keycloak_admin.py

@@ -14,7 +14,9 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-from keycloak.urls_patterns import URL_ADMIN_USERS_COUNT, URL_ADMIN_USER
+from keycloak.urls_patterns import URL_ADMIN_USERS_COUNT, URL_ADMIN_USER, URL_ADMIN_USER_CONSENTS, \
+    URL_ADMIN_SEND_UPDATE_ACCOUNT, URL_ADMIN_RESET_PASSWORD, URL_ADMIN_SEND_VERIFY_EMAIL, URL_ADMIN_GET_SESSIONS, \
+    URL_ADMIN_SERVER_INFO, URL_ADMIN_CLIENTS
 from .keycloak_openid import KeycloakOpenID
 
 from .exceptions import raise_error_from_response, KeycloakGetError, KeycloakSecretNotFound, \
@@ -111,6 +113,8 @@ class KeycloakAdmin:
         UserRepresentation
         http://www.keycloak.org/docs-api/3.3/rest-api/index.html#_userrepresentation
 
+        :param payload: UserRepresentation
+
         :return: UserRepresentation
         """
         params_path = {"realm-name": self.realm_name}
@@ -132,8 +136,9 @@ class KeycloakAdmin:
         """
         Get representation of the user
 
-        UserRepresentation
-        http://www.keycloak.org/docs-api/3.3/rest-api/index.html#_userrepresentation
+        :param user_id: User id
+
+        UserRepresentation: http://www.keycloak.org/docs-api/3.3/rest-api/index.html#_userrepresentation
 
         :return: UserRepresentation
         """
@@ -141,4 +146,134 @@ class KeycloakAdmin:
         data_raw = self.connection.raw_get(URL_ADMIN_USER.format(**params_path))
         return raise_error_from_response(data_raw, KeycloakGetError)
 
+    def update_user(self, user_id, payload):
+        """
+        Update the user
+
+        :param user_id: User id
+        :param payload: UserRepresentation
+
+        :return: Http response
+        """
+        params_path = {"realm-name": self.realm_name, "id": user_id}
+        data_raw = self.connection.raw_put(URL_ADMIN_USER.format(**params_path),
+                                           data=json.dumps(payload))
+        return raise_error_from_response(data_raw, KeycloakGetError, expected_code=204)
+
+    def delete_user(self, user_id):
+        """
+        Delete the user
+
+        :param user_id: User id
+
+        :return: Http response
+        """
+        params_path = {"realm-name": self.realm_name, "id": user_id}
+        data_raw = self.connection.raw_delete(URL_ADMIN_USER.format(**params_path))
+        return raise_error_from_response(data_raw, KeycloakGetError, expected_code=204)
+
+    def consents_user(self, user_id):
+        """
+        Get consents granted by the user
+
+        :param user_id: User id
+
+        :return: consents
+        """
+        params_path = {"realm-name": self.realm_name, "id": user_id}
+        data_raw = self.connection.raw_get(URL_ADMIN_USER_CONSENTS.format(**params_path))
+        return raise_error_from_response(data_raw, KeycloakGetError)
+
+    def send_update_account(self, user_id, payload, client_id=None, lifespan=None, redirect_uri=None):
+        """
+        Send a update account email to the user An email contains a
+        link the user can click to perform a set of required actions.
+
+        :param user_id:
+        :param payload:
+        :param client_id:
+        :param lifespan:
+        :param redirect_uri:
+
+        :return:
+        """
+        params_path = {"realm-name": self.realm_name, "id": user_id}
+        params_query = {"client_id": client_id, "lifespan": lifespan, "redirect_uri": redirect_uri}
+        data_raw = self.connection.raw_put(URL_ADMIN_SEND_UPDATE_ACCOUNT.format(**params_path),
+                                           data=payload, **params_query)
+        return raise_error_from_response(data_raw, KeycloakGetError)
+
+    def reset_password(self, user_id, password):
+        """
+        Set up a temporary password for the user User will have to reset the
+        temporary password next time they log in.
+
+        :param user_id: User id
+        :param password: A Temporary password
+
+        :return:
+        """
+        params_path = {"realm-name": self.realm_name, "id": user_id}
+        data_raw = self.connection.raw_put(URL_ADMIN_RESET_PASSWORD.format(**params_path),
+                                           data=json.dumps({'pass': password}))
+        return raise_error_from_response(data_raw, KeycloakGetError)
+
+    def send_verify_email(self, user_id, client_id=None, redirect_uri=None):
+        """
+        Send a update account email to the user An email contains a
+        link the user can click to perform a set of required actions.
+
+        :param user_id: User id
+        :param client_id: Client id
+        :param redirect_uri: Redirect uri
+
+        :return:
+        """
+        params_path = {"realm-name": self.realm_name, "id": user_id}
+        params_query = {"client_id": client_id, "redirect_uri": redirect_uri}
+        data_raw = self.connection.raw_put(URL_ADMIN_SEND_VERIFY_EMAIL.format(**params_path),
+                                           data={}, **params_query)
+        return raise_error_from_response(data_raw, KeycloakGetError)
+
+    def get_sessions(self, user_id):
+        """
+        Get sessions associated with the user
+
+        :param user_id: User id
+
+        UserSessionRepresentation
+        http://www.keycloak.org/docs-api/3.3/rest-api/index.html#_usersessionrepresentation
+
+        :return: UserSessionRepresentation
+        """
+        params_path = {"realm-name": self.realm_name, "id": user_id}
+        data_raw = self.connection.raw_get(URL_ADMIN_GET_SESSIONS.format(**params_path))
+        return raise_error_from_response(data_raw, KeycloakGetError)
+
+    def get_server_info(self):
+        """
+        Get themes, social providers, auth providers, and event listeners available on this server
+
+        :param user_id: User id
+
+        ServerInfoRepresentation
+        http://www.keycloak.org/docs-api/3.3/rest-api/index.html#_serverinforepresentation
+
+        :return: ServerInfoRepresentation
+        """
+        data_raw = self.connection.raw_get(URL_ADMIN_SERVER_INFO)
+        return raise_error_from_response(data_raw, KeycloakGetError)
+
+    def get_clients(self):
+        """
+        Get clients belonging to the realm Returns a list of clients belonging to the realm
+
+        ClientRepresentation
+        http://www.keycloak.org/docs-api/3.3/rest-api/index.html#_clientrepresentation
+
+        :return: ClientRepresentation
+        """
+        params_path = {"realm-name": self.realm_name}
+        data_raw = self.connection.raw_get(URL_ADMIN_CLIENTS.format(**params_path))
+        return raise_error_from_response(data_raw, KeycloakGetError)
 

keycloak/urls_patterns.py

@@ -28,3 +28,13 @@ URL_ENTITLEMENT = "realms/{realm-name}/authz/entitlement/{resource-server-id}"
 URL_ADMIN_USERS = "admin/realms/{realm-name}/users"
 URL_ADMIN_USERS_COUNT = "admin/realms/{realm-name}/users/count"
 URL_ADMIN_USER = "admin/realms/{realm-name}/users/{id}"
+URL_ADMIN_USER_CONSENTS = "admin/realms/{realm-name}/users/{id}/consents"
+URL_ADMIN_SEND_UPDATE_ACCOUNT = "admin/realms/{realm-name}/users/{id}/execute-actions-email"
+URL_ADMIN_SEND_VERIFY_EMAIL = "admin/realms/{realm-name}/users/{id}/send-verify-email"
+URL_ADMIN_RESET_PASSWORD = "admin/realms/{realm-name}/users/{id}/reset-password"
+URL_ADMIN_GET_SESSIONS = "admin/realms/{realm-name}/users/{id}/sessions"
+URL_ADMIN_SERVER_INFO = "admin/serverinfo"
+
+URL_ADMIN_CLIENTS = "admin/realms/{realm-name}/clients"
+
+