GET/users/{userId}/drive/sharedfolders

초대받은 폴더 목록을 조회한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증을 참고한다.

Scope

file
file.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/drive/sharedfolders

Path Parameters

ParameterTypeDescription
userId string 

사용자 ID

  • 메일
  • 리소스 ID
  • 외부 키 "externalKey:{externalKey}" 형태
  • me

required
example : me 

Query Parameters

ParameterTypeDescription
count integer 

조회 개수


default : 20
minimum : 1
maximum : 200
example : 20
format : int32 
cursor string 

커서값


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA==
allowReserved : false 
orderBy string 

정렬 방법. 정렬 항목과 순서를 공백(%20)으로 구분하여 입력한다. 예) createdTime%20desc

  • 정렬 항목
    • 파일: createdTime, modifiedTime, accessedTime, fileExtension, fileName, filePath, fileSize, fileType, protect
    • 휴지통 파일: deletedTime, fileSize, fileType, fileName, originalPath
  • 순서
    • 오름차순: asc
    • 내림차순: desc

example : createdTime%20desc 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
responseMetaData object (responseMetaData) 

응답 메타데이터

 
result array (object) 
 

responseMetaData

PropertyTypeDescription
nextCursor string 

다음 목록 조회 시 사용하는 커서값


readOnly : true 

object

PropertyTypeDescription
sharedFolderId string 

초대받은 폴더 ID


readOnly : true 
sharedFolderName string 

초대받은 폴더 이름


readOnly : true 
ownerId string 

소유자 ID


readOnly : true 
ownerName string 

소유자 이름


readOnly : true 
rootFileId string 

루트 파일 ID


readOnly : true 
createdTime string 

생성 시간


format : date-time
readOnly : true 
modifiedTime string 

수정 시간


format : date-time
readOnly : true 
resourceLocation integer 

리소스 위치 코드


format : int32
readOnly : true 
permissionType string 

편집 권한

  • READ: 읽기 권한
  • WRITE: 쓰기 권한

Allowed values : READ, WRITE 
useRevision boolean 

버전 사용 여부


readOnly : true 
protected boolean 

중요 표시 여부


readOnly : true 

Response Example

example

1{2  "responseMetaData": {3    "nextCursor": "TlRnd09UQXdORjlFWHprek9Ea3lPRFUyTWpRek5nfGRlIHdhbnRzIHRvIHNoYXJl"4  },5  "sharedFolders": [6    {7      "sharedFolderId": "NTgwOTAwNF9EXzkzODkyODU2MjQzNg",8      "sharedFolderName": "share",9      "ownerId": "userf7da-f82c-4284-13e7-030f3b4c756x",10      "ownerName": "ownerName",11      "rootFileId": "NTgwOTAwNHw5Mzg5Mjg1NjI0MzZ8RHwxNzQ",12      "createdTime": "2023-07-06T16:27:28+09:00",13      "modifiedTime": "2023-07-06T16:27:28+09:00",14      "resourceLocation": 11551,15      "permissionType": "WRITE",16      "useRevision": true,17      "protected": false18    }19  ]20}