Skip to main content
REST API reference

Retrieve the local user information for a user and SVM

PDFs

GET /protocols/cifs/local-users/{svm.uuid}/{sid}

Introduced In: 9.10

Retrieves local user information for the specified user and SVM.

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

sid

string

path

True

Local user SID

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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.

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.
Example response 
{
  "_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",
  "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

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.

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.