Skip to main content

Add privileges to a local, or Active Directory user or group and SVM

Contributors
PDFs

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

Introduced In: 9.10

Adds privileges to the specified local or Active Directory user or group and SVM.

Important note

  • Specified privileges are appended to the existing list of privileges.

Required properties

  • svm.uuid or svm.name - Existing SVM for which privileges are added to user or group.

  • name - Existing local or Active Directory user or group for which privileges are to be added.

  • privileges - List of privileges to be added to a user or group.

  • vserver cifs users-and-groups privilege add-privilege

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

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.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "name": "user1",
  "privileges": [
    "string"
  ],
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 201, Created

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

655660

The operation is allowed only on data SVMs.

655673

Failed to resolve the user or group.

655730

The specified local user to which privileges are to be associated to does not exist.
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.

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.