REST Resource: permissions

リソース: 権限

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

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

JSON 表現
{
  "id": string,
  "displayName": string,
  "type": string,
  "kind": string,
  "permissionDetails": [
    {
      "permissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "photoLink": string,
  "emailAddress": string,
  "role": string,
  "allowFileDiscovery": boolean,
  "domain": string,
  "expirationTime": string,
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean
}
フィールド
id

string

出力のみ。この権限の ID。これは権限付与対象の一意の識別子であり、permissionId としてユーザー リソースで公開されます。ID は不透明な値として扱う必要があります。

displayName

string

出力のみ。権限の値の「好み」の名前。権限の種類別の例を以下に示します。

  • user - Google アカウントで定義されているユーザーの氏名(「Joe Smith」など)。
  • group - Google グループの名前(「会社の管理者」など)。
  • domain - 文字列ドメイン名(「thecompany.com」など)。
  • anyone - displayName が存在しない場合。
type

string

譲受人の種類。指定できる値は次のとおりです。

  • user
  • group
  • domain
  • anyone

権限を作成する際に、typeuser または group の場合、ユーザーまたはグループに対して emailAddress を指定する必要があります。typedomain の場合は、domain を指定する必要があります。anyone タイプには、追加情報は必要ありません。

kind

string

出力のみ。リソースの種類を示します。値: 固定文字列 "drive#permission"

permissionDetails[]

object

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

permissionDetails[].permissionType

string

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

  • file
  • member
permissionDetails[].inheritedFrom

string

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

permissionDetails[].role

string

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

  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
permissionDetails[].inherited

boolean

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

emailAddress

string

この権限を参照するユーザーまたはグループのメールアドレス。

role

string

この権限によって付与されるロール。今後、新しい値がサポートされますが、現時点では次の値が許可されます。

  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
allowFileDiscovery

boolean

権限によって検索でファイルを検出できるかどうかを指定します。これは、domain または anyone タイプの権限にのみ適用されます。

domain

string

この権限を参照するドメイン。

expirationTime

string

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

  • ユーザー権限とグループ権限に対してのみ設定できます。
  • 現在時刻より後の日時を指定してください。
  • 1 年以内の時間を指定してください。
teamDrivePermissionDetails[]
(deprecated)

object

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

teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

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

teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

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

teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

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

teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

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

deleted

boolean

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

view

string

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

pendingOwner

boolean

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

Methods

create

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

delete

権限を削除する。

get

ID で権限を取得します。

list

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

update

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