REST Resource: permissions

Recurso: Permission

Es un permiso para un archivo. Un permiso otorga a un usuario, grupo, dominio o acceso global a un archivo o una jerarquía de carpetas.

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
{
  "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
}
Campos
id

string

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

displayName

string

Solo salida. Lo "bonito" el nombre del valor del permiso. La siguiente es una lista de ejemplos para cada tipo de permiso:

  • user: Es el nombre completo del usuario, tal como se definió para su Cuenta de Google (por ejemplo, “Juan Pérez”).
  • group: Es el nombre del Grupo de Google, como "Los administradores de la empresa".
  • domain: Nombre de dominio de cadenas, como “laempresa.com”.
  • anyone: No hay ningún displayName presente.
type

string

Es el tipo de beneficiario. Estos son los valores válidos:

  • user
  • group
  • domain
  • anyone

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

kind

string

Solo salida. Identifica qué tipo de recurso es. Valor: la cadena fija "drive#permission"

permissionDetails[]

object

Solo salida. Detalles que indican si los permisos de este elemento de unidad compartida se heredan o directamente en este elemento. Este campo es de solo salida y está presente únicamente para los elementos de unidades compartidas.

permissionDetails[].permissionType

string

Solo salida. Es el tipo de permiso para este usuario. Si bien es posible que se agreguen valores nuevos en el futuro, por el momento, es posible hacer lo siguiente:

  • file
  • member
permissionDetails[].inheritedFrom

string

Solo salida. Es el ID del elemento del que se hereda este permiso. Este es un campo de solo salida.

permissionDetails[].role

string

Solo salida. Es el rol principal de este usuario. Si bien es posible que se agreguen valores nuevos en el futuro, por el momento, es posible hacer lo siguiente:

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

boolean

Solo salida. Si este permiso se hereda o no. Este campo siempre está propagado. Este es un campo de solo salida.

emailAddress

string

La dirección de correo electrónico del usuario o grupo al que hace referencia este permiso.

role

string

El rol que otorga este permiso. Si bien es posible que se admitan nuevos valores en el futuro, por el momento, se permite lo siguiente:

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

boolean

Indica si el permiso permite que el archivo sea descubierto con una 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

El momento en que caducará este permiso (fecha y hora RFC 3339). Las fechas de vencimiento tienen las siguientes restricciones:

  • Solo se pueden configurar en los permisos de usuario y grupo.
  • La hora debe ser futura.
  • El tiempo no puede ser superior a un año en el futuro.
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.

deleted

boolean

Solo salida. Si se borró la cuenta asociada con este permiso Este campo solo corresponde a los permisos de usuarios y grupos.

view

string

Indica la vista de este permiso. Solo se completa para los permisos que pertenecen a una vista. 'publicado' es el único valor admitido.

pendingOwner

boolean

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

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 parches.