Get a File's Permissions by the File Path |
Gets the permissions that are associated with a target file version by using the file path.
Permissions determine the actions that are available to the requesting user for a target file version. Note that there is no "deny" permission. When a user has certain permissions to a file, it is because those permissions are explicitly granted to their user ID, because the user is a member of a group that has those permissions, or because the user has an assigned role that has those permissions.
If the permissions are set explicitly on the file, then those permissions are returned. Otherwise, inherited permissions are returned. The IsExplicit flag in the response specifies whether the permissions are explicit or implicit. The PermissionsInheritedFromFolderId property in the response specifies the folder ID of the folder from which the permissions are inherited.
|
Note: For more information about this command, including descriptions of any path and request parameters, request body schema, response codes and schemas, and payload examples, refer to the online API reference for this command at the following web page: |
URI
https://bartendercloud.com/api/librarian/files/path/{filePath}/permissions
|
Note: The bartendercloud.com domain that is referenced in the URI must be replaced with the contents of the DataCenterURI claim that is extracted from your access token. For more information, refer to Extracting the DataCenterURI Claim. |
Path Parameters
filePath
Type: String
Specifies the path of the file. Required.
Comment: The {filePath} parameter must be single-URL encoded, and the path must start with the "librarian://{spaceName}/" prefix. Replace {spaceName} with the name of the target space (such as Main or $temp).
For example, the actual path for the file named "My File.txt" in the "My Folder" folder in the Main space is as follows:
librarian://Main/My Folder/My File.txt
The URL-encoded {filePath} parameter is as follows:
librarian%3A%2F%2FMain%2FMy%20Folder%2FMy%20File.txt
The full URI would resemble the following:
https://bartendercloud.com/api/librarian/files/path/librarian%3A%2F%2FMain%2FMy%20Folder%2FMy%20File.txt/permissions
Query Parameters
versionMajor
Type: Integer <int32>
Specifies the requested major version. Gets the latest version if both major and minor versions are not provided. Also gets the latest version if a major version is not provided and if minor versioning is not enabled in the space, regardless of the minor version value. Optional.
versionMinor
Type: Integer <int32>
Specifies the requested minor version. Required when minor versioning is enabled in the space; otherwise optional.