Skip to main content
REST API reference

Update UNIX user information for a user and SVM

PATCH /name-services/unix-users/{svm.uuid}/{name}

Introduced In: 9.9

Updates UNIX user information for the specified user and SVM.

Parameters

Name Type In Required Description

name

string

path

True

UNIX user name

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Request Body

Name Type Description

full_name

string

User's full name.

id

integer

UNIX user ID of the specified user.

primary_gid

integer

Primary group ID to which the user belongs.

Example request
{
  "full_name": "Full User Name for user1",
  "skip_name_validation": true
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

23724128

The specified Unix user full-name contains invalid character ':'

23724089

The specified UNIX user full-name is too long. Maximum supported length is 256 characters.

23724055

Internal error. Failed to modify the UNIX user for the SVM. Verify that the cluster is healthy, then try the command again.

23724090

Configuring individual entries is not supported because file-only configuration is enabled.

Definitions

See Definitions

href

Name Type Description

href

string

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

unix_user

Name Type Description

full_name

string

User's full name.

id

integer

UNIX user ID of the specified user.

primary_gid

integer

Primary group ID to which the user belongs.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_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.