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

Retrieve local users for all SVMs

Contributors
PDFs

GET /protocols/cifs/local-users

Introduced In: 9.9

Retrieves local users for all of the SVMs. Local groups to which this user belongs to are also displayed.

Advanced properties

  • membership

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

  • vserver cifs users-and-groups local-user show-membership

Learn more

Parameters

Name Type In Required Description

name

string

query

False

Filter by name

  • minLength: 1

description

string

query

False

Filter by description

  • maxLength: 256

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

account_disabled

boolean

query

False

Filter by account_disabled

sid

string

query

False

Filter by sid

  • Introduced in: 9.10

full_name

string

query

False

Filter by full_name

  • maxLength: 256

membership.sid

string

query

False

Filter by membership.sid

  • Introduced in: 9.10

membership.name

string

query

False

Filter by membership.name

  • minLength: 1

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
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"
    }
  },
  "num_records": 1,
  "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, Error
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

next

href

self

href

_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

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.

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

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.