Skip to content

Commit

Permalink
docs(iam): add doc for UpdateUserPassword (scaleway#2293)
Browse files Browse the repository at this point in the history
  • Loading branch information
scaleway-bot authored Oct 31, 2024
1 parent f3b2c10 commit be4bf11
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion api/iam/v1alpha1/iam_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -2203,10 +2203,13 @@ type UpdateSSHKeyRequest struct {

// UpdateUserPasswordRequest: update user password request.
type UpdateUserPasswordRequest struct {
// UserID: ID of the user to update.
UserID string `json:"-"`

// Password: the new password.
Password string `json:"password"`

// SendEmail: whether or not to send an email alerting the user their password has changed.
SendEmail bool `json:"send_email"`
}

Expand Down Expand Up @@ -2495,7 +2498,7 @@ func (s *API) CreateUser(req *CreateUserRequest, opts ...scw.RequestOption) (*Us
return &resp, nil
}

// UpdateUserPassword:
// UpdateUserPassword: Update an user's password.
func (s *API) UpdateUserPassword(req *UpdateUserPasswordRequest, opts ...scw.RequestOption) (*User, error) {
var err error

Expand Down

0 comments on commit be4bf11

Please sign in to comment.