REST Resource: permissions

Recurso: Permission

Es un permiso para un archivo. Un permiso otorga a un usuario, un grupo, un dominio o a cualquier persona acceso a un archivo o a una jerarquía de carpetas. Para obtener más información, consulta Cómo compartir archivos, carpetas y unidades.

De forma predeterminada, las solicitudes de permiso solo devuelven un subconjunto de campos. Siempre se devuelven los permisos kind, ID, type y role. Para recuperar campos específicos, consulta Cómo devolver campos específicos.

Algunos métodos de recursos (como permissions.update) requieren un permissionId. Usa el método permissions.list para recuperar el ID de un archivo, una carpeta o una unidad compartida.

Representación JSON
{
  "permissionDetails": [
    {
      "permissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "id": string,
  "displayName": string,
  "type": string,
  "kind": string,
  "photoLink": string,
  "emailAddress": string,
  "role": string,
  "allowFileDiscovery": boolean,
  "domain": string,
  "expirationTime": string,
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean,
  "inheritedPermissionsDisabled": boolean
}
Campos
permissionDetails[]

object

Solo salida. Detalles sobre si los permisos de este elemento se heredan o se aplican directamente a él.

permissionDetails[].permissionType

string

Solo salida. Es el tipo de permiso para este usuario. Entre los valores admitidos, se incluyen los siguientes:

  • file
  • member
permissionDetails[].inheritedFrom

string

Solo salida. Es el ID del elemento del que se hereda este permiso. Este campo solo se propaga para los elementos de unidades compartidas.

permissionDetails[].role

string

Solo salida. Es el rol principal de este usuario. Entre los valores admitidos, se incluyen los siguientes:

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

Para obtener más información, consulta Roles y permisos.

permissionDetails[].inherited

boolean

Solo salida. Indica si este permiso se hereda. Este campo siempre se completa. Este campo es de solo salida.

teamDrivePermissionDetails[]
(deprecated)

object

Solo salida. Obsoleto: Solo salida. Usa permissionDetails en su lugar.

teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

Obsoleto: Solo salida. Usa permissionDetails/permissionType en su lugar.

teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

Obsoleto: Solo salida. Usa permissionDetails/inheritedFrom en su lugar.

teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

Obsoleto: Solo salida. Usa permissionDetails/role en su lugar.

teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

Obsoleto: Solo salida. Usa permissionDetails/inherited en su lugar.

id

string

Solo salida. Es el ID de este permiso. Es un identificador único para el beneficiario y se publica en el recurso User como permissionId. Los IDs deben tratarse como valores opacos.

displayName

string

Solo salida. Es el nombre "descriptivo" del valor del permiso. A continuación, se incluye una lista de ejemplos para cada tipo de permiso:

  • user: Nombre completo del usuario, tal como se define en su Cuenta de Google, por ejemplo, "Dana A.".
  • group: Nombre del grupo de Google, como "Los administradores de la empresa".
  • domain: Es el nombre de dominio de cadena, como "cymbalgroup.com".
  • anyone: No hay ningún displayName presente.
type

string

Es el tipo de beneficiario. Entre los valores admitidos, se incluyen los siguientes:

  • user
  • group
  • domain
  • anyone

Cuando creas un permiso, si type es user o group, debes proporcionar un emailAddress para el usuario o el grupo. Si type es domain, debes proporcionar un domain. Si type es anyone, no se requiere información adicional.

kind

string

Solo salida. Identifica qué tipo de recurso es este. El valor es la cadena fija "drive#permission".

emailAddress

string

Es la dirección de correo electrónico del usuario o grupo al que se refiere este permiso.

role

string

Es el rol que otorga este permiso. Entre los valores admitidos, se incluyen los siguientes:

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

Para obtener más información, consulta Roles y permisos.

allowFileDiscovery

boolean

Indica si el permiso permite que se descubra el archivo a través de la búsqueda. Esto solo se aplica a los permisos de tipo domain o anyone.

domain

string

Es el dominio al que hace referencia este permiso.

expirationTime

string

Fecha y hora en la que vencerá este permiso (fecha y hora según RFC 3339). Los tiempos de vencimiento tienen las siguientes restricciones:

  • Solo se pueden configurar en los permisos de usuarios y grupos.
  • La hora debe ser posterior a la actual.
  • La fecha no puede ser posterior a un año a partir de la fecha actual.
deleted

boolean

Solo salida. Indica si se borró la cuenta asociada a este permiso. Este campo solo se relaciona con los permisos de tipo user o group.

view

string

Indica la vista para este permiso. Solo se completa para los permisos que pertenecen a una vista.

Los únicos valores admitidos son published y metadata:

  • published: El rol del permiso es publishedReader.
  • metadata: El elemento solo es visible en la vista metadata porque tiene acceso limitado y el alcance tiene, al menos, acceso de lectura al elemento superior. La vista metadata solo se admite en carpetas.

Para obtener más información, consulta Vistas.

pendingOwner

boolean

Indica si la cuenta asociada a este permiso es un propietario pendiente. Solo se completa para los permisos de tipo user de los archivos que no están en una unidad compartida.

inheritedPermissionsDisabled

boolean

Cuando se establece en true, solo los organizadores, los propietarios y los usuarios con permisos agregados directamente en el elemento pueden acceder a él.

Métodos

create

Crea un permiso para un archivo o una unidad compartida.

delete

Borra un permiso.

get

Obtiene un permiso por ID.

list

Enumera los permisos de un archivo o una unidad compartida.

update

Actualiza un permiso con semántica de parche.