REST Resource: permissions

リソース: Permission

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

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

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

この権限のビューを示します。ビューに属する権限に対してのみ設定されます。'公開済み'のみがサポートされています。

pendingOwner

boolean

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

メソッド

create

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

delete

権限を削除します。

get

ID で権限を取得します。

list

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

update

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