Compartilhar via

Tipo de recurso permission

  • Artigo

O recurso Permission fornece informações sobre uma permissão de compartilhamento concedida a um recurso DriveItem.

As permissões de compartilhamento têm várias formas diferentes. O recurso Permission representa estes diferentes formulários por meio de facetas do recurso.

Representação JSON

Veja a seguir uma representação JSON do recurso

{
  "id": "string (identifier)",
  "grantedTo": {"@odata.type": "microsoft.graph.identitySet"},
  "grantedToIdentities": [{"@odata.type": "microsoft.graph.identitySet"}],
  "inheritedFrom": {"@odata.type": "microsoft.graph.itemReference"},
  "invitation": {"@odata.type": "microsoft.graph.sharingInvitation"},
  "link": {"@odata.type": "microsoft.graph.sharingLink"},
  "roles": ["string"],
  "shareId": "string"
}

Propriedades

Propriedade Tipo Descrição
id String O identificador exclusivo da permissão entre todas as permissões no item. Somente leitura.
grantedTo IdentitySet Para permissões de tipo de usuário, os detalhes de usuários e aplicativos para esta permissão. Somente leitura.
grantedToIdentities Coleção(IdentitySet) Para permissões de tipo de link, os detalhes dos usuários aos quais a permissão foi concedida. Somente leitura.
invitation SharingInvitation Detalhes de um convite de compartilhamento associado para esta permissão. Somente leitura.
inheritedFrom ItemReference Fornece uma referência para o ancestral da permissão atual, se ela for herdada de um ancestral. Somente leitura.
link SharingLink Fornece os detalhes do link de permissão atual, caso se trate de permissões de tipo de link. Somente leitura.
funções Collection(String) O tipo de permissão, por exemplo, read. Veja abaixo a lista completa de funções. Somente leitura.
shareId Cadeia de caracteres Um token exclusivo que pode ser usado para acessar esse item compartilhado por meio da API de compartilhamentos. Somente leitura.

Enumeração de funções

Função Detalhes
read Fornece a capacidade de ler os metadados e o conteúdo do item.
write Fornece a capacidade de ler e modificar os metadados e o conteúdo do item.
owner Para o SharePoint e o OneDrive for Business, isso representa a função de proprietário.
member Para o SharePoint e o OneDrive for Business, isso representa a função de membro.

O recurso permission usa facetas para fornecer informações sobre o tipo de permissão representado pelo recurso.

Os links de compartilhamento contêm um token exclusivo e necessário para acessar o item.

As permissões com uma faceta de convite representam permissões adicionadas convidando usuários ou grupos específicos a ter acesso ao arquivo.

Permissões com uma faceta link representam links de compartilhamento criados no item. Estes são os tipos mais comuns de permissões. Os links de compartilhamento fornecem uma URL exclusiva que pode ser usada para acessar um arquivo ou pasta. Eles podem ser configurados para conceder acesso de várias maneiras. Por exemplo, você pode usar a API createLink para criar um link que funcione para qualquer pessoa conectada à sua organização ou criar um link que funcione para qualquer pessoa, sem precisar fazer logon. Você pode usar a API invite para criar um link que funcione apenas para pessoas específicas, estejam elas na sua empresa ou não.

Aqui estão alguns exemplos de links de compartilhamento.

Este link de exibição fornece acesso somente leitura a qualquer pessoa com o link.

{
  "id": "1",
  "roles": ["read"],
  "link": {
    "scope": "anonymous",
    "type": "view",
    "webUrl": "https://onedrive.live.com/redir?resid=5D33DD65C6932946!70859&authkey=!AL7N1QAfSWcjNU8&ithint=folder%2cgif",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl"
}

Este link de edição fornece acesso de leitura e gravação a qualquer pessoa na organização com o link.

{
  "id": "2ceefb3g32hh",
  "roles": ["write"],
  "link": {
    "scope": "organization",
    "type": "edit",
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/fj277ghautbb422707565gnvg23",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl"
}

Este link fornece acesso de leitura e gravação para as pessoas específicas na coleção grantedToIdentities.

{
  "id": "3",
  "grantedToIdentities": [
    {
       "user": {
        "id": "35fij1974gb8832",
        "displayName": "Misty Suarez"
      }
    },
    {
       "user": {
        "id": "9397721fh4hgh73",
        "displayName": "Judith Clemons"
      }
    }
  ],
  "roles": ["write"],
  "link": {
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/a577ghg9hgh737613bmbjf839026561fmzhsr85ng9f3hjck2t5s",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl"
}

Convites de Compartilhamento

As permissões enviadas pela API de convite podem ter informações adicionais na faceta do convite . Se um convite foi enviado para um endereço de email que não corresponde a uma conta conhecida, a propriedade grantedTo pode não ser definida até que o convite seja resgatado, o que ocorre na primeira vez em que o usuário clica no link e faz login.

{
  "id": "1",
  "roles": ["write"],
  "invitation": {
    "email": "jd@fabrikam.com",
    "signInRequired": true
  },
  "shareId": "FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U"
}

Depois que o convite de compartilhamento tiver sido resgatado por um usuário, a propriedade grantedTo conterá as informações sobre a conta que resgatou as permissões:

{
  "id": "1",
  "roles": ["write"],
  "grantedTo": {
    "user": {
      "id": "5D33DD65C6932946",
      "displayName": "John Doe"
    }
  },
  "invitation": {
    "email": "jd@fabrikam.com",
    "signInRequired": true
  },
  "shareId": "FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U"
}

Métodos

Método Caminho REST
Listar permissões GET /drive/items/{item-id}/permissions
Obter permissão GET /drive/items/{item-id}/permissions/{id}
Criar link POST /drive/items/{item-id}/createLink
Convidar pessoas POST /drive/items/{item-id}/invite
Atualizar PATCH /drive/items/{item-id}/permissions/{id}
Delete DELETE /drive/items/{item-id}/permissions/{id}

Comentários

O OneDrive for Business e as bibliotecas de documentos do SharePoint não retornam a propriedade inheritedFrom.