Appscript API for fetching access permissions of team drive - google-apps-script

Question

I am trying to generate a report of all access permissions currently various users have in Team Drive. Is there any API in Appscript to Fetch this data?

Answer 1

There doesn't seem to be any method for getting Drive permissions sorted by username, so you will need to implement this business logic yourself. According to the documentation, sending a GET request to the API endpoint below will get you the list of permissions for the Team Drive (use Team Drive ID instead of file id):
https://www.googleapis.com/drive/v3/files/fileId/permissions
I don't have any Team Drives set up - the example below is based on getting permissions for a single file using Drive REST API. Before the code can be executed, you must prove your identity by including API key in URL parameters and passing OAuth token in the headers of your 'GET'request.
The API key can be obtained from Google Cloud console. Enable the Drive API and click the key icon in the left menu to set up credentials. Choose "API key" from the drop-down and copy the value.
Your script must pass the token that includes all required authorization scopes to the API endpoint. OAuth scopes are set explicitly in the manifest file. In Script Editor, select "View - Show manifest file" and add relevant scopes. Scopes used in my manifest file are for accessing Drive Files and calling external services via UrlFetchApp:
"oauthScopes": [
"https://www.googleapis.com/auth/drive",
"https://www.googleapis.com/auth/script.external_request"]
Finally, get the list of permissions for the file:
var fileId = "FILE_ID";
var apiKey = "API_KEY";
var apiUrl = "https://www.googleapis.com/drive/v3/files/fileId/permissions";
var token = ScriptApp.getOAuthToken();
var header = {"Authorization":"Bearer " + token};
var options = {
"method":"GET",
"headers": header,
"muteHttpExceptions": true
};
var res = UrlFetchApp.fetch(apiUrl.replace("fileId", fileId) + "?key=" + apiKey, options)
.getContentText();
var permissions = JSON.parse(res);
Logger.log(permissions);

Answer 2

Updates with help from Anton's answer. (Working with Appmaker as well).
Here's how I have achieved it,
function fileExport(folderId) //pass folder id or drive/team drive id to fetch permissions
{
var parent = DriveApp.getFolderById(folderId);
var path = DriveApp.getFolderById(folderId).getName();
var fileName = 'Permisssions_' + new Date(); //define file name
var newExport = SpreadsheetApp.create(fileName); // create new spreadsheet
var header = ["Path","Folder","File Name","Email","Role","Name","DocUrl"]; //define header
newExport.appendRow(header); // append header to spreadsheet
newExport.setFrozenRows(1);
newExport.getRange("A1:H1").setFontWeight("bold");
//traverse through each folder under current folder
getChildFolders(parent,newExport,path);
//appned files associated with current folder
var files = parent.getFiles();
while (files.hasNext()) {
var file = files.next();
var permitFile= makeRestCall(file.getId());
for(var j=0; j<permitFile.length;j++)
{
newExport.appendRow([path,'',file.getName(),permitFile[j].emailAddress, permitFile[j].role,permitFile[j].displayName,file.getUrl()]);
}
}
return 'File exported successfully to this path:'+ newExport.getUrl();
}
//Iterate through child folders using recursive call
function getChildFolders(parent,newExport,path) {
var childFolders = parent.getFolders();
while (childFolders.hasNext()) {
var childFolder = childFolders.next();
path = path +'--'+childFolder.getName();
var permit= makeRestCall(childFolder.getId());
for(var i=0; i<permit.length;i++)
{
newExport.appendRow([path,childFolder.getName(),'',permit[i].emailAddress, permit[i].role,permit[i].displayName,childFolder.getUrl()]);
}
var files = childFolder.getFiles();
while (files.hasNext()) {
var file = files.next();
var permitFile= makeRestCall(file.getId());
for(var j=0; j<permitFile.length;j++)
{
newExport.appendRow([path,'',file.getName(),permitFile[j].emailAddress, permitFile[j].role,permitFile[j].displayName,file.getUrl()]);
}
}
// Recursive call for any sub-folders
getChildFolders(childFolder,newExport,path);
}
}
function makeRestCall(fileOrFolderId) //make rest call to fetch permissions
{
var apiUrl = "https://www.googleapis.com/drive/v3/files/fileId/permissions";
var token = ScriptApp.getOAuthToken();
var header = {"Authorization":"Bearer " + token};
var options = {
"method":"GET",
"headers": header
};
var response = UrlFetchApp.fetch(apiUrl.replace("fileId", fileOrFolderId) + "?supportsTeamDrives=true&fields=*", options)
.getContentText();
var dataAll = JSON.parse(response);
var permit = dataAll.permissions;
return permit;
}