GET/users/{userId}/drive/files/{fileId}/share

Gets folder sharing information.

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/users/{userId}/drive/files/{fileId}/share

Path Parameters

ParameterTypeDescription
userId string 

User ID

  • Mail
  • Resource ID
  • External key in "externalKey:{externalKey}" format
  • me

required
example : me 
fileId string 

File ID


required
example : NzExNTMwMDF8MTQ2NzA1NjAxMDAwMHxGfDA 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
rootFileId string 

Root file ID

 
members array (object) 

List of members

 
createdTime string 

Creation time


format : date-time 
modifiedTime string 

Update time


format : date-time 

object

PropertyTypeDescription
userId string 

Member ID


readOnly : true 
userType string 

User type

  • USER: User
  • ORGUNIT: Team
  • GROUP: Group

Allowed values : USER, ORGUNIT, GROUP 
permissionType string 

Permission type

  • READ: Read permission
  • WRITE: Write permission

Allowed values : READ, WRITE 
userName string 

First name


readOnly : true 

Response Example

example

1{2  "rootFileId": "MzAyNjY0OTN8MjI3MTE0MTQ2MzA1MnxEfDMwMDcwNDQ",3  "members": [4    {5      "userId": "userf54b-fc04-4c54-8b9b-7072a326874a",6      "userType": "USER",7      "permissionType": "WRITE",8      "userName": "user Name"9    }10  ],11  "createdTime": "2023-06-05T10:54:10+09:00",12  "modifiedTime": "2023-06-05T10:54:10+09:00"13}

HTTP 400

Invalid parameters received.

HTTP 404

Resource does not exist.