REST Resource: permissions

المورد: الإذن

إذن لأحد الملفات. يمنح الإذن مستخدمًا أو مجموعة أو نطاقًا أو العالم إمكانية الوصول إلى ملف أو تدرج هرمي لمجلد.

تتطلب بعض طرق الموارد (مثل permissions.update) السمة permissionId. استخدِم الطريقة 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

يشير رقم تعريف المستخدم الذي يشير إليه هذا الإذن، وهو مطابق لمعرّف permissionId في المرجعَين "لمحة" و"الملفات". عند تقديم طلب drive.permissions.insert، يجب تحديد أحد حقول id أو value بالضبط ما لم يكن نوع الإذن anyone، وفي هذه الحالة يتم تجاهل كلا الحقلين id وvalue.

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 بالضبط ما لم يكن نوع الإذن anyone، وفي هذه الحالة يتم تجاهل كلا الحقلين id وvalue.

kind

string

النتائج فقط. دائمًا ما تكون هذه هي drive#permission.

emailAddress

string

النتائج فقط. عنوان البريد الإلكتروني للمستخدم أو المجموعة التي يشير إليها هذا الإذن هذا حقل للمخرجات فقط ويتوفّر عندما يكون نوع الإذن user أو group.

domain

string

النتائج فقط. اسم النطاق الخاص بالكيان الذي يشير إليه هذا الإذن. هذا حقل للمخرجات فقط ويتوفّر عندما يكون نوع الإذن user أو group أو 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

النتائج فقط. رقم تعريف العنصر الذي تم اكتساب هذا الإذن منه هذا حقل للمخرجات فقط.

permissionDetails[].inherited

boolean

النتائج فقط. ما إذا كان هذا الإذن مكتسَبًا تتم تعبئة هذا الحقل دائمًا. هذا حقل للمخرجات فقط.

expirationDate

string

وقت انتهاء صلاحية هذا الإذن (التاريخ والوقت لمعيار RFC 3339). تخضع تواريخ انتهاء الصلاحية للقيود التالية:

  • لا يمكن ضبطها إلا على أذونات المستخدمين والمجموعات.
  • يجب أن يكون التاريخ في المستقبل.
  • لا يمكن أن يكون التاريخ بعد أكثر من سنة في المستقبل.
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 للملفات التي ليست في مساحة تخزين سحابي مشتركة.

الطُرق

delete

حذف إذن من ملف أو مساحة تخزين سحابي مشتركة

get

يحصل على إذن باستخدام رقم التعريف.

getIdForEmail

تعرض معرّف الإذن لعنوان بريد إلكتروني.

insert

إدراج إذن لملف أو مساحة تخزين سحابي مشتركة

list

يسرد أذونات ملف أو مساحة تخزين سحابي مشتركة.

patch

لتعديل إذن باستخدام دلالات رمز التصحيح.

update

يعدِّل أحد الأذونات.