Skip to content

Commit b27ce4b

Browse files
feat(iam): add doc for UpdateUserPassword (scaleway#729)
Co-authored-by: Laure-di <62625835+Laure-di@users.noreply.github.com>
1 parent f2985d4 commit b27ce4b

File tree

4 files changed

+26
-6
lines changed

4 files changed

+26
-6
lines changed

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -584,9 +584,10 @@ async def update_user_password(
584584
send_email: bool,
585585
) -> User:
586586
"""
587-
:param user_id:
588-
:param password:
589-
:param send_email:
587+
Update an user's password.
588+
:param user_id: ID of the user to update.
589+
:param password: The new password.
590+
:param send_email: Whether or not to send an email alerting the user their password has changed.
590591
:return: :class:`User <User>`
591592
592593
Usage:

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1856,10 +1856,19 @@ class UpdateSSHKeyRequest:
18561856
@dataclass
18571857
class UpdateUserPasswordRequest:
18581858
user_id: str
1859+
"""
1860+
ID of the user to update.
1861+
"""
18591862

18601863
password: str
1864+
"""
1865+
The new password.
1866+
"""
18611867

18621868
send_email: bool
1869+
"""
1870+
Whether or not to send an email alerting the user their password has changed.
1871+
"""
18631872

18641873

18651874
@dataclass

scaleway/scaleway/iam/v1alpha1/api.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -584,9 +584,10 @@ def update_user_password(
584584
send_email: bool,
585585
) -> User:
586586
"""
587-
:param user_id:
588-
:param password:
589-
:param send_email:
587+
Update an user's password.
588+
:param user_id: ID of the user to update.
589+
:param password: The new password.
590+
:param send_email: Whether or not to send an email alerting the user their password has changed.
590591
:return: :class:`User <User>`
591592
592593
Usage:

scaleway/scaleway/iam/v1alpha1/types.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1856,10 +1856,19 @@ class UpdateSSHKeyRequest:
18561856
@dataclass
18571857
class UpdateUserPasswordRequest:
18581858
user_id: str
1859+
"""
1860+
ID of the user to update.
1861+
"""
18591862

18601863
password: str
1864+
"""
1865+
The new password.
1866+
"""
18611867

18621868
send_email: bool
1869+
"""
1870+
Whether or not to send an email alerting the user their password has changed.
1871+
"""
18631872

18641873

18651874
@dataclass

0 commit comments

Comments
 (0)