Skip to main content
A newer release of this product is available.

Update UNIX user information for a user and SVM

Contributors
PDFs

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

_links

_links

full_name

string

User's full name.

id

integer

UNIX user ID of the specified user.

name

string

UNIX user name to be added to the local database.

primary_gid

integer

Primary group ID to which the user belongs.

skip_name_validation

boolean

Indicates whether or not the validation for the specified UNIX user name is disabled.

svm

svm

SVM, applies only to SVM-scoped objects.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "full_name": "Full User Name for user1",
  "name": "user1",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

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.
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

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

_links

_links

full_name

string

User's full name.

id

integer

UNIX user ID of the specified user.

name

string

UNIX user name to be added to the local database.

primary_gid

integer

Primary group ID to which the user belongs.

skip_name_validation

boolean

Indicates whether or not the validation for the specified UNIX user name is disabled.

svm

svm

SVM, applies only to SVM-scoped objects.

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.