Get File Permissions for the Calling User |
Gets the permissions that are associated with a file version for a specific user. This command allows the application to determine what a user's permissions are with regard to a specific file without having to try running an action.
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.
|
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/{fileId}/userpermissions
|
Note: The bartendercloud.com domain that is referenced in the URI and in the code example that follows 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
fileId
Type: String
Specifies the ID of the file. Required.
Query Parameters
versionMajor
Type: Integer <int32>
Obsolete.
versionMinor
Type: Integer <int32>
Obsolete.
Example
- C#
Request body: None.
Response: See UserFilePermissions.
// Assume that fileId is the ID of the target file.
HttpClient client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", $"Bearer {accessToken}");
HttpResponseMessage msg = await client.GetAsync($"https://bartendercloud.com/api/librarian/files/{fileId}/userpermissions?versionMajor={majorVersion}&versionMinor={minorVersion}");
if (msg.IsSuccessStatusCode)
{
var response = await msg.Content.ReadAsStringAsync();
return JsonConvert.DeserializeObject<UserFilePermissions>(response);
}