GET/sharedrives

Gets a list of collaborative drives.

Note

  • For more information,
    see Folder type features.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

file
file.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/sharedrives

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
sharedrives array (ShareDrive) 

Collaborative drive information

 

ShareDrive

PropertyTypeDescription
accessDenies array (ShareDriveAccessDeny) 

Access denials

 
createdTime string 

Creation date


readOnly : true 
description string 

Description

 
hasPermission boolean 

Indicates whether a specified member is granted access permission.


readOnly : true 
accessibleRange string 

Accessible range

  • TENANT: Accessible to all corporate group members
  • DOMAIN: Accessible to all company members
  • MEMBER: Accessible to only the specified members in a corporate group

Note

  • If it is MEMBER, hasPermission is set to true.

Allowed values : TENANT, DOMAIN, MEMBER
nullable : false 
masters array (ShareDriveMaster) 

Master

 
name string 

First name

 
quota object (quota) 

Capacity information


readOnly : true 
sharedriveId string 

Collaborative drive ID


readOnly : true 
permissionType string 

Permission type

  • READ: Read permission
  • WRITE: Write permission

Allowed values : READ, WRITE 

ShareDriveAccessDeny

PropertyTypeDescription
id string 

Access denial ID
If the type parameter is user-type, you need to enter a `userTypeId'.

 
name string 

Access denial name


readOnly : true 
type string 

Access denial type


Allowed values : user-type 

ShareDriveMaster

PropertyTypeDescription
id string 

Master user ID

 
name string 

Master user name


readOnly : true 

quota

PropertyTypeDescription
trash integer 

Trash size


format : int64
readOnly : true 
used integer 

Used size


format : int64
readOnly : true 

Response Example

example

1{2  "sharedrives": [3    {4      "sharedriveId": "@2101000000000008",5      "name": "share drive",6      "description": "description here",7      "createdTime": "2020-12-16T19:40:15.15+09:00",8      "quota": {9        "used": 46426,10        "trash": 011      },12      "hasPermission": false,13      "masters": [14        {15          "id": "userf7da-f82c-4284-13e7-030f3b4c756x",16          "name": "User Name"17        }18      ],19      "accessDenies": [20        {21          "type": "user-type",22          "id": "041b68d3-263a-4fbe-9bc5-0350c49d1c42",23          "name": "Part-time job"24        }25      ],26      "permissionType": "READ"27    }28  ]29}