Update local user information for a user and SVM
Suggest changes
PDFs
PATCH /protocols/cifs/local-users/{svm.uuid}/{sid}
Introduced In: 9.10
Updates local user information for the specified user and SVM. The PATCH endpoint is also used to rename a user and to set the password for the user.
Related ONTAP commands
-
vserver cifs users-and-groups local-user modify -
vserver cifs users-and-groups local-user rename -
vserver cifs users-and-groups local-user set-password
Learn more
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
sid |
string |
path |
True |
Local user SID |
svm.uuid |
string |
path |
True |
UUID of the SVM to which this object belongs. |
Request Body
| Name | Type | Description |
|---|---|---|
account_disabled |
boolean |
Indicates whether the user account is enabled or disabled. |
description |
string |
Description for the local user. |
full_name |
string |
User's full name. |
name |
string |
Local user name. The maximum supported length of an user name is 20 characters. |
password |
string |
Password for the local user. |
svm |
Example request
{
"description": "This is local user.",
"full_name": "user name",
"name": "SMB_SERVER01\\user",
"password": "string",
"svm": {
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}Response
Status: 200, OkError
Status: DefaultONTAP Error Response Codes
| Error Code | Description |
|---|---|
655661 |
The user name should not exceed 20 characters. Also full_name and description should not exceed 256 characters. |
655668 |
The specified user name contains illegal characters. |
655675 |
The local domain name specified in the user name does not exist. |
655682 |
The user name cannot be blank. |
655732 |
Failed to rename a user. The error code returned details the failure along with the reason for the failure. Take corrective actions as per the specified reason. |
655733 |
The specified password does not meet the password complexity requirements. |
655737 |
To rename an existing user, the local domain specified in name must match the local domain of the user to be renamed. |
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
membership
| Name | Type | Description |
|---|---|---|
name |
string |
Local group name. The maximum supported length of a group name is 256 characters. |
svm
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
local_cifs_user
| Name | Type | Description |
|---|---|---|
account_disabled |
boolean |
Indicates whether the user account is enabled or disabled. |
description |
string |
Description for the local user. |
full_name |
string |
User's full name. |
name |
string |
Local user name. The maximum supported length of an user name is 20 characters. |
password |
string |
Password for the local user. |
svm |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |