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

共有したフォルダを部分更新する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

file

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • ユーザーの ExternalKey (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 

招待するメンバーへのサービス通知フラグ


default : true 

object

PropertyTypeDescription
userId string 

ユーザー ID

  • ユーザー ID (userId)
  • ログイン ID (email)
  • ユーザーの ExternalKey (externalKey:{externalKey})
    組織 ID (orgUnitId)
    グループ ID (groupId)

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 (userId)
組織 ID (orgUnitId)
グループ ID (groupId)


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.