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

Create local user configuration for an SVM

Contributors
PDFs

POST /protocols/cifs/local-users

Introduced In: 9.9

Creates the local user configuration for an SVM.

Important notes

  • The user name can contain up to 20 characters.

  • The user name cannot be terminated by a period.

  • The user name does not support any of the following characters: " / ? [ ] , : \| < > + = ; ? * @ or ASCII characters in the range 1-31.

  • The password must be at least six characters in length and must not contain the user account name.

  • The password must contain characters from three of the following four categories:

  • English uppercase characters (A through Z)

  • English lowercase characters (a through z)

  • Base 10 digits (0 through 9)

  • Special characters: ~ ! @ # 0 ^ & * _ - + = ` ? \| ( ) [ ] : ; " ' < > , . ? /

Required properties

  • svm.uuid or svm.name - Existing SVM in which to create the local user.

  • name - Name of the local user.

  • password - Password for the local user.

Default property values

If not specified in POST, the following default property value is assigned:

  • account_disabled - false

  • vserver cifs users-and-groups local-user create

Learn more

Parameters

Name Type In Required Description

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Request Body

Name Type Description

_links

_links

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.

membership

array[membership]

Specifies local groups of which this local user is a member.

name

string

Local user name. The maximum supported length of an user name is 20 characters.

password

string

Password for the local user.

sid

string

The security ID of the local user which uniquely identifies the user. The user SID is automatically generated in POST and it is retrieved using the GET method.

svm

svm
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "description": "This is local user.",
  "full_name": "user name",
  "membership": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "SMB_SERVER01\\group",
      "sid": "S-1-5-21-256008430-3394229847-3930036330-1001"
    }
  ],
  "name": "SMB_SERVER01\\user",
  "password": "string",
  "sid": "S-1-5-21-256008430-3394229847-3930036330-1001",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 201, Created
Name Type Description

_links

_links

num_records

integer

Number of local user records.

records

array[local_cifs_user]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "description": "This is local user.",
      "full_name": "user name",
      "membership": [
        {
          "_links": {
            "self": {
              "href": "/api/resourcelink"
            }
          },
          "name": "SMB_SERVER01\\group",
          "sid": "S-1-5-21-256008430-3394229847-3930036330-1001"
        }
      ],
      "name": "SMB_SERVER01\\user",
      "password": "string",
      "sid": "S-1-5-21-256008430-3394229847-3930036330-1001",
      "svm": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "svm1",
        "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
      }
    }
  ]
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

262278

Name and password are required fields.

655399

CIFS server must exist to create a local user.

655660

The operation is allowed only on data SVMs.

655661

The user name should not exceed 20 characters. Also full_name and description should not exceed 256 characters.

655665

The user name must not match the CIFS server name of the specified SVM.

655668

The specified user name contains illegal characters.

655675

The local domain name specified in user name doesn't exist.

655682

The user name cannot be blank.

655733

The password does not meet the password complexity requirements.

655736

The specified user name already exists.

2621706

The specified SVM UUID is incorrect for the specified SVM name.
Name Type Description

error

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

membership

Name Type Description

_links

_links

name

string

Local group name. The maximum supported length of a group name is 256 characters.

sid

string

The security ID of the local group which uniquely identifies the group. The group SID is automatically generated in POST and it is retrieved using the GET method.

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

local_cifs_user

Name Type Description

_links

_links

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.

membership

array[membership]

Specifies local groups of which this local user is a member.

name

string

Local user name. The maximum supported length of an user name is 20 characters.

password

string

Password for the local user.

sid

string

The security ID of the local user which uniquely identifies the user. The user SID is automatically generated in POST and it is retrieved using the GET method.

svm

svm

_links

Name Type Description

next

href

self

href

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.