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

Retrieve privileges for all local, or Active Directory users or groups and SVMs

Contributors
PDFs

GET /protocols/cifs/users-and-groups/privileges

Introduced In: 9.9

Retrieves privileges of the specified local or Active Directory user or group and SVM.

  • vserver cifs users-and-groups privilege show

Learn more

Parameters

Name Type In Required Description

privileges

string

query

False

Filter by privileges

name

string

query

False

Filter by name

svm.uuid

string

query

False

Filter by svm.uuid

svm.name

string

query

False

Filter by svm.name

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 or Active Directory user or group records.

records

array[user_group_privileges]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "user1",
      "privileges": [
        "string"
      ],
      "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

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.

user_group_privileges

Name Type Description

_links

_links

name

string

Local or Active Directory user or group name.

privileges

array[string]

An array of privileges associated with the local or Active Directory user or group. The available values are:

  • SeTcbPrivilege - Allows user to act as part of the operating system

  • SeBackupPrivilege - Allows user to back up files and directories, overriding any ACLs

  • SeRestorePrivilege - Allows user to restore files and directories, overriding any ACLs

  • SeTakeOwnershipPrivilege - Allows user to take ownership of files or other objects

  • SeSecurityPrivilege - Allows user to manage auditing and viewing/dumping/clearing the security log

  • SeChangeNotifyPrivilege - Allows user to bypass traverse checking

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.