GET/users/{userId}/drive/link-setting

マイドライブのリンク共有設定を取得する。

Authorization

oauth2

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

Scope

file
file.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}/drive/link-setting

Path Parameters

ParameterTypeDescription
userId string 

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

  • ユーザー ID (userId)
  • ログイン ID (email)
  • ユーザーの ExternalKey (externalKey:{externalKey})
  • 自身 ("me")

required
example : me 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
enabledOrganizationAccessType boolean 

ORGANIZATION: 社内メンバーのみアクセス可能なリンクの利用可否

 
enabledSpecificPeopleAccessType boolean 

SPECIFIC_PEOPLE: 許可した人のみアクセス可能 (OTP 認証) なリンクの利用可否

 
enabledAnyoneAccessType boolean 

ANYONE: 誰でもアクセス可能なリンクの利用可否

 
maxLinkRetentionDays integer 

リンクの有効期限の最大値。
リンクの作成・修正時の expirationTime は、リンク設定の maxLinkRetentionDays の値以下で指定する。

  • -1: 制限なし
  • 7: 7日
  • 30: 30日
  • 90: 90日
  • 180: 180日

Allowed values : -1, 7, 30, 90, 180 

Response Example

example

1{2  "enabledOrganizationAccessType": true,3  "enabledSpecificPeopleAccessType": true,4  "enabledAnyoneAccessType": false,5  "maxLinkRetentionDays": 306}