Skip to content

Commit 56cb327

Browse files
feat(iam): add doc for UpdateUserPassword (#1553)
Co-authored-by: Laure-di <62625835+Laure-di@users.noreply.github.com>
1 parent 3b0ef23 commit 56cb327

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

packages/clients/src/api/iam/v1alpha1/api.gen.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,12 @@ export class API extends ParentAPI {
347347
unmarshalUser,
348348
)
349349

350+
/**
351+
* Update an user's password.
352+
*
353+
* @param request - The request {@link UpdateUserPasswordRequest}
354+
* @returns A Promise of User
355+
*/
350356
updateUserPassword = (request: Readonly<UpdateUserPasswordRequest>) =>
351357
this.client.fetch<User>(
352358
{

packages/clients/src/api/iam/v1alpha1/types.gen.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1079,8 +1079,14 @@ export type UpdateSSHKeyRequest = {
10791079
}
10801080

10811081
export type UpdateUserPasswordRequest = {
1082+
/** ID of the user to update. */
10821083
userId: string
1084+
/** The new password. */
10831085
password: string
1086+
/**
1087+
* Whether or not to send an email alerting the user their password has
1088+
* changed.
1089+
*/
10841090
sendEmail: boolean
10851091
}
10861092

0 commit comments

Comments
 (0)