Skip to content

feat(iam): add doc for UpdateUserPassword #1553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 4, 2024
Merged

feat(iam): add doc for UpdateUserPassword #1553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b1588a
feat: update generated APIs
scaleway-bot Oct 31, 2024
7181921
Merge branch 'main' into v1.5694.0
Laure-di Nov 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/clients/src/api/iam/v1alpha1/api.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,12 @@ export class API extends ParentAPI {
unmarshalUser,
)

/**
* Update an user's password.
*
* @param request - The request {@link UpdateUserPasswordRequest}
* @returns A Promise of User
*/
updateUserPassword = (request: Readonly<UpdateUserPasswordRequest>) =>
this.client.fetch<User>(
{
Expand Down
6 changes: 6 additions & 0 deletions packages/clients/src/api/iam/v1alpha1/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1079,8 +1079,14 @@ export type UpdateSSHKeyRequest = {
}

export type UpdateUserPasswordRequest = {
/** ID of the user to update. */
userId: string
/** The new password. */
password: string
/**
* Whether or not to send an email alerting the user their password has
* changed.
*/
sendEmail: boolean
}

Expand Down