REST Resource: permissions

リソース: 権限

ファイルの権限。権限により、ユーザー、グループ、ドメイン、または全世界に、ファイルまたはフォルダ階層へのアクセス権を付与します。

一部のリソース メソッド(permissions.update など)には permissionId が必要です。ファイル、フォルダ、共有ドライブの ID を取得するには、permissions.list メソッドを使用します。

JSON 表現
{
  "id": string,
  "name": string,
  "type": string,
  "role": string,
  "additionalRoles": [
    string
  ],
  "authKey": string,
  "value": string,
  "kind": string,
  "withLink": boolean,
  "photoLink": string,
  "selfLink": string,
  "emailAddress": string,
  "domain": string,
  "etag": string,
  "permissionDetails": [
    {
      "permissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "expirationDate": string,
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean
}
フィールド
id

string

この権限が参照しているユーザーの ID。概要リソースとファイル リソースの permissionId と同じです。drive.permissions.insert リクエストを行う場合は、id フィールドと value フィールドのいずれか 1 つのみを指定する必要があります。ただし、権限タイプが anyone の場合は、idvalue の両方は無視されます。

name

string

出力のみ。この権限の名前。

type

string

アカウントの種類。指定できる値は次のとおりです。

  • user
  • group
  • domain
  • anyone
role

string

このユーザーのメインのロール。今後、新しい値がサポートされますが、現時点では次の値が許可されます。

  • owner
  • organizer
  • fileOrganizer
  • writer
  • reader
additionalRoles[]

string

このユーザーの追加のロール。現時点では commenter しか使用できませんが、今後、さらにサポートされる可能性があります。

authKey
(deprecated)

string

出力のみ。廃止されました。

value

string

エンティティのメールアドレスまたはドメイン名。これは挿入時に使用され、レスポンスには含まれません。drive.permissions.insert リクエストを行う場合は、id フィールドと value フィールドのいずれか 1 つのみを指定する必要があります。ただし、権限タイプが anyone の場合は、idvalue の両方は無視されます。

kind

string

出力のみ。これは常に drive#permission です。

emailAddress

string

出力のみ。この権限を参照するユーザーまたはグループのメールアドレス。これは出力専用のフィールドで、権限タイプが user または group の場合に存在します。

domain

string

出力のみ。この権限が参照しているエンティティのドメイン名。これは、権限タイプが usergroup、または domain の場合に存在する出力のみのフィールドです。

etag

string

出力のみ。権限の ETag。

permissionDetails[]

object

出力のみ。この共有ドライブ アイテムの権限が継承されているか、このアイテムに直接付与されているかの詳細。出力専用のフィールドで、共有ドライブのアイテムにのみ存在します。

permissionDetails[].permissionType

string

出力のみ。このユーザーの権限タイプ。今後、新しい値が追加される可能性がありますが、現在のところ以下が可能です。

  • file
  • member
permissionDetails[].role

string

出力のみ。このユーザーのメインのロール。今後、次のような値が追加される可能性があります。

  • organizer
  • fileOrganizer
  • writer
  • reader
permissionDetails[].additionalRoles[]

string

出力のみ。このユーザーの追加のロール。現時点では commenter しかありませんが、今後、さらにサポートされる可能性があります。

permissionDetails[].inheritedFrom

string

出力のみ。この権限の継承元であるアイテムの ID。出力専用のフィールドです。

permissionDetails[].inherited

boolean

出力のみ。この権限を継承しているかどうか。このフィールドは常に入力されます。出力専用のフィールドです。

expirationDate

string

この権限の有効期限(RFC 3339 の日時)。有効期限には次の制限があります。

  • ユーザー権限とグループ権限に対してのみ設定できます。
  • 日付は将来の日付にする必要があります
  • 日付に 1 年以内の日付は指定できません
teamDrivePermissionDetails[]
(deprecated)

object

出力のみ。非推奨: 代わりに permissionDetails を使用してください。

teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

出力のみ。非推奨: 代わりに permissionDetails/permissionType を使用してください。

teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

出力のみ。非推奨: 代わりに permissionDetails/role を使用してください。

teamDrivePermissionDetails[]
(deprecated).additionalRoles[]
(deprecated)

string

出力のみ。非推奨: 代わりに permissionDetails/additionalRoles を使用してください。

teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

出力のみ。非推奨: 代わりに permissionDetails/inheritedFrom を使用してください。

teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

出力のみ。非推奨: 代わりに permissionDetails/inherited を使用してください。

deleted

boolean

出力のみ。この権限に関連付けられたアカウントが削除されているかどうか。このフィールドは、ユーザーとグループの権限にのみ関係します。

view

string

この権限のビューを示します。ビューに属する権限に対してのみ入力されます。サポートされる値は published のみです。

pendingOwner

boolean

この権限に関連付けられたアカウントが保留中のオーナーかどうか。共有ドライブにファイルがないファイルに限り、user タイプの権限のみが入力されます。

Methods

delete

ファイルまたは共有ドライブから権限を削除します。

get

ID で権限を取得します。

getIdForEmail

メールアドレスの権限 ID を返します。

insert

ファイルまたは共有ドライブの権限を挿入します。

list

ファイルまたは共有ドライブの権限を一覧表示します。

patch

パッチ セマンティクスを使用して権限を更新します。

update

権限を更新します。