REST Resource: permissions

Risorsa: Autorizzazione

Un'autorizzazione per un file. Un'autorizzazione concede a un utente, un gruppo, un dominio o al mondo l'accesso a un file o a una gerarchia di cartelle. Per saperne di più, vedi Condividere file, cartelle e Drive.

Per impostazione predefinita, le richieste di autorizzazione restituiscono solo un sottoinsieme di campi. I campi kind, ID, type e role dell'autorizzazione vengono sempre restituiti. Per recuperare campi specifici, vedi Restituire campi specifici.

Alcuni metodi delle risorse (ad esempio permissions.update) richiedono un permissionId. Utilizza il metodo permissions.list per recuperare l'ID di un file, una cartella o un Drive condiviso.

Rappresentazione 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,
  "inheritedPermissionsDisabled": boolean
}
Campi
id

string

Solo output. L'ID di questa autorizzazione. Si tratta di un identificatore univoco per il beneficiario, pubblicato nella risorsa Utente come permissionId. Gli ID devono essere trattati come valori opachi.

displayName

string

Solo output. Il nome "pretty" del valore dell'autorizzazione. Di seguito è riportato un elenco di esempi per ciascun tipo di autorizzazione:

  • user - nome completo dell'utente, come definito per il suo Account Google, ad esempio "Mario Rossi".
  • group: nome del gruppo Google, ad esempio "Amministratori dell'azienda".
  • domain - nome di dominio della stringa, ad esempio "cymbalgroup.com".
  • anyone: non è presente alcun displayName.
type

string

Il tipo di beneficiario. I valori supportati includono:

  • user
  • group
  • domain
  • anyone

Quando crei un'autorizzazione, se type è user o group, devi fornire un emailAddress per l'utente o il gruppo. Se type è domain, devi fornire un domain. Se type è anyone, non sono richieste informazioni aggiuntive.

kind

string

Solo output. Identifica il tipo di risorsa. Valore: la stringa fissa "drive#permission".

permissionDetails[]

object

Solo output. Dettagli che indicano se le autorizzazioni per questo elemento sono ereditate o sono direttamente sull'elemento.

permissionDetails[].permissionType

string

Solo output. Il tipo di autorizzazione per questo utente. I valori supportati includono:

  • file
  • member
permissionDetails[].inheritedFrom

string

Solo output. L'ID dell'elemento da cui viene ereditata questa autorizzazione. Questo campo viene compilato solo per gli elementi dei Drive condivisi.

permissionDetails[].role

string

Solo output. Il ruolo principale per questo utente. I valori supportati includono:

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

Per saperne di più, consulta Ruoli e autorizzazioni.

permissionDetails[].inherited

boolean

Solo output. Indica se questa autorizzazione è ereditata. Questo campo viene sempre compilato. Questo è un campo di solo output.

emailAddress

string

Solo output. L'indirizzo email dell'utente o del gruppo a cui fa riferimento questa autorizzazione.

role

string

Il ruolo concesso da questa autorizzazione. I valori supportati includono:

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

Per saperne di più, consulta Ruoli e autorizzazioni.

allowFileDiscovery

boolean

Indica se l'autorizzazione consente di scoprire il file tramite la ricerca. Questo si applica solo alle autorizzazioni di tipo domain o anyone.

domain

string

Solo output. Il dominio a cui fa riferimento questa autorizzazione.

expirationTime

string

L'ora in cui questa autorizzazione scadrà (data e ora RFC 3339). Le ore di scadenza hanno le seguenti limitazioni:

  • Possono essere impostate solo per le autorizzazioni di utenti e gruppi.
  • L'ora deve essere futura.
  • L'ora non può essere più di un anno nel futuro.
teamDrivePermissionDetails[]
(deprecated)

object

Solo output. Obsoleto: solo output. Utilizza invece permissionDetails.

teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

Obsoleto: solo output. Utilizza invece permissionDetails/permissionType.

teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

Obsoleto: solo output. Utilizza invece permissionDetails/inheritedFrom.

teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

Obsoleto: solo output. Utilizza invece permissionDetails/role.

teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

Obsoleto: solo output. Utilizza invece permissionDetails/inherited.

deleted

boolean

Solo output. Indica se l'account associato a questa autorizzazione è stato eliminato. Questo campo si riferisce solo alle autorizzazioni di tipo user o group.

view

string

Indica la visualizzazione per questa autorizzazione. Viene compilato solo per le autorizzazioni che appartengono a una visualizzazione.

Gli unici valori supportati sono published e metadata:

  • published: il ruolo dell'autorizzazione è publishedReader.
  • metadata: l'elemento è visibile solo nella visualizzazione metadata perché ha accesso limitato e l'ambito ha almeno l'accesso in lettura al parent. La visualizzazione metadata è supportata solo nelle cartelle.

Per saperne di più, vedi Visualizzazioni.

pendingOwner

boolean

Indica se l'account associato a questa autorizzazione è un proprietario in sospeso. Viene compilato solo per le autorizzazioni di tipo user per i file che non si trovano in un Drive condiviso.

inheritedPermissionsDisabled

boolean

Se true, solo gli organizzatori, i proprietari e gli utenti con autorizzazioni aggiunte direttamente all'elemento possono accedervi.

Metodi

create

Crea un'autorizzazione per un file o un Drive condiviso.

delete

Elimina un'autorizzazione.

get

Recupera un'autorizzazione per ID.

list

Elenca le autorizzazioni di un file o di un Drive condiviso.

update

Aggiorna un'autorizzazione con la semantica della patch.