Skip to content

Commit be4bf11

Browse files
authored
docs(iam): add doc for UpdateUserPassword (scaleway#2293)
1 parent f3b2c10 commit be4bf11

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

api/iam/v1alpha1/iam_sdk.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2203,10 +2203,13 @@ type UpdateSSHKeyRequest struct {
22032203

22042204
// UpdateUserPasswordRequest: update user password request.
22052205
type UpdateUserPasswordRequest struct {
2206+
// UserID: ID of the user to update.
22062207
UserID string `json:"-"`
22072208

2209+
// Password: the new password.
22082210
Password string `json:"password"`
22092211

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

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

2498-
// UpdateUserPassword:
2501+
// UpdateUserPassword: Update an user's password.
24992502
func (s *API) UpdateUserPassword(req *UpdateUserPasswordRequest, opts ...scw.RequestOption) (*User, error) {
25002503
var err error
25012504

0 commit comments

Comments
 (0)