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

Retrieve effective security permissions on a file

Contributors
PDFs

GET /protocols/file-security/effective-permissions/{svm.uuid}/{path}

Introduced In: 9.8

Retrieves effective security permissions on a file.

  • vserver security file-directory show-effective-permissions

Parameters

Name Type In Required Description

path

string

path

True

File Path

user

string

query

True

User_Name

share.name

string

query

False

Share Name

type

string

query

False

User Type

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

file_permissions

array[string]

Specifies the effective permission granted to a user on the specified file or folder path.

path

string

Specifies the path of the file or the folder for which you want to display effective permissions. The path is relative to the SVM root volume. If "-share-name" is specified then path will be relative to the share path.

share

share

share_permissions

array[string]

Specifies the effective permission granted to a user on the specified file or folder path.

svm

svm_reference

SVM, applies only to SVM-scoped objects.

type

string

Specifies the user type. The following values are allowed:

  • windows - Windows user

  • unix - UNIX user

user

string

Specifies the user for which effective permission needs to be displayed for the specified path.
Example response 
{
  "file_permissions": [
    "string"
  ],
  "path": "/dir1/dir2",
  "share": {
    "name": "string",
    "path": "string"
  },
  "share_permissions": [
    "string"
  ],
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "type": "string",
  "user": "cifs1/administrator"
}

Error

Status: Default, Error
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

share

Name Type Description

name

string

Displays the file or directory effective permission for the mentioned user, only for files and directories contained where the specified path is relative to the root of the specified share. If this parameter is not specified, the SVM root volume is taken as the default. If this parameter is specified, the effective share permission of the user is also displayed. Wildcard query characters are not supported.

path

string

Displays the CIFS share path.

href

Name Type Description

href

string

_links

Name Type Description

self

href

svm_reference

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

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.