POST/sharedrives/{sharedriveId}/permissions/enable

This API operation has been deprecated. Please use the Update a collaborative drive API operation. Enables access permissions to be created for a collaborative drive.
If access permissions are enabled for a collaborative drive which all users in a domain have access to, only the master will have access to the drive and all the previous user type access restrictions will be deleted.
This API operation does not affect a collaborative drive with access permissions already set.

Authorization

oauth2

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

Scope

file

HTTP Request

POSThttps://www.worksapis.com/v1.0/sharedrives/{sharedriveId}/permissions/enable

Path Parameters

ParameterTypeDescription
sharedriveId string 

Collaborative drive ID


required
example : @2101000000000008 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

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

HTTP 403

Forbidden