feat(iam): add LockUser and UnlockUser method (#728)

Co-authored-by: Laure-di <[email protected]>

Author: scaleway-bot

scaleway-async/scaleway_async/iam/v1alpha1/__init__.py

@@ -78,10 +78,12 @@
 from .types import ListSSHKeysResponse
 from .types import ListUsersRequest
 from .types import ListUsersResponse
+from .types import LockUserRequest
 from .types import RemoveGroupMemberRequest
 from .types import SetGroupMembersRequest
 from .types import SetRulesRequest
 from .types import SetRulesResponse
+from .types import UnlockUserRequest
 from .types import UpdateAPIKeyRequest
 from .types import UpdateApplicationRequest
 from .types import UpdateGroupRequest
@@ -170,10 +172,12 @@
     "ListSSHKeysResponse",
     "ListUsersRequest",
     "ListUsersResponse",
+    "LockUserRequest",
     "RemoveGroupMemberRequest",
     "SetGroupMembersRequest",
     "SetRulesRequest",
     "SetRulesResponse",
+    "UnlockUserRequest",
     "UpdateAPIKeyRequest",
     "UpdateApplicationRequest",
     "UpdateGroupRequest",

scaleway-async/scaleway_async/iam/v1alpha1/api.py

@@ -617,6 +617,65 @@ async def update_user_password(
         self._throw_on_error(res)
         return unmarshal_User(res.json())
 
+    async def lock_user(
+        self,
+        *,
+        user_id: str,
+    ) -> User:
+        """
+        Lock a user.
+        Lock a user. Note that a locked user cannot log in or use API keys until the locked status is removed.
+        :param user_id:
+        :return: :class:`User <User>`
+
+        Usage:
+        ::
+
+            result = await api.lock_user(
+                user_id="example",
+            )
+        """
+
+        param_user_id = validate_path_param("user_id", user_id)
+
+        res = self._request(
+            "POST",
+            f"/iam/v1alpha1/users/{param_user_id}/lock",
+            body={},
+        )
+
+        self._throw_on_error(res)
+        return unmarshal_User(res.json())
+
+    async def unlock_user(
+        self,
+        *,
+        user_id: str,
+    ) -> User:
+        """
+        Unlock a user.
+        :param user_id:
+        :return: :class:`User <User>`
+
+        Usage:
+        ::
+
+            result = await api.unlock_user(
+                user_id="example",
+            )
+        """
+
+        param_user_id = validate_path_param("user_id", user_id)
+
+        res = self._request(
+            "POST",
+            f"/iam/v1alpha1/users/{param_user_id}/unlock",
+            body={},
+        )
+
+        self._throw_on_error(res)
+        return unmarshal_User(res.json())
+
     async def list_applications(
         self,
         *,

scaleway-async/scaleway_async/iam/v1alpha1/types.py

@@ -1691,6 +1691,11 @@ class ListUsersResponse:
     """
 
 
+@dataclass
+class LockUserRequest:
+    user_id: str
+
+
 @dataclass
 class RemoveGroupMemberRequest:
     group_id: str
@@ -1733,6 +1738,11 @@ class SetRulesResponse:
     """
 
 
+@dataclass
+class UnlockUserRequest:
+    user_id: str
+
+
 @dataclass
 class UpdateAPIKeyRequest:
     access_key: str

scaleway/scaleway/iam/v1alpha1/__init__.py

@@ -78,10 +78,12 @@
 from .types import ListSSHKeysResponse
 from .types import ListUsersRequest
 from .types import ListUsersResponse
+from .types import LockUserRequest
 from .types import RemoveGroupMemberRequest
 from .types import SetGroupMembersRequest
 from .types import SetRulesRequest
 from .types import SetRulesResponse
+from .types import UnlockUserRequest
 from .types import UpdateAPIKeyRequest
 from .types import UpdateApplicationRequest
 from .types import UpdateGroupRequest
@@ -170,10 +172,12 @@
     "ListSSHKeysResponse",
     "ListUsersRequest",
     "ListUsersResponse",
+    "LockUserRequest",
     "RemoveGroupMemberRequest",
     "SetGroupMembersRequest",
     "SetRulesRequest",
     "SetRulesResponse",
+    "UnlockUserRequest",
     "UpdateAPIKeyRequest",
     "UpdateApplicationRequest",
     "UpdateGroupRequest",

scaleway/scaleway/iam/v1alpha1/api.py

@@ -617,6 +617,65 @@ def update_user_password(
         self._throw_on_error(res)
         return unmarshal_User(res.json())
 
+    def lock_user(
+        self,
+        *,
+        user_id: str,
+    ) -> User:
+        """
+        Lock a user.
+        Lock a user. Note that a locked user cannot log in or use API keys until the locked status is removed.
+        :param user_id:
+        :return: :class:`User <User>`
+
+        Usage:
+        ::
+
+            result = api.lock_user(
+                user_id="example",
+            )
+        """
+
+        param_user_id = validate_path_param("user_id", user_id)
+
+        res = self._request(
+            "POST",
+            f"/iam/v1alpha1/users/{param_user_id}/lock",
+            body={},
+        )
+
+        self._throw_on_error(res)
+        return unmarshal_User(res.json())
+
+    def unlock_user(
+        self,
+        *,
+        user_id: str,
+    ) -> User:
+        """
+        Unlock a user.
+        :param user_id:
+        :return: :class:`User <User>`
+
+        Usage:
+        ::
+
+            result = api.unlock_user(
+                user_id="example",
+            )
+        """
+
+        param_user_id = validate_path_param("user_id", user_id)
+
+        res = self._request(
+            "POST",
+            f"/iam/v1alpha1/users/{param_user_id}/unlock",
+            body={},
+        )
+
+        self._throw_on_error(res)
+        return unmarshal_User(res.json())
+
     def list_applications(
         self,
         *,

scaleway/scaleway/iam/v1alpha1/types.py

@@ -1691,6 +1691,11 @@ class ListUsersResponse:
     """
 
 
+@dataclass
+class LockUserRequest:
+    user_id: str
+
+
 @dataclass
 class RemoveGroupMemberRequest:
     group_id: str
@@ -1733,6 +1738,11 @@ class SetRulesResponse:
     """
 
 
+@dataclass
+class UnlockUserRequest:
+    user_id: str
+
+
 @dataclass
 class UpdateAPIKeyRequest:
     access_key: str