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

폴더 공유를 수정한다.

Authorization

oauth2

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

Scope

file

HTTP Request

PATCHhttps://www.worksapis.com/v1.0/users/{userId}/drive/files/{fileId}/share

Path Parameters

ParameterTypeDescription
userId string 

사용자 ID

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

required
example : me 
fileId string 

파일 ID


required
example : NzExNTMwMDF8MTQ2NzA1NjAxMDAwMHxGfDA 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Request Body

PropertyTypeDescription
members array (object) 

폴더를 공유할 구성원 목록


required 
sendNotification boolean 

폴더를 공유할 때 알림을 보낼지 여부. 기본값: true


default : true 

object

PropertyTypeDescription
userId string 

사용자 ID

  • 메일
  • 리소스 ID
  • 외부 키 "externalKey:{externalKey}" 형태
    조직 ID
    그룹 ID

required
minLength : 1 
userType string 

사용자 유형

  • USER: 사용자
  • ORGUNIT: 조직
  • GROUP: 그룹

required
Allowed values : USER, ORGUNIT, GROUP 
permissionType string 

편집 권한

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

required
Allowed values : READ, WRITE 

Request Example

example

1{2  "members": [3    {4      "userId": "userf54b-fc04-4c54-8b9b-7072a326874a",5      "userType": "USER",6      "permissionType": "WRITE"7    }8  ],9  "sendNotification": true10}

Response

HTTP 200

OK

PropertyTypeDescription
rootFileId string 

루트 파일 ID

 
members array (object) 

구성원 목록

 
createdTime string 

생성 시간


format : date-time 
modifiedTime string 

수정 시간


format : date-time 

object

PropertyTypeDescription
userId string 

구성원 ID


readOnly : true 
userType string 

사용자 유형

  • USER: 사용자
  • ORGUNIT: 조직
  • GROUP: 그룹

Allowed values : USER, ORGUNIT, GROUP 
permissionType string 

편집 권한

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

Allowed values : READ, WRITE 
userName string 

이름


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

Share/Group member count over limit.: 300

HTTP 404

Resource does not exist.