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

Create a share-level ACL on a CIFS share

Contributors
PDFs

POST /protocols/cifs/shares/{svm.uuid}/{share}/acls

Introduced In: 9.6

Creates a share-level ACL on a CIFS share.

Required properties

  • svm.uuid or svm.name - Existing SVM in which to create the share acl.

  • share - Existing CIFS share in which to create the share acl.

  • user_or_group - Existing user or group name for which the acl is added on the CIFS share.

  • permission - Access rights that a user or group has on the defined CIFS share.

Default property values

  • type - windows

  • vserver cifs share access-control create

Learn more

Parameters

Name Type In Required Description

share

string

path

True

CIFS Share Name

return_records

boolean

query

False

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

  • Default value:

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Request Body

Name Type Description

_links

_links

permission

string

Specifies the access rights that a user or group has on the defined CIFS Share. The following values are allowed:

  • no_access - User does not have CIFS share access

  • read - User has only read access

  • change - User has change access

  • full_control - User has full_control access

share

string

CIFS share name

svm

svm

type

string

Specifies the type of the user or group to add to the access control list of a CIFS share. The following values are allowed:

  • windows - Windows user or group

  • unix_user - UNIX user

  • unix_group - UNIX group

user_or_group

string

Specifies the user or group name to add to the access control list of a CIFS share.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "permission": "no_access",
  "share": "string",
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "type": "windows",
  "user_or_group": "ENGDOMAIN\\ad_user"
}

Response

Status: 201, Created

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

655470

Failed to create share ACL because the share does not exist

655446

Failed to create share ACL because the specified Windows user/group does not exist

4849678

Failed to create share ACL because the specified UNIX user/group does not exist
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

svm

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

cifs_share_acl

The permissions that users and groups have on a CIFS share.

Name Type Description

_links

_links

permission

string

Specifies the access rights that a user or group has on the defined CIFS Share. The following values are allowed:

  • no_access - User does not have CIFS share access

  • read - User has only read access

  • change - User has change access

  • full_control - User has full_control access

share

string

CIFS share name

svm

svm

type

string

Specifies the type of the user or group to add to the access control list of a CIFS share. The following values are allowed:

  • windows - Windows user or group

  • unix_user - UNIX user

  • unix_group - UNIX group

user_or_group

string

Specifies the user or group name to add to the access control list of a CIFS share.

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.